Debian Codegraph @

docs/dyn/compute_v1.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_v1.html">Compute Engine API</a> . <a href="compute_v1.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, 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, 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="#getScreenshot">getScreenshot(project, zone, instance, x__xgafv=None)</a></code></p>
127 <p class="firstline">Returns the screenshot from the specified instance.</p>
128 <p class="toc_element">
129 <code><a href="#getSerialPortOutput">getSerialPortOutput(project, zone, instance, port=None, start=None, x__xgafv=None)</a></code></p>
130 <p class="firstline">Returns the last 1 MB of serial port output from the specified instance.</p>
131 <p class="toc_element">
132 <code><a href="#getShieldedInstanceIdentity">getShieldedInstanceIdentity(project, zone, instance, x__xgafv=None)</a></code></p>
133 <p class="firstline">Returns the Shielded Instance Identity of an instance</p>
134 <p class="toc_element">
135 <code><a href="#insert">insert(project, zone, body=None, requestId=None, sourceInstanceTemplate=None, sourceMachineImage=None, x__xgafv=None)</a></code></p>
136 <p class="firstline">Creates an instance resource in the specified project using the data</p>
137 <p class="toc_element">
138 <code><a href="#list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
139 <p class="firstline">Retrieves the list of instances contained within</p>
140 <p class="toc_element">
141 <code><a href="#listReferrers">listReferrers(project, zone, instance, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
142 <p class="firstline">Retrieves a list of resources that refer to the VM instance specified in</p>
143 <p class="toc_element">
144 <code><a href="#listReferrers_next">listReferrers_next()</a></code></p>
145 <p class="firstline">Retrieves the next page of results.</p>
146 <p class="toc_element">
147 <code><a href="#list_next">list_next()</a></code></p>
148 <p class="firstline">Retrieves the next page of results.</p>
149 <p class="toc_element">
150 <code><a href="#performMaintenance">performMaintenance(project, zone, instance, requestId=None, x__xgafv=None)</a></code></p>
151 <p class="firstline">Perform a manual maintenance on the instance.</p>
152 <p class="toc_element">
153 <code><a href="#removeResourcePolicies">removeResourcePolicies(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
154 <p class="firstline">Removes resource policies from an instance.</p>
155 <p class="toc_element">
156 <code><a href="#reportHostAsFaulty">reportHostAsFaulty(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
157 <p class="firstline">Mark the host as faulty and try to restart the instance on a new host.</p>
158 <p class="toc_element">
159 <code><a href="#reset">reset(project, zone, instance, requestId=None, x__xgafv=None)</a></code></p>
160 <p class="firstline">Performs a reset on the instance. This is a hard reset. The VM</p>
161 <p class="toc_element">
162 <code><a href="#resume">resume(project, zone, instance, requestId=None, x__xgafv=None)</a></code></p>
163 <p class="firstline">Resumes an instance that was suspended using theinstances().suspend</p>
164 <p class="toc_element">
165 <code><a href="#sendDiagnosticInterrupt">sendDiagnosticInterrupt(project, zone, instance, x__xgafv=None)</a></code></p>
166 <p class="firstline">Sends diagnostic interrupt to the instance.</p>
167 <p class="toc_element">
168 <code><a href="#setDeletionProtection">setDeletionProtection(project, zone, resource, deletionProtection=None, requestId=None, x__xgafv=None)</a></code></p>
169 <p class="firstline">Sets deletion protection on the instance.</p>
170 <p class="toc_element">
171 <code><a href="#setDiskAutoDelete">setDiskAutoDelete(project, zone, instance, autoDelete, deviceName, requestId=None, x__xgafv=None)</a></code></p>
172 <p class="firstline">Sets the auto-delete flag for a disk attached to an instance.</p>
173 <p class="toc_element">
174 <code><a href="#setIamPolicy">setIamPolicy(project, zone, resource, body=None, x__xgafv=None)</a></code></p>
175 <p class="firstline">Sets the access control policy on the specified resource.</p>
176 <p class="toc_element">
177 <code><a href="#setLabels">setLabels(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
178 <p class="firstline">Sets labels on an instance. To learn more about labels, read theLabeling</p>
179 <p class="toc_element">
180 <code><a href="#setMachineResources">setMachineResources(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
181 <p class="firstline">Changes the number and/or type of accelerator for a stopped instance to the</p>
182 <p class="toc_element">
183 <code><a href="#setMachineType">setMachineType(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
184 <p class="firstline">Changes the machine type for a stopped instance to the machine</p>
185 <p class="toc_element">
186 <code><a href="#setMetadata">setMetadata(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
187 <p class="firstline">Sets metadata for the specified instance to the data included</p>
188 <p class="toc_element">
189 <code><a href="#setMinCpuPlatform">setMinCpuPlatform(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
190 <p class="firstline">Changes the minimum CPU platform that this instance should use.</p>
191 <p class="toc_element">
192 <code><a href="#setName">setName(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
193 <p class="firstline">Sets name of an instance.</p>
194 <p class="toc_element">
195 <code><a href="#setScheduling">setScheduling(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
196 <p class="firstline">Sets an instance's scheduling options. You can only call this method on astopped instance,</p>
197 <p class="toc_element">
198 <code><a href="#setSecurityPolicy">setSecurityPolicy(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
199 <p class="firstline">Sets the Google Cloud Armor security policy for the specified instance.</p>
200 <p class="toc_element">
201 <code><a href="#setServiceAccount">setServiceAccount(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
202 <p class="firstline">Sets the service account on the instance. For more information,</p>
203 <p class="toc_element">
204 <code><a href="#setShieldedInstanceIntegrityPolicy">setShieldedInstanceIntegrityPolicy(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
205 <p class="firstline">Sets the Shielded Instance integrity policy for an instance. You can</p>
206 <p class="toc_element">
207 <code><a href="#setTags">setTags(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
208 <p class="firstline">Sets network tags</p>
209 <p class="toc_element">
210 <code><a href="#simulateMaintenanceEvent">simulateMaintenanceEvent(project, zone, instance, requestId=None, withExtendedNotifications=None, x__xgafv=None)</a></code></p>
211 <p class="firstline">Simulates a host maintenance event on a VM. For more information, see</p>
212 <p class="toc_element">
213 <code><a href="#start">start(project, zone, instance, requestId=None, x__xgafv=None)</a></code></p>
214 <p class="firstline">Starts an instance that was stopped using theinstances().stop</p>
215 <p class="toc_element">
216 <code><a href="#startWithEncryptionKey">startWithEncryptionKey(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
217 <p class="firstline">Starts an instance that was stopped using theinstances().stop</p>
218 <p class="toc_element">
219 <code><a href="#stop">stop(project, zone, instance, discardLocalSsd=None, requestId=None, x__xgafv=None)</a></code></p>
220 <p class="firstline">Stops a running instance, shutting it down cleanly, and allows</p>
221 <p class="toc_element">
222 <code><a href="#suspend">suspend(project, zone, instance, discardLocalSsd=None, requestId=None, x__xgafv=None)</a></code></p>
223 <p class="firstline">This method suspends a running instance, saving its state to persistent</p>
224 <p class="toc_element">
225 <code><a href="#testIamPermissions">testIamPermissions(project, zone, resource, body=None, x__xgafv=None)</a></code></p>
226 <p class="firstline">Returns permissions that a caller has on the specified resource.</p>
227 <p class="toc_element">
228 <code><a href="#update">update(project, zone, instance, body=None, discardLocalSsd=None, minimalAction=None, mostDisruptiveAllowedAction=None, requestId=None, x__xgafv=None)</a></code></p>
229 <p class="firstline">Updates an instance only if the necessary resources are available. This</p>
230 <p class="toc_element">
231 <code><a href="#updateAccessConfig">updateAccessConfig(project, zone, instance, networkInterface, body=None, requestId=None, x__xgafv=None)</a></code></p>
232 <p class="firstline">Updates the specified access config from an instance's network interface</p>
233 <p class="toc_element">
234 <code><a href="#updateDisplayDevice">updateDisplayDevice(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
235 <p class="firstline">Updates the Display config for a VM instance. You can</p>
236 <p class="toc_element">
237 <code><a href="#updateNetworkInterface">updateNetworkInterface(project, zone, instance, networkInterface, body=None, requestId=None, x__xgafv=None)</a></code></p>
238 <p class="firstline">Updates an instance's network interface. This method can only update an</p>
239 <p class="toc_element">
240 <code><a href="#updateShieldedInstanceConfig">updateShieldedInstanceConfig(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p>
241 <p class="firstline">Updates the Shielded Instance config for an instance. You can</p>
242 <h3>Method Details</h3>
243 <div class="method">
244 <code class="details" id="addAccessConfig">addAccessConfig(project, zone, instance, networkInterface, body=None, requestId=None, x__xgafv=None)</code>
245 <pre>Adds an access config to an instance&#x27;s network interface.
246
247 Args:
248 project: string, Project ID for this request. (required)
249 zone: string, The name of the zone for this request. (required)
250 instance: string, The instance name for this request. (required)
251 networkInterface: string, The name of the network interface to add to this instance. (required)
252 body: object, The request body.
253 The object takes the form of:
254
255 { # An access configuration attached to an instance&#x27;s network interface.
256 # Only one access config per instance is supported.
257 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
258 # The first IPv6 address of the external IPv6 range associated
259 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
260 # use a static external IP address, it must be unused and in the same region
261 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
262 # assign an external IPv6 address from the instance&#x27;s subnetwork.
263 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
264 # external IPv6 range.
265 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
266 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
267 # (IPv4), the default and recommended name is External NAT, but
268 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
269 # recommend name is External IPv6.
270 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
271 # address associated with this instance. Specify an unused static
272 # external IP address available to the project or leave this field undefined
273 # to use an IP from a shared ephemeral IP address pool. If you specify a
274 # static external IP address, it must live in the same region as the zone of
275 # the instance.
276 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
277 # configuration and can only take the following values: PREMIUM,STANDARD.
278 #
279 # If an AccessConfig is specified without a valid external IP address, an
280 # ephemeral IP will be created with this networkTier.
281 #
282 # If an AccessConfig with a valid external IP address is specified, it must
283 # match that of the networkTier associated with the Address resource owning
284 # that IP.
285 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
286 #
287 # 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
288 # first IP in associated external IPv6 range.
289 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
290 # config.
291 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
292 # external IP address of the instance to a DNS domain name.
293 #
294 # This field is not used in ipv6AccessConfig. A default PTR
295 # record will be created if the VM has external IPv6 range associated.
296 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
297 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
298 }
299
300 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
301 that if you must retry your request, the server will know to ignore the
302 request if it has already been completed.
303
304 For example, consider a situation where you make an initial request and
305 the request times out. If you make the request again with the same
306 request ID, the server can check if original operation with the same
307 request ID was received, and if so, will ignore the second request. This
308 prevents clients from accidentally creating duplicate commitments.
309
310 The request ID must be
311 a valid UUID with the exception that zero UUID is not supported
312 (00000000-0000-0000-0000-000000000000).
313 x__xgafv: string, V1 error format.
314 Allowed values
315 1 - v1 error format
316 2 - v2 error format
317
318 Returns:
319 An object of the form:
320
321 { # Represents an Operation resource.
322 #
323 # Google Compute Engine has three Operation resources:
324 #
325 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
326 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
327 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
328 #
329 # You can use an operation resource to manage asynchronous API requests.
330 # For more information, readHandling
331 # API responses.
332 #
333 # Operations can be global, regional or zonal.
334 #
335 # - For global operations, use the `globalOperations`
336 # resource.
337 # - For regional operations, use the
338 # `regionOperations` resource.
339 # - For zonal operations, use
340 # the `zoneOperations` resource.
341 #
342 #
343 #
344 # For more information, read
345 # Global, Regional, and Zonal Resources.
346 #
347 # Note that completed Operation resources have a limited
348 # retention period.
349 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
350 # Not present otherwise.
351 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
352 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
353 # set when the operation is created.
354 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
355 # text format.
356 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
357 # this field will be populated.
358 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
359 # operation.
360 {
361 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
362 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
363 # details. There is a set of defined message types to use for providing
364 # details.The syntax depends on the error code. For example,
365 # QuotaExceededInfo will have details when the error code is
366 # QUOTA_EXCEEDED.
367 {
368 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
369 #
370 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
371 # is not enabled:
372 #
373 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
374 # &quot;domain&quot;: &quot;googleapis.com&quot;
375 # &quot;metadata&quot;: {
376 # &quot;resource&quot;: &quot;projects/123&quot;,
377 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
378 # }
379 # }
380 #
381 # This response indicates that the pubsub.googleapis.com API is not enabled.
382 #
383 # Example of an error that is returned when attempting to create a Spanner
384 # instance in a region that is out of stock:
385 #
386 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
387 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
388 # &quot;metadata&quot;: {
389 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
390 # }
391 # }
392 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
393 # is typically the registered service name of the tool or product that
394 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
395 # generated by some common infrastructure, the error domain must be a
396 # globally unique value that identifies the infrastructure. For Google API
397 # infrastructure, the error domain is &quot;googleapis.com&quot;.
398 &quot;metadatas&quot;: { # Additional structured details about this error.
399 #
400 # Keys must match a regular expression of `a-z+` but should
401 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
402 # length. When identifying the current value of an exceeded limit, the units
403 # should be contained in the key, not the value. For example, rather than
404 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
405 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
406 # instances that can be created in a single (batch) request.
407 &quot;a_key&quot;: &quot;A String&quot;,
408 },
409 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
410 # proximate cause of the error. Error reasons are unique within a particular
411 # domain of errors. This should be at most 63 characters and match a
412 # regular expression of `A-Z+[A-Z0-9]`, which represents
413 # UPPER_SNAKE_CASE.
414 },
415 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
416 #
417 # For example, if a quota check failed with an error indicating the calling
418 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
419 # directly to the right place in the developer console to flip the bit.
420 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
421 { # Describes a URL link.
422 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
423 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
424 },
425 ],
426 },
427 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
428 # which can be attached to an RPC error.
429 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
430 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
431 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
432 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
433 },
434 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
435 &quot;dimensions&quot;: { # The map holding related quota dimensions.
436 &quot;a_key&quot;: &quot;A String&quot;,
437 },
438 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
439 # type or metric.
440 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
441 # or metric.
442 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
443 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
444 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
445 },
446 },
447 ],
448 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
449 # This property is optional.
450 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
451 },
452 ],
453 },
454 &quot;getVersionOperationMetadata&quot;: {
455 &quot;inlineSbomInfo&quot;: {
456 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
457 # appropriate identifiers.
458 &quot;a_key&quot;: &quot;A String&quot;,
459 },
460 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
461 # identifiers.
462 &quot;a_key&quot;: &quot;A String&quot;,
463 },
464 },
465 },
466 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
467 # message that was returned, such as `NOT FOUND`.
468 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
469 # status code that was returned. For example, a `404` means the
470 # resource was not found.
471 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
472 # defined by the server.
473 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
474 # This value is inRFC3339
475 # text format.
476 &quot;instancesBulkInsertOperationMetadata&quot;: {
477 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
478 # Example key: zones/us-central1-a
479 &quot;a_key&quot;: {
480 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
481 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
482 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
483 # error.
484 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
485 # if the flow is rolling forward or rolling back.
486 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
487 },
488 },
489 },
490 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
491 # Operation resources.
492 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
493 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
494 # group of operations results from a `bulkInsert` API request.
495 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
496 # `update`, or `delete`, and so on.
497 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
498 # There is no requirement that this be linear or support any granularity of
499 # operations. This should not be used to guess when the operation will be
500 # complete. This number should monotonically increase as the operation
501 # progresses.
502 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
503 # applicable when performing regional operations.
504 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
505 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
506 # this field will contain information on all underlying zonal actions and
507 # their state.
508 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
509 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
510 # Example key: zones/us-central1-a
511 &quot;a_key&quot;: {
512 &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
513 # populated.
514 # different programming environments, including REST APIs and RPC APIs. It is
515 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
516 # three pieces of data: error code, error message, and error details.
517 #
518 # You can find out more about this error model and how to work with it in the
519 # [API Design Guide](https://cloud.google.com/apis/design/errors).
520 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
521 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
522 # message types for APIs to use.
523 {
524 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
525 },
526 ],
527 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
528 # user-facing error message should be localized and sent in the
529 # google.rpc.Status.details field, or localized by the client.
530 },
531 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
532 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
533 },
534 },
535 },
536 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
537 # This value is inRFC3339
538 # text format.
539 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
540 # following:
541 # `PENDING`, `RUNNING`, or `DONE`.
542 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
543 # operation.
544 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
545 # of the target resource.
546 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
547 # operations related to creating a snapshot, this points to the disk
548 # that the snapshot was created from.
549 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
550 # `[email protected]` or
551 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
552 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
553 # operation, this field will be populated.
554 {
555 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
556 # Engine returns NO_RESULTS_ON_PAGE if there
557 # are no results in the response.
558 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
559 # value format. For example:
560 #
561 # &quot;data&quot;: [
562 # {
563 # &quot;key&quot;: &quot;scope&quot;,
564 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
565 # }
566 {
567 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
568 # returned. For example, for warnings where there are no results in a list
569 # request for a particular zone, this key might be scope and
570 # the key value might be the zone name. Other examples might be a key
571 # indicating a deprecated resource and a suggested replacement, or a
572 # warning about invalid network settings (for example, if an instance
573 # attempts to perform IP forwarding but is not enabled for IP forwarding).
574 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
575 },
576 ],
577 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
578 },
579 ],
580 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
581 # applicable when performing per-zone operations.
582 }</pre>
583 </div>
584
585 <div class="method">
586 <code class="details" id="addNetworkInterface">addNetworkInterface(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
587 <pre>Adds one dynamic network interface to an active instance.
588
589 Args:
590 project: string, Project ID for this request. (required)
591 zone: string, The name of the zone for this request. (required)
592 instance: string, The instance name for this request stored as resource_id.
593 Name should conform to RFC1035 or be an unsigned long integer. (required)
594 body: object, The request body.
595 The object takes the form of:
596
597 { # A network interface resource attached to an instance.
598 &quot;accessConfigs&quot;: [ # An array of configurations for this interface. Currently, only one access
599 # config, ONE_TO_ONE_NAT, is supported. If there are noaccessConfigs specified, then this instance will have
600 # no external internet access.
601 { # An access configuration attached to an instance&#x27;s network interface.
602 # Only one access config per instance is supported.
603 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
604 # The first IPv6 address of the external IPv6 range associated
605 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
606 # use a static external IP address, it must be unused and in the same region
607 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
608 # assign an external IPv6 address from the instance&#x27;s subnetwork.
609 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
610 # external IPv6 range.
611 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
612 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
613 # (IPv4), the default and recommended name is External NAT, but
614 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
615 # recommend name is External IPv6.
616 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
617 # address associated with this instance. Specify an unused static
618 # external IP address available to the project or leave this field undefined
619 # to use an IP from a shared ephemeral IP address pool. If you specify a
620 # static external IP address, it must live in the same region as the zone of
621 # the instance.
622 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
623 # configuration and can only take the following values: PREMIUM,STANDARD.
624 #
625 # If an AccessConfig is specified without a valid external IP address, an
626 # ephemeral IP will be created with this networkTier.
627 #
628 # If an AccessConfig with a valid external IP address is specified, it must
629 # match that of the networkTier associated with the Address resource owning
630 # that IP.
631 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
632 #
633 # 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
634 # first IP in associated external IPv6 range.
635 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
636 # config.
637 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
638 # external IP address of the instance to a DNS domain name.
639 #
640 # This field is not used in ipv6AccessConfig. A default PTR
641 # record will be created if the VM has external IPv6 range associated.
642 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
643 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
644 },
645 ],
646 &quot;aliasIpRanges&quot;: [ # An array of alias IP ranges for this network interface.
647 # You can only specify this field for network interfaces in VPC networks.
648 { # An alias IP range attached to an instance&#x27;s network interface.
649 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
650 # must belong to the specified subnetwork and cannot contain IP addresses
651 # reserved by system or used by other network interfaces. This range may be
652 # 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).
653 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
654 # alias range. If not specified, the primary range of the subnetwork is used.
655 },
656 ],
657 &quot;aliasIpv6Ranges&quot;: [ # An array of alias IPv6 ranges for this network interface.
658 # You can only specify this field for network interfaces in VPC networks.
659 { # An alias IP range attached to an instance&#x27;s network interface.
660 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
661 # must belong to the specified subnetwork and cannot contain IP addresses
662 # reserved by system or used by other network interfaces. This range may be
663 # 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).
664 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
665 # alias range. If not specified, the primary range of the subnetwork is used.
666 },
667 ],
668 &quot;enableVpcScopedDns&quot;: True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
669 # with network_attachment.
670 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint hash of contents stored in this network interface.
671 # This field will be ignored when inserting an Instance or
672 # adding a NetworkInterface. An up-to-date
673 # 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.
674 &quot;igmpQuery&quot;: &quot;A String&quot;, # Indicate whether igmp query is enabled on the network interface
675 # or not. If enabled, also indicates the version of IGMP supported.
676 &quot;internalIpv6PrefixLength&quot;: 42, # The prefix length of the primary internal IPv6 range.
677 &quot;ipv6AccessConfigs&quot;: [ # An array of IPv6 access configurations for this interface. Currently, only
678 # one IPv6 access config, DIRECT_IPV6, is supported. If there
679 # is no ipv6AccessConfig specified, then this instance will
680 # have no external IPv6 Internet access.
681 { # An access configuration attached to an instance&#x27;s network interface.
682 # Only one access config per instance is supported.
683 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
684 # The first IPv6 address of the external IPv6 range associated
685 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
686 # use a static external IP address, it must be unused and in the same region
687 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
688 # assign an external IPv6 address from the instance&#x27;s subnetwork.
689 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
690 # external IPv6 range.
691 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
692 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
693 # (IPv4), the default and recommended name is External NAT, but
694 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
695 # recommend name is External IPv6.
696 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
697 # address associated with this instance. Specify an unused static
698 # external IP address available to the project or leave this field undefined
699 # to use an IP from a shared ephemeral IP address pool. If you specify a
700 # static external IP address, it must live in the same region as the zone of
701 # the instance.
702 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
703 # configuration and can only take the following values: PREMIUM,STANDARD.
704 #
705 # If an AccessConfig is specified without a valid external IP address, an
706 # ephemeral IP will be created with this networkTier.
707 #
708 # If an AccessConfig with a valid external IP address is specified, it must
709 # match that of the networkTier associated with the Address resource owning
710 # that IP.
711 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
712 #
713 # 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
714 # first IP in associated external IPv6 range.
715 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
716 # config.
717 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
718 # external IP address of the instance to a DNS domain name.
719 #
720 # This field is not used in ipv6AccessConfig. A default PTR
721 # record will be created if the VM has external IPv6 range associated.
722 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
723 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
724 },
725 ],
726 &quot;ipv6AccessType&quot;: &quot;A String&quot;, # Output only. [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be
727 # accessed from the Internet. This field is always inherited from its
728 # subnetwork.
729 #
730 # Valid only if stackType is IPV4_IPV6.
731 &quot;ipv6Address&quot;: &quot;A String&quot;, # An IPv6 internal network address for this network interface. To
732 # use a static internal IP address, it must be unused and in the same region
733 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
734 # assign an internal IPv6 address from the instance&#x27;s subnetwork.
735 &quot;kind&quot;: &quot;compute#networkInterface&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#networkInterface for network interfaces.
736 &quot;name&quot;: &quot;A String&quot;, # [Output Only] The name of the network interface, which is generated by the
737 # server. For a VM, the network interface uses the nicN naming
738 # format. Where N is a value between 0 and7. The default interface value is nic0.
739 &quot;network&quot;: &quot;A String&quot;, # URL of the VPC network resource for this instance. When creating an
740 # instance, if neither the network nor the subnetwork is specified, the
741 # default network global/networks/default is used. If the
742 # selected project doesn&#x27;t have the default network, you must specify a
743 # network or subnet. If the network is not specified but the subnetwork is
744 # specified, the network is inferred.
745 #
746 # If you specify this property, you can specify the network as
747 # a full or partial URL. For example, the following are all valid URLs:
748 #
749 #
750 # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
751 # - projects/project/global/networks/network
752 # - global/networks/default
753 &quot;networkAttachment&quot;: &quot;A String&quot;, # The URL of the network attachment that this interface should connect
754 # to in the following format:
755 # projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.
756 &quot;networkIP&quot;: &quot;A String&quot;, # An IPv4 internal IP address to assign to the instance for this network
757 # interface. If not specified by the user, an unused internal IP is
758 # assigned by the system.
759 &quot;nicType&quot;: &quot;A String&quot;, # The type of vNIC to be used on this interface. This may be gVNIC or
760 # VirtioNet.
761 &quot;parentNicName&quot;: &quot;A String&quot;, # Name of the parent network interface of a dynamic network interface.
762 &quot;queueCount&quot;: 42, # The networking queue count that&#x27;s specified by users for the network
763 # interface. Both Rx and Tx queues will be set to this number. It&#x27;ll be empty
764 # if not specified by the users.
765 &quot;serviceClassId&quot;: &quot;A String&quot;, # Optional. Producer Service&#x27;s Service class Id for the region of this network
766 # interface. Can only be used with network_attachment. It is not possible to
767 # use on its own however, network_attachment can be used without
768 # service_class_id.
769 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for this network interface. To assign only IPv4 addresses,
770 # use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, useIPV4_IPV6. If not specified, IPV4_ONLY is used.
771 #
772 # This field can be both set at instance creation and update network
773 # interface operations.
774 &quot;subnetwork&quot;: &quot;A String&quot;, # The URL of the Subnetwork resource for this instance. If the network
775 # resource is inlegacy
776 # mode, do not specify this field. If the network is in auto subnet
777 # mode, specifying the subnetwork is optional. If the network is in custom
778 # subnet mode, specifying the subnetwork is required. If you specify this
779 # field, you can specify the subnetwork as a full or partial URL. For
780 # example, the following are all valid URLs:
781 #
782 #
783 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
784 # - regions/region/subnetworks/subnetwork
785 &quot;vlan&quot;: 42, # VLAN tag of a dynamic network interface, must be an integer in the range
786 # from 2 to 255 inclusively.
787 }
788
789 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
790 that if you must retry your request, the server will know to ignore the
791 request if it has already been completed.
792
793 For example, consider a situation where you make an initial request and
794 the request times out. If you make the request again with the same
795 request ID, the server can check if original operation with the same
796 request ID was received, and if so, will ignore the second request. This
797 prevents clients from accidentally creating duplicate commitments.
798
799 The request ID must be
800 a valid UUID with the exception that zero UUID is not supported
801 (00000000-0000-0000-0000-000000000000).
802 x__xgafv: string, V1 error format.
803 Allowed values
804 1 - v1 error format
805 2 - v2 error format
806
807 Returns:
808 An object of the form:
809
810 { # Represents an Operation resource.
811 #
812 # Google Compute Engine has three Operation resources:
813 #
814 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
815 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
816 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
817 #
818 # You can use an operation resource to manage asynchronous API requests.
819 # For more information, readHandling
820 # API responses.
821 #
822 # Operations can be global, regional or zonal.
823 #
824 # - For global operations, use the `globalOperations`
825 # resource.
826 # - For regional operations, use the
827 # `regionOperations` resource.
828 # - For zonal operations, use
829 # the `zoneOperations` resource.
830 #
831 #
832 #
833 # For more information, read
834 # Global, Regional, and Zonal Resources.
835 #
836 # Note that completed Operation resources have a limited
837 # retention period.
838 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
839 # Not present otherwise.
840 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
841 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
842 # set when the operation is created.
843 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
844 # text format.
845 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
846 # this field will be populated.
847 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
848 # operation.
849 {
850 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
851 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
852 # details. There is a set of defined message types to use for providing
853 # details.The syntax depends on the error code. For example,
854 # QuotaExceededInfo will have details when the error code is
855 # QUOTA_EXCEEDED.
856 {
857 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
858 #
859 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
860 # is not enabled:
861 #
862 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
863 # &quot;domain&quot;: &quot;googleapis.com&quot;
864 # &quot;metadata&quot;: {
865 # &quot;resource&quot;: &quot;projects/123&quot;,
866 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
867 # }
868 # }
869 #
870 # This response indicates that the pubsub.googleapis.com API is not enabled.
871 #
872 # Example of an error that is returned when attempting to create a Spanner
873 # instance in a region that is out of stock:
874 #
875 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
876 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
877 # &quot;metadata&quot;: {
878 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
879 # }
880 # }
881 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
882 # is typically the registered service name of the tool or product that
883 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
884 # generated by some common infrastructure, the error domain must be a
885 # globally unique value that identifies the infrastructure. For Google API
886 # infrastructure, the error domain is &quot;googleapis.com&quot;.
887 &quot;metadatas&quot;: { # Additional structured details about this error.
888 #
889 # Keys must match a regular expression of `a-z+` but should
890 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
891 # length. When identifying the current value of an exceeded limit, the units
892 # should be contained in the key, not the value. For example, rather than
893 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
894 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
895 # instances that can be created in a single (batch) request.
896 &quot;a_key&quot;: &quot;A String&quot;,
897 },
898 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
899 # proximate cause of the error. Error reasons are unique within a particular
900 # domain of errors. This should be at most 63 characters and match a
901 # regular expression of `A-Z+[A-Z0-9]`, which represents
902 # UPPER_SNAKE_CASE.
903 },
904 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
905 #
906 # For example, if a quota check failed with an error indicating the calling
907 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
908 # directly to the right place in the developer console to flip the bit.
909 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
910 { # Describes a URL link.
911 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
912 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
913 },
914 ],
915 },
916 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
917 # which can be attached to an RPC error.
918 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
919 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
920 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
921 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
922 },
923 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
924 &quot;dimensions&quot;: { # The map holding related quota dimensions.
925 &quot;a_key&quot;: &quot;A String&quot;,
926 },
927 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
928 # type or metric.
929 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
930 # or metric.
931 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
932 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
933 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
934 },
935 },
936 ],
937 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
938 # This property is optional.
939 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
940 },
941 ],
942 },
943 &quot;getVersionOperationMetadata&quot;: {
944 &quot;inlineSbomInfo&quot;: {
945 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
946 # appropriate identifiers.
947 &quot;a_key&quot;: &quot;A String&quot;,
948 },
949 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
950 # identifiers.
951 &quot;a_key&quot;: &quot;A String&quot;,
952 },
953 },
954 },
955 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
956 # message that was returned, such as `NOT FOUND`.
957 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
958 # status code that was returned. For example, a `404` means the
959 # resource was not found.
960 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
961 # defined by the server.
962 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
963 # This value is inRFC3339
964 # text format.
965 &quot;instancesBulkInsertOperationMetadata&quot;: {
966 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
967 # Example key: zones/us-central1-a
968 &quot;a_key&quot;: {
969 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
970 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
971 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
972 # error.
973 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
974 # if the flow is rolling forward or rolling back.
975 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
976 },
977 },
978 },
979 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
980 # Operation resources.
981 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
982 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
983 # group of operations results from a `bulkInsert` API request.
984 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
985 # `update`, or `delete`, and so on.
986 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
987 # There is no requirement that this be linear or support any granularity of
988 # operations. This should not be used to guess when the operation will be
989 # complete. This number should monotonically increase as the operation
990 # progresses.
991 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
992 # applicable when performing regional operations.
993 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
994 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
995 # this field will contain information on all underlying zonal actions and
996 # their state.
997 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
998 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
999 # Example key: zones/us-central1-a
1000 &quot;a_key&quot;: {
1001 &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
1002 # populated.
1003 # different programming environments, including REST APIs and RPC APIs. It is
1004 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1005 # three pieces of data: error code, error message, and error details.
1006 #
1007 # You can find out more about this error model and how to work with it in the
1008 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1009 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1010 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1011 # message types for APIs to use.
1012 {
1013 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1014 },
1015 ],
1016 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1017 # user-facing error message should be localized and sent in the
1018 # google.rpc.Status.details field, or localized by the client.
1019 },
1020 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1021 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1022 },
1023 },
1024 },
1025 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1026 # This value is inRFC3339
1027 # text format.
1028 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1029 # following:
1030 # `PENDING`, `RUNNING`, or `DONE`.
1031 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1032 # operation.
1033 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1034 # of the target resource.
1035 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1036 # operations related to creating a snapshot, this points to the disk
1037 # that the snapshot was created from.
1038 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1039 # `[email protected]` or
1040 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1041 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1042 # operation, this field will be populated.
1043 {
1044 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1045 # Engine returns NO_RESULTS_ON_PAGE if there
1046 # are no results in the response.
1047 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1048 # value format. For example:
1049 #
1050 # &quot;data&quot;: [
1051 # {
1052 # &quot;key&quot;: &quot;scope&quot;,
1053 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1054 # }
1055 {
1056 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1057 # returned. For example, for warnings where there are no results in a list
1058 # request for a particular zone, this key might be scope and
1059 # the key value might be the zone name. Other examples might be a key
1060 # indicating a deprecated resource and a suggested replacement, or a
1061 # warning about invalid network settings (for example, if an instance
1062 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1063 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1064 },
1065 ],
1066 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1067 },
1068 ],
1069 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1070 # applicable when performing per-zone operations.
1071 }</pre>
1072 </div>
1073
1074 <div class="method">
1075 <code class="details" id="addResourcePolicies">addResourcePolicies(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
1076 <pre>Adds existing resource policies to an instance. You can only add one
1077 policy right now which will be applied to this instance for scheduling live
1078 migrations.
1079
1080 Args:
1081 project: string, Project ID for this request. (required)
1082 zone: string, The name of the zone for this request. (required)
1083 instance: string, The instance name for this request. (required)
1084 body: object, The request body.
1085 The object takes the form of:
1086
1087 {
1088 &quot;resourcePolicies&quot;: [ # Resource policies to be added to this instance.
1089 &quot;A String&quot;,
1090 ],
1091 }
1092
1093 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1094 that if you must retry your request, the server will know to ignore the
1095 request if it has already been completed.
1096
1097 For example, consider a situation where you make an initial request and
1098 the request times out. If you make the request again with the same
1099 request ID, the server can check if original operation with the same
1100 request ID was received, and if so, will ignore the second request. This
1101 prevents clients from accidentally creating duplicate commitments.
1102
1103 The request ID must be
1104 a valid UUID with the exception that zero UUID is not supported
1105 (00000000-0000-0000-0000-000000000000).
1106 x__xgafv: string, V1 error format.
1107 Allowed values
1108 1 - v1 error format
1109 2 - v2 error format
1110
1111 Returns:
1112 An object of the form:
1113
1114 { # Represents an Operation resource.
1115 #
1116 # Google Compute Engine has three Operation resources:
1117 #
1118 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
1119 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
1120 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
1121 #
1122 # You can use an operation resource to manage asynchronous API requests.
1123 # For more information, readHandling
1124 # API responses.
1125 #
1126 # Operations can be global, regional or zonal.
1127 #
1128 # - For global operations, use the `globalOperations`
1129 # resource.
1130 # - For regional operations, use the
1131 # `regionOperations` resource.
1132 # - For zonal operations, use
1133 # the `zoneOperations` resource.
1134 #
1135 #
1136 #
1137 # For more information, read
1138 # Global, Regional, and Zonal Resources.
1139 #
1140 # Note that completed Operation resources have a limited
1141 # retention period.
1142 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1143 # Not present otherwise.
1144 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1145 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1146 # set when the operation is created.
1147 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1148 # text format.
1149 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1150 # this field will be populated.
1151 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1152 # operation.
1153 {
1154 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1155 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1156 # details. There is a set of defined message types to use for providing
1157 # details.The syntax depends on the error code. For example,
1158 # QuotaExceededInfo will have details when the error code is
1159 # QUOTA_EXCEEDED.
1160 {
1161 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1162 #
1163 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1164 # is not enabled:
1165 #
1166 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1167 # &quot;domain&quot;: &quot;googleapis.com&quot;
1168 # &quot;metadata&quot;: {
1169 # &quot;resource&quot;: &quot;projects/123&quot;,
1170 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1171 # }
1172 # }
1173 #
1174 # This response indicates that the pubsub.googleapis.com API is not enabled.
1175 #
1176 # Example of an error that is returned when attempting to create a Spanner
1177 # instance in a region that is out of stock:
1178 #
1179 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1180 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1181 # &quot;metadata&quot;: {
1182 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1183 # }
1184 # }
1185 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1186 # is typically the registered service name of the tool or product that
1187 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1188 # generated by some common infrastructure, the error domain must be a
1189 # globally unique value that identifies the infrastructure. For Google API
1190 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1191 &quot;metadatas&quot;: { # Additional structured details about this error.
1192 #
1193 # Keys must match a regular expression of `a-z+` but should
1194 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1195 # length. When identifying the current value of an exceeded limit, the units
1196 # should be contained in the key, not the value. For example, rather than
1197 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1198 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1199 # instances that can be created in a single (batch) request.
1200 &quot;a_key&quot;: &quot;A String&quot;,
1201 },
1202 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1203 # proximate cause of the error. Error reasons are unique within a particular
1204 # domain of errors. This should be at most 63 characters and match a
1205 # regular expression of `A-Z+[A-Z0-9]`, which represents
1206 # UPPER_SNAKE_CASE.
1207 },
1208 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1209 #
1210 # For example, if a quota check failed with an error indicating the calling
1211 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1212 # directly to the right place in the developer console to flip the bit.
1213 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1214 { # Describes a URL link.
1215 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1216 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1217 },
1218 ],
1219 },
1220 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1221 # which can be attached to an RPC error.
1222 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1223 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1224 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1225 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1226 },
1227 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1228 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1229 &quot;a_key&quot;: &quot;A String&quot;,
1230 },
1231 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1232 # type or metric.
1233 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1234 # or metric.
1235 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1236 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1237 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1238 },
1239 },
1240 ],
1241 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1242 # This property is optional.
1243 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1244 },
1245 ],
1246 },
1247 &quot;getVersionOperationMetadata&quot;: {
1248 &quot;inlineSbomInfo&quot;: {
1249 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1250 # appropriate identifiers.
1251 &quot;a_key&quot;: &quot;A String&quot;,
1252 },
1253 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1254 # identifiers.
1255 &quot;a_key&quot;: &quot;A String&quot;,
1256 },
1257 },
1258 },
1259 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1260 # message that was returned, such as `NOT FOUND`.
1261 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1262 # status code that was returned. For example, a `404` means the
1263 # resource was not found.
1264 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1265 # defined by the server.
1266 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1267 # This value is inRFC3339
1268 # text format.
1269 &quot;instancesBulkInsertOperationMetadata&quot;: {
1270 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1271 # Example key: zones/us-central1-a
1272 &quot;a_key&quot;: {
1273 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1274 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1275 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1276 # error.
1277 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1278 # if the flow is rolling forward or rolling back.
1279 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1280 },
1281 },
1282 },
1283 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1284 # Operation resources.
1285 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1286 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1287 # group of operations results from a `bulkInsert` API request.
1288 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1289 # `update`, or `delete`, and so on.
1290 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1291 # There is no requirement that this be linear or support any granularity of
1292 # operations. This should not be used to guess when the operation will be
1293 # complete. This number should monotonically increase as the operation
1294 # progresses.
1295 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1296 # applicable when performing regional operations.
1297 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1298 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1299 # this field will contain information on all underlying zonal actions and
1300 # their state.
1301 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1302 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1303 # Example key: zones/us-central1-a
1304 &quot;a_key&quot;: {
1305 &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
1306 # populated.
1307 # different programming environments, including REST APIs and RPC APIs. It is
1308 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1309 # three pieces of data: error code, error message, and error details.
1310 #
1311 # You can find out more about this error model and how to work with it in the
1312 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1313 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1314 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1315 # message types for APIs to use.
1316 {
1317 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1318 },
1319 ],
1320 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1321 # user-facing error message should be localized and sent in the
1322 # google.rpc.Status.details field, or localized by the client.
1323 },
1324 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1325 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1326 },
1327 },
1328 },
1329 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1330 # This value is inRFC3339
1331 # text format.
1332 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1333 # following:
1334 # `PENDING`, `RUNNING`, or `DONE`.
1335 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1336 # operation.
1337 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1338 # of the target resource.
1339 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1340 # operations related to creating a snapshot, this points to the disk
1341 # that the snapshot was created from.
1342 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1343 # `[email protected]` or
1344 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1345 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1346 # operation, this field will be populated.
1347 {
1348 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1349 # Engine returns NO_RESULTS_ON_PAGE if there
1350 # are no results in the response.
1351 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1352 # value format. For example:
1353 #
1354 # &quot;data&quot;: [
1355 # {
1356 # &quot;key&quot;: &quot;scope&quot;,
1357 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1358 # }
1359 {
1360 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1361 # returned. For example, for warnings where there are no results in a list
1362 # request for a particular zone, this key might be scope and
1363 # the key value might be the zone name. Other examples might be a key
1364 # indicating a deprecated resource and a suggested replacement, or a
1365 # warning about invalid network settings (for example, if an instance
1366 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1367 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1368 },
1369 ],
1370 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1371 },
1372 ],
1373 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1374 # applicable when performing per-zone operations.
1375 }</pre>
1376 </div>
1377
1378 <div class="method">
1379 <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>
1380 <pre>Retrieves an aggregated list of all of the instances in your project
1381 across all regions and zones.
1382
1383 The performance of this method degrades when a filter is specified on a
1384 project that has a very large number of instances.
1385
1386 To prevent failure, Google recommends that you set the
1387 `returnPartialSuccess` parameter to `true`.
1388
1389 Args:
1390 project: string, Project ID for this request. (required)
1391 filter: string, A filter expression that filters resources listed in the response. Most
1392 Compute resources support two types of filter expressions:
1393 expressions that support regular expressions and expressions that follow
1394 API improvement proposal AIP-160.
1395 These two types of filter expressions cannot be mixed in one request.
1396
1397 If you want to use AIP-160, your expression must specify the field name, an
1398 operator, and the value that you want to use for filtering. The value
1399 must be a string, a number, or a boolean. The operator
1400 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
1401
1402 For example, if you are filtering Compute Engine instances, you can
1403 exclude instances named `example-instance` by specifying
1404 `name != example-instance`.
1405
1406 The `:*` comparison can be used to test whether a key has been defined.
1407 For example, to find all objects with `owner` label use:
1408 ```
1409 labels.owner:*
1410 ```
1411
1412 You can also filter nested fields. For example, you could specify
1413 `scheduling.automaticRestart = false` to include instances only
1414 if they are not scheduled for automatic restarts. You can use filtering
1415 on nested fields to filter based onresource labels.
1416
1417 To filter on multiple expressions, provide each separate expression within
1418 parentheses. For example:
1419 ```
1420 (scheduling.automaticRestart = true)
1421 (cpuPlatform = &quot;Intel Skylake&quot;)
1422 ```
1423 By default, each expression is an `AND` expression. However, you
1424 can include `AND` and `OR` expressions explicitly.
1425 For example:
1426 ```
1427 (cpuPlatform = &quot;Intel Skylake&quot;) OR
1428 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
1429 (scheduling.automaticRestart = true)
1430 ```
1431
1432 If you want to use a regular expression, use the `eq` (equal) or `ne`
1433 (not equal) operator against a single un-parenthesized expression with or
1434 without quotes or against multiple parenthesized expressions. Examples:
1435
1436 `fieldname eq unquoted literal`
1437 `fieldname eq &#x27;single quoted literal&#x27;`
1438 `fieldname eq &quot;double quoted literal&quot;`
1439 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
1440
1441 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
1442 The literal value must match the entire field.
1443
1444 For example, to filter for instances that do not end with name &quot;instance&quot;,
1445 you would use `name ne .*instance`.
1446
1447 You cannot combine constraints on multiple fields using regular
1448 expressions.
1449 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region,
1450 global) should be included in the response. For new resource types added
1451 after this field, the flag has no effect as new resource types will always
1452 include every visible scope for each scope type in response. For resource
1453 types which predate this field, if this flag is omitted or false, only
1454 scopes of the scope types where the resource type is expected to be found
1455 will be included.
1456 maxResults: integer, The maximum number of results per page that should be returned.
1457 If the number of available results is larger than `maxResults`,
1458 Compute Engine returns a `nextPageToken` that can be used to get
1459 the next page of results in subsequent list requests. Acceptable values are
1460 `0` to `500`, inclusive. (Default: `500`)
1461 orderBy: string, Sorts list results by a certain order. By default, results
1462 are returned in alphanumerical order based on the resource name.
1463
1464 You can also sort results in descending order based on the creation
1465 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
1466 results based on the `creationTimestamp` field in
1467 reverse chronological order (newest result first). Use this to sort
1468 resources like operations so that the newest operation is returned first.
1469
1470 Currently, only sorting by `name` or
1471 `creationTimestamp desc` is supported.
1472 pageToken: string, Specifies a page token to use. Set `pageToken` to the
1473 `nextPageToken` returned by a previous list request to get
1474 the next page of results.
1475 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
1476 of failure. The default value is false.
1477
1478 For example, when partial success behavior is enabled, aggregatedList for a
1479 single zone scope either returns all resources in the zone or no resources,
1480 with an error code.
1481 serviceProjectNumber: string, The Shared VPC service project id or service project number for which
1482 aggregated list request is invoked for subnetworks list-usable api.
1483 x__xgafv: string, V1 error format.
1484 Allowed values
1485 1 - v1 error format
1486 2 - v2 error format
1487
1488 Returns:
1489 An object of the form:
1490
1491 {
1492 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
1493 &quot;items&quot;: { # An object that contains a list of instances scoped by zone.
1494 &quot;a_key&quot;: { # [Output Only] Name of the scope containing this set of instances.
1495 &quot;instances&quot;: [ # [Output Only] A list of instances contained in this scope.
1496 { # Represents an Instance resource.
1497 #
1498 # An instance is a virtual machine that is hosted on Google Cloud Platform.
1499 # For more information, readVirtual Machine Instances.
1500 &quot;advancedMachineFeatures&quot;: { # Specifies options for controlling advanced machine features. # Controls for advanced machine-related behavior features.
1501 # Options that would traditionally be configured in a BIOS belong
1502 # here. Features that require operating system support may have
1503 # corresponding entries in the GuestOsFeatures of anImage (e.g., whether or not the OS in theImage supports nested virtualization being enabled or
1504 # disabled).
1505 &quot;enableNestedVirtualization&quot;: True or False, # Whether to enable nested virtualization or not (default is false).
1506 &quot;enableUefiNetworking&quot;: True or False, # Whether to enable UEFI networking for instance creation.
1507 &quot;performanceMonitoringUnit&quot;: &quot;A String&quot;, # Type of Performance Monitoring Unit requested on instance.
1508 &quot;threadsPerCore&quot;: 42, # The number of threads per physical core. To disable simultaneous
1509 # multithreading (SMT) set this to 1. If unset, the maximum number
1510 # of threads supported per core by the underlying processor is
1511 # assumed.
1512 &quot;turboMode&quot;: &quot;A String&quot;, # Turbo frequency mode to use for the instance.
1513 # Supported modes include:
1514 # * ALL_CORE_MAX
1515 #
1516 # Using empty string or not setting this field will use the platform-specific
1517 # default turbo mode.
1518 &quot;visibleCoreCount&quot;: 42, # The number of physical cores to expose to an instance. Multiply by
1519 # the number of threads per core to compute the total number of virtual
1520 # CPUs to expose to the instance. If unset, the number of cores is
1521 # inferred from the instance&#x27;s nominal CPU count and the underlying
1522 # platform&#x27;s SMT width.
1523 },
1524 &quot;canIpForward&quot;: True or False, # Allows this instance to send and receive packets with non-matching
1525 # destination or source IPs. This is required if you plan to use this
1526 # instance to forward routes. For more information, seeEnabling IP Forwarding.
1527 &quot;confidentialInstanceConfig&quot;: { # A set of Confidential Instance options.
1528 &quot;confidentialInstanceType&quot;: &quot;A String&quot;, # Defines the type of technology used by the confidential instance.
1529 &quot;enableConfidentialCompute&quot;: True or False, # Defines whether the instance should have confidential compute enabled.
1530 },
1531 &quot;cpuPlatform&quot;: &quot;A String&quot;, # Output only. [Output Only] The CPU platform used by this instance.
1532 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339 text format.
1533 &quot;deletionProtection&quot;: True or False, # Whether the resource should be protected against deletion.
1534 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1535 # create the resource.
1536 &quot;disks&quot;: [ # Array of disks associated with this instance. Persistent disks must be
1537 # created before you can assign them.
1538 { # An instance-attached disk resource.
1539 &quot;architecture&quot;: &quot;A String&quot;, # Output only. [Output Only] The architecture of the attached disk. Valid values are ARM64
1540 # or X86_64.
1541 &quot;autoDelete&quot;: True or False, # Specifies whether the disk will be auto-deleted when the instance is
1542 # deleted (but not when the disk is detached from the instance).
1543 &quot;boot&quot;: True or False, # Indicates that this is a boot disk. The virtual machine will use the first
1544 # partition of the disk for its root filesystem.
1545 &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
1546 # running within the instance. This name can be used to reference the device
1547 # for mounting, resizing, and so on, from within the instance.
1548 #
1549 # If not specified, the server chooses a default device name to apply to this
1550 # disk, in the form persistent-disk-x, where x is a number
1551 # assigned by Google Compute Engine. This field is only applicable for
1552 # persistent disks.
1553 &quot;diskEncryptionKey&quot;: { # Encrypts or decrypts a disk using acustomer-supplied
1554 # encryption key.
1555 #
1556 # If you are creating a new disk, this field encrypts the new disk using
1557 # an encryption key that you provide. If you are attaching an existing
1558 # disk that is already encrypted, this field decrypts the disk using
1559 # the customer-supplied encryption key.
1560 #
1561 # If you encrypt a disk using a customer-supplied key, you must provide the
1562 # same key again when you attempt to use this resource at a later time. For
1563 # example, you must provide the key when you create a snapshot or an image
1564 # from the disk or when you attach the disk to a virtual machine instance.
1565 #
1566 # If you do not provide an encryption key, then the disk will be encrypted
1567 # using an automatically generated key and you do not need to provide a key
1568 # to use the disk later.
1569 #
1570 # Note:
1571 #
1572 # Instance templates do not storecustomer-supplied
1573 # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
1574 #
1575 # You cannot create VMs that have disks with customer-supplied keys using
1576 # the bulk
1577 # insert method.
1578 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
1579 # For example:
1580 #
1581 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1582 # key_region/cryptoKeys/key
1583 #
1584 # The fully-qualifed key name may be returned for resource GET requests. For
1585 # example:
1586 #
1587 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1588 # key_region/cryptoKeys/key
1589 # /cryptoKeyVersions/1
1590 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
1591 # key. If absent, the Compute Engine default service account is used.
1592 # For example:
1593 #
1594 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
1595 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
1596 # encryption key, encoded in RFC
1597 # 4648 base64 to either encrypt or decrypt this resource. You can
1598 # provide either the rawKey or thersaEncryptedKey.
1599 # For example:
1600 #
1601 # &quot;rawKey&quot;:
1602 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
1603 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
1604 # customer-supplied encryption key to either encrypt or decrypt this
1605 # resource. You can provide either the rawKey or thersaEncryptedKey.
1606 # For example:
1607 #
1608 # &quot;rsaEncryptedKey&quot;:
1609 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
1610 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
1611 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
1612 #
1613 # The key must meet the following requirements before you can provide it to
1614 # Compute Engine:
1615 #
1616 # 1. The key is wrapped using a RSA public key certificate provided by
1617 # Google.
1618 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
1619 # encoding.
1620 #
1621 # Gets the RSA public key certificate provided by Google at:
1622 #
1623 #
1624 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
1625 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
1626 # 4648 base64 encoded SHA-256 hash of the customer-supplied
1627 # encryption key that protects this resource.
1628 },
1629 &quot;diskSizeGb&quot;: &quot;A String&quot;, # The size of the disk in GB.
1630 &quot;forceAttach&quot;: True or False, # [Input Only] Whether to force attach the regional disk even if it&#x27;s
1631 # currently attached to another instance. If you try to force attach a zonal
1632 # disk to an instance, you will receive an error.
1633 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
1634 # only for bootable images. Read
1635 # Enabling guest operating system features to see a list of available
1636 # options.
1637 { # Guest OS features.
1638 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
1639 # separate values. Set to one or more of the following values:
1640 #
1641 # - VIRTIO_SCSI_MULTIQUEUE
1642 # - WINDOWS
1643 # - MULTI_IP_SUBNET
1644 # - UEFI_COMPATIBLE
1645 # - GVNIC
1646 # - SEV_CAPABLE
1647 # - SUSPEND_RESUME_COMPATIBLE
1648 # - SEV_LIVE_MIGRATABLE_V2
1649 # - SEV_SNP_CAPABLE
1650 # - TDX_CAPABLE
1651 # - IDPF
1652 # - SNP_SVSM_CAPABLE
1653 # - CCA_CAPABLE
1654 #
1655 #
1656 # For more information, see
1657 # Enabling guest operating system features.
1658 },
1659 ],
1660 &quot;index&quot;: 42, # Output only. [Output Only] A zero-based index to this disk, where 0 is reserved for the
1661 # boot disk. If you have many disks attached to an instance, each
1662 # disk would have a unique index number.
1663 &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
1664 # alongside the new instance. Use initialization parameters to create boot
1665 # disks or local SSDs attached to the new instance.
1666 #
1667 # This property is mutually exclusive with the source property;
1668 # you can only define one or the other, but not both.
1669 # alongside the new instance. Use initialization parameters to create boot
1670 # disks or local SSDs attached to the new instance.
1671 #
1672 # This field is persisted and returned for instanceTemplate and not returned
1673 # in the context of instance.
1674 #
1675 # This property is mutually exclusive with the source property;
1676 # you can only define one or the other, but not both.
1677 &quot;architecture&quot;: &quot;A String&quot;, # The architecture of the attached disk. Valid values are
1678 # arm64 or x86_64.
1679 &quot;description&quot;: &quot;A String&quot;, # An optional description. Provide this property when creating the disk.
1680 &quot;diskName&quot;: &quot;A String&quot;, # Specifies the disk name. If not specified, the default is to use the name
1681 # of the instance. If a disk with the same name already exists in the given
1682 # region, the existing disk is attached to the new instance and the
1683 # new disk is not created.
1684 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB. The size must be at least
1685 # 10 GB. If you specify a sourceImage, which is required for
1686 # boot disks, the default size is the size of the sourceImage.
1687 # If you do not specify a sourceImage, the default disk size
1688 # is 500 GB.
1689 &quot;diskType&quot;: &quot;A String&quot;,
1690 &quot;enableConfidentialCompute&quot;: True or False, # Whether this disk is using confidential compute mode.
1691 &quot;labels&quot;: { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
1692 # persistent disks.
1693 &quot;a_key&quot;: &quot;A String&quot;,
1694 },
1695 &quot;licenses&quot;: [ # A list of publicly visible licenses. Reserved for Google&#x27;s use.
1696 &quot;A String&quot;,
1697 ],
1698 &quot;onUpdateAction&quot;: &quot;A String&quot;, # Specifies which action to take on instance update with this disk. Default
1699 # is to use the existing disk.
1700 &quot;provisionedIops&quot;: &quot;A String&quot;, # Indicates how many IOPS to provision for the disk. This sets the number
1701 # of I/O operations per second that the disk can handle. Values must be
1702 # between 10,000 and 120,000. For more details, see theExtreme persistent
1703 # disk documentation.
1704 &quot;provisionedThroughput&quot;: &quot;A String&quot;, # Indicates how much throughput to provision for the disk. This sets the
1705 # number of throughput mb per second that the disk can handle. Values must
1706 # greater than or equal to 1.
1707 &quot;replicaZones&quot;: [ # Required for each regional disk associated with the instance. Specify
1708 # the URLs of the zones where the disk should be replicated to.
1709 # You must provide exactly two replica zones, and one zone must be the same
1710 # as the instance zone.
1711 &quot;A String&quot;,
1712 ],
1713 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
1714 # have the same definition as resource
1715 # manager tags. Keys and values can be either in numeric format,
1716 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
1717 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
1718 # `{tag_value_short_name}`. The field is ignored (both PUT &amp; PATCH) when
1719 # empty.
1720 &quot;a_key&quot;: &quot;A String&quot;,
1721 },
1722 &quot;resourcePolicies&quot;: [ # Resource policies applied to this disk for automatic snapshot creations.
1723 # Specified using the full or partial URL. For instance template, specify
1724 # only the resource policy name.
1725 &quot;A String&quot;,
1726 ],
1727 &quot;sourceImage&quot;: &quot;A String&quot;, # The source image to create this disk. When creating a new instance boot
1728 # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
1729 # is required.
1730 #
1731 # To create a disk with one of the public operating system
1732 # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
1733 #
1734 # projects/debian-cloud/global/images/family/debian-9
1735 #
1736 #
1737 # Alternatively, use a specific version of a public operating system image:
1738 #
1739 # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
1740 #
1741 #
1742 # To create a disk with a custom image that you created, specify the
1743 # image name in the following format:
1744 #
1745 # global/images/my-custom-image
1746 #
1747 #
1748 # You can also specify a custom image by its image family, which returns
1749 # the latest version of the image in that family. Replace the image name
1750 # with family/family-name:
1751 #
1752 # global/images/family/my-image-family
1753 #
1754 #
1755 # If the source image is deleted later, this field will not be set.
1756 &quot;sourceImageEncryptionKey&quot;: { # Thecustomer-supplied
1757 # encryption key of the source image. Required if the source image is
1758 # protected by a customer-supplied encryption key.
1759 #
1760 # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
1761 # encryption keys, so you cannot create disks for instances in a managed instance group if the
1762 # source images are encrypted with your own keys.
1763 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
1764 # For example:
1765 #
1766 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1767 # key_region/cryptoKeys/key
1768 #
1769 # The fully-qualifed key name may be returned for resource GET requests. For
1770 # example:
1771 #
1772 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1773 # key_region/cryptoKeys/key
1774 # /cryptoKeyVersions/1
1775 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
1776 # key. If absent, the Compute Engine default service account is used.
1777 # For example:
1778 #
1779 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
1780 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
1781 # encryption key, encoded in RFC
1782 # 4648 base64 to either encrypt or decrypt this resource. You can
1783 # provide either the rawKey or thersaEncryptedKey.
1784 # For example:
1785 #
1786 # &quot;rawKey&quot;:
1787 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
1788 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
1789 # customer-supplied encryption key to either encrypt or decrypt this
1790 # resource. You can provide either the rawKey or thersaEncryptedKey.
1791 # For example:
1792 #
1793 # &quot;rsaEncryptedKey&quot;:
1794 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
1795 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
1796 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
1797 #
1798 # The key must meet the following requirements before you can provide it to
1799 # Compute Engine:
1800 #
1801 # 1. The key is wrapped using a RSA public key certificate provided by
1802 # Google.
1803 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
1804 # encoding.
1805 #
1806 # Gets the RSA public key certificate provided by Google at:
1807 #
1808 #
1809 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
1810 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
1811 # 4648 base64 encoded SHA-256 hash of the customer-supplied
1812 # encryption key that protects this resource.
1813 },
1814 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # The source snapshot to create this disk. When creating a new instance
1815 # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
1816 # is required.
1817 #
1818 # To create a disk with a snapshot that you created, specify the
1819 # snapshot name in the following format:
1820 #
1821 # global/snapshots/my-backup
1822 #
1823 #
1824 # If the source snapshot is deleted later, this field will not be set.
1825 #
1826 # Note: You cannot create VMs in bulk using a snapshot as the source. Use
1827 # an image instead when you create VMs using
1828 # the bulk
1829 # insert method.
1830 &quot;sourceSnapshotEncryptionKey&quot;: { # Thecustomer-supplied
1831 # encryption key of the source snapshot.
1832 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
1833 # For example:
1834 #
1835 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1836 # key_region/cryptoKeys/key
1837 #
1838 # The fully-qualifed key name may be returned for resource GET requests. For
1839 # example:
1840 #
1841 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1842 # key_region/cryptoKeys/key
1843 # /cryptoKeyVersions/1
1844 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
1845 # key. If absent, the Compute Engine default service account is used.
1846 # For example:
1847 #
1848 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
1849 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
1850 # encryption key, encoded in RFC
1851 # 4648 base64 to either encrypt or decrypt this resource. You can
1852 # provide either the rawKey or thersaEncryptedKey.
1853 # For example:
1854 #
1855 # &quot;rawKey&quot;:
1856 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
1857 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
1858 # customer-supplied encryption key to either encrypt or decrypt this
1859 # resource. You can provide either the rawKey or thersaEncryptedKey.
1860 # For example:
1861 #
1862 # &quot;rsaEncryptedKey&quot;:
1863 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
1864 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
1865 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
1866 #
1867 # The key must meet the following requirements before you can provide it to
1868 # Compute Engine:
1869 #
1870 # 1. The key is wrapped using a RSA public key certificate provided by
1871 # Google.
1872 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
1873 # encoding.
1874 #
1875 # Gets the RSA public key certificate provided by Google at:
1876 #
1877 #
1878 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
1879 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
1880 # 4648 base64 encoded SHA-256 hash of the customer-supplied
1881 # encryption key that protects this resource.
1882 },
1883 &quot;storagePool&quot;: &quot;A String&quot;, # The storage pool in which the new disk is created. You can provide
1884 # this as a partial or full URL to the resource. For example, the following
1885 # are valid values:
1886 #
1887 #
1888 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
1889 # - projects/project/zones/zone/storagePools/storagePool
1890 # - zones/zone/storagePools/storagePool
1891 },
1892 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is
1893 # either SCSI or NVME. For most machine types, the
1894 # default is SCSI. Local SSDs can use either NVME or SCSI.
1895 # In certain configurations, persistent disks can use NVMe. For more
1896 # information, seeAbout
1897 # persistent disks.
1898 &quot;kind&quot;: &quot;compute#attachedDisk&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
1899 &quot;licenses&quot;: [ # Output only. [Output Only] Any valid publicly visible licenses.
1900 &quot;A String&quot;,
1901 ],
1902 &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
1903 # in READ_WRITE mode.
1904 &quot;savedState&quot;: &quot;A String&quot;, # Output only. For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
1905 # field is set to PRESERVED if the LocalSSD data has been saved
1906 # to a persistent location by customer request. (see the
1907 # discard_local_ssd option on Stop/Suspend).
1908 # Read-only in the api.
1909 &quot;shieldedInstanceInitialState&quot;: { # Initial State for shielded instance, # Output only. [Output Only] shielded vm initial state stored on disk
1910 # these are public keys which are safe to store in public
1911 &quot;dbs&quot;: [ # The Key Database (db).
1912 {
1913 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
1914 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
1915 },
1916 ],
1917 &quot;dbxs&quot;: [ # The forbidden key database (dbx).
1918 {
1919 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
1920 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
1921 },
1922 ],
1923 &quot;keks&quot;: [ # The Key Exchange Key (KEK).
1924 {
1925 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
1926 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
1927 },
1928 ],
1929 &quot;pk&quot;: { # The Platform Key (PK).
1930 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
1931 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
1932 },
1933 },
1934 &quot;source&quot;: &quot;A String&quot;, # Specifies a valid partial or full URL to an existing Persistent Disk
1935 # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
1936 # is required.
1937 #
1938 # If desired, you can also attach existing non-root persistent disks using
1939 # this property. This field is only applicable for persistent disks.
1940 #
1941 # Note that for InstanceTemplate, specify the disk name for zonal disk,
1942 # and the URL for regional disk.
1943 &quot;type&quot;: &quot;A String&quot;, # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
1944 },
1945 ],
1946 &quot;displayDevice&quot;: { # A set of Display Device options # Enables display device for the instance.
1947 &quot;enableDisplay&quot;: True or False, # Defines whether the instance has Display enabled.
1948 },
1949 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this resource, which is essentially a hash of
1950 # the instance&#x27;s contents and used for optimistic locking. The
1951 # fingerprint is initially generated by Compute Engine and changes after
1952 # every request to modify or update the instance. You must always provide an
1953 # up-to-date fingerprint hash in order to update the instance.
1954 #
1955 # To see the latest fingerprint, make get() request to the
1956 # instance.
1957 &quot;guestAccelerators&quot;: [ # A list of the type and count of accelerator cards attached to the instance.
1958 { # A specification of the type and number of accelerator cards attached to the
1959 # instance.
1960 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
1961 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this
1962 # instance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100
1963 # If you are creating an instance template, specify only the
1964 # accelerator name.
1965 # See GPUs on Compute Engine
1966 # for a full list of accelerator types.
1967 },
1968 ],
1969 &quot;hostname&quot;: &quot;A String&quot;, # Specifies the hostname of the instance. The specified hostname must be
1970 # RFC1035 compliant. If hostname is not specified, the default hostname is
1971 # [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and
1972 # [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.
1973 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
1974 # defined by the server.
1975 &quot;instanceEncryptionKey&quot;: { # Encrypts suspended data for an instance with acustomer-managed
1976 # encryption key.
1977 #
1978 # If you are creating a new instance, this field will encrypt the local SSD
1979 # and in-memory contents of the instance during the suspend operation.
1980 #
1981 # If you do not provide an encryption key when creating the instance, then
1982 # the local SSD and in-memory contents will be encrypted using
1983 # an automatically generated key during the suspend operation.
1984 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
1985 # For example:
1986 #
1987 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1988 # key_region/cryptoKeys/key
1989 #
1990 # The fully-qualifed key name may be returned for resource GET requests. For
1991 # example:
1992 #
1993 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1994 # key_region/cryptoKeys/key
1995 # /cryptoKeyVersions/1
1996 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
1997 # key. If absent, the Compute Engine default service account is used.
1998 # For example:
1999 #
2000 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
2001 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
2002 # encryption key, encoded in RFC
2003 # 4648 base64 to either encrypt or decrypt this resource. You can
2004 # provide either the rawKey or thersaEncryptedKey.
2005 # For example:
2006 #
2007 # &quot;rawKey&quot;:
2008 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
2009 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
2010 # customer-supplied encryption key to either encrypt or decrypt this
2011 # resource. You can provide either the rawKey or thersaEncryptedKey.
2012 # For example:
2013 #
2014 # &quot;rsaEncryptedKey&quot;:
2015 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
2016 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
2017 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
2018 #
2019 # The key must meet the following requirements before you can provide it to
2020 # Compute Engine:
2021 #
2022 # 1. The key is wrapped using a RSA public key certificate provided by
2023 # Google.
2024 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
2025 # encoding.
2026 #
2027 # Gets the RSA public key certificate provided by Google at:
2028 #
2029 #
2030 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
2031 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
2032 # 4648 base64 encoded SHA-256 hash of the customer-supplied
2033 # encryption key that protects this resource.
2034 },
2035 &quot;keyRevocationActionType&quot;: &quot;A String&quot;, # KeyRevocationActionType of the instance. Supported options are &quot;STOP&quot; and
2036 # &quot;NONE&quot;. The default value is &quot;NONE&quot; if it is not specified.
2037 &quot;kind&quot;: &quot;compute#instance&quot;, # Output only. [Output Only] Type of the resource. Always compute#instance
2038 # for instances.
2039 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for this request, which is essentially a hash of
2040 # the label&#x27;s contents and used for optimistic locking. The
2041 # fingerprint is initially generated by Compute Engine and changes after
2042 # every request to modify or update labels. You must always provide an
2043 # up-to-date fingerprint hash in order to update or change labels.
2044 #
2045 # To see the latest fingerprint, make get() request to the
2046 # instance.
2047 &quot;labels&quot;: { # Labels to apply to this instance. These can be later modified by
2048 # the setLabels method.
2049 &quot;a_key&quot;: &quot;A String&quot;,
2050 },
2051 &quot;lastStartTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last start timestamp inRFC3339 text format.
2052 &quot;lastStopTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last stop timestamp inRFC3339 text format.
2053 &quot;lastSuspendedTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last suspended timestamp inRFC3339 text format.
2054 &quot;machineType&quot;: &quot;A String&quot;, # Full or partial URL of the machine type resource to use for this instance,
2055 # in the format:zones/zone/machineTypes/machine-type. This is provided by the client
2056 # when the instance is created. For example, the following is a valid partial
2057 # url to a predefined
2058 # machine type:
2059 #
2060 # zones/us-central1-f/machineTypes/n1-standard-1
2061 #
2062 #
2063 # To create acustom
2064 # machine type, provide a URL to a machine type in the following format,
2065 # where CPUS is 1 or an even number up to 32 (2,
2066 # 4, 6, ... 24, etc), and MEMORY is the total
2067 # memory for this instance. Memory must be a multiple of 256 MB and must
2068 # be supplied in MB (e.g. 5 GB of memory is 5120 MB):
2069 #
2070 # zones/zone/machineTypes/custom-CPUS-MEMORY
2071 #
2072 #
2073 # For example: zones/us-central1-f/machineTypes/custom-4-5120
2074 # For a full list of restrictions, read theSpecifications
2075 # for custom machine types.
2076 &quot;metadata&quot;: { # A metadata key/value entry. # The metadata key/value pairs assigned
2077 # to this instance. This includes metadata keys that were explicitly defined
2078 # for the instance.
2079 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
2080 # the metadata&#x27;s contents and used for optimistic locking. The
2081 # fingerprint is initially generated by Compute Engine and changes after
2082 # every request to modify or update metadata. You must always provide an
2083 # up-to-date fingerprint hash in order to update or change metadata,
2084 # otherwise the request will fail with error412 conditionNotMet.
2085 #
2086 # To see the latest fingerprint, make a get() request to
2087 # retrieve the resource.
2088 &quot;items&quot;: [ # Array of key/value pairs. The total size of all keys and values must be
2089 # less than 512 KB.
2090 { # Metadata
2091 &quot;key&quot;: &quot;A String&quot;, # Key for the metadata entry. Keys must conform to the following
2092 # regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length.
2093 # This is reflected as part of a URL in the metadata server. Additionally, to
2094 # avoid ambiguity, keys must not conflict with any other metadata keys
2095 # for the project.
2096 &quot;value&quot;: &quot;A String&quot;, # Value for the metadata entry. These are free-form strings, and only
2097 # have meaning as interpreted by the image running in the instance. The
2098 # only restriction placed on values is that their size must be less than
2099 # or equal to 262144 bytes (256 KiB).
2100 },
2101 ],
2102 &quot;kind&quot;: &quot;compute#metadata&quot;, # Output only. [Output Only] Type of the resource. Always compute#metadata
2103 # for metadata.
2104 },
2105 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Specifies aminimum CPU
2106 # platform for the VM instance. Applicable values are the friendly names
2107 # of CPU platforms, such as minCpuPlatform: &quot;Intel
2108 # Haswell&quot; or minCpuPlatform: &quot;Intel Sandy
2109 # Bridge&quot;.
2110 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating
2111 # the resource. The resource name must be 1-63 characters long, and comply
2112 # withRFC1035.
2113 # Specifically, the name must be 1-63 characters long and match the regular
2114 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
2115 # character must be a lowercase letter, and all following characters must be
2116 # a dash, lowercase letter, or digit, except the last character, which cannot
2117 # be a dash.
2118 &quot;networkInterfaces&quot;: [ # An array of network configurations for this instance. These specify how
2119 # interfaces are configured to interact with other network services, such as
2120 # connecting to the internet. Multiple interfaces are supported
2121 # per instance.
2122 { # A network interface resource attached to an instance.
2123 &quot;accessConfigs&quot;: [ # An array of configurations for this interface. Currently, only one access
2124 # config, ONE_TO_ONE_NAT, is supported. If there are noaccessConfigs specified, then this instance will have
2125 # no external internet access.
2126 { # An access configuration attached to an instance&#x27;s network interface.
2127 # Only one access config per instance is supported.
2128 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
2129 # The first IPv6 address of the external IPv6 range associated
2130 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
2131 # use a static external IP address, it must be unused and in the same region
2132 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
2133 # assign an external IPv6 address from the instance&#x27;s subnetwork.
2134 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
2135 # external IPv6 range.
2136 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
2137 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
2138 # (IPv4), the default and recommended name is External NAT, but
2139 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
2140 # recommend name is External IPv6.
2141 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
2142 # address associated with this instance. Specify an unused static
2143 # external IP address available to the project or leave this field undefined
2144 # to use an IP from a shared ephemeral IP address pool. If you specify a
2145 # static external IP address, it must live in the same region as the zone of
2146 # the instance.
2147 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
2148 # configuration and can only take the following values: PREMIUM,STANDARD.
2149 #
2150 # If an AccessConfig is specified without a valid external IP address, an
2151 # ephemeral IP will be created with this networkTier.
2152 #
2153 # If an AccessConfig with a valid external IP address is specified, it must
2154 # match that of the networkTier associated with the Address resource owning
2155 # that IP.
2156 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
2157 #
2158 # 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
2159 # first IP in associated external IPv6 range.
2160 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
2161 # config.
2162 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
2163 # external IP address of the instance to a DNS domain name.
2164 #
2165 # This field is not used in ipv6AccessConfig. A default PTR
2166 # record will be created if the VM has external IPv6 range associated.
2167 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
2168 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
2169 },
2170 ],
2171 &quot;aliasIpRanges&quot;: [ # An array of alias IP ranges for this network interface.
2172 # You can only specify this field for network interfaces in VPC networks.
2173 { # An alias IP range attached to an instance&#x27;s network interface.
2174 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
2175 # must belong to the specified subnetwork and cannot contain IP addresses
2176 # reserved by system or used by other network interfaces. This range may be
2177 # 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).
2178 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
2179 # alias range. If not specified, the primary range of the subnetwork is used.
2180 },
2181 ],
2182 &quot;aliasIpv6Ranges&quot;: [ # An array of alias IPv6 ranges for this network interface.
2183 # You can only specify this field for network interfaces in VPC networks.
2184 { # An alias IP range attached to an instance&#x27;s network interface.
2185 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
2186 # must belong to the specified subnetwork and cannot contain IP addresses
2187 # reserved by system or used by other network interfaces. This range may be
2188 # 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).
2189 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
2190 # alias range. If not specified, the primary range of the subnetwork is used.
2191 },
2192 ],
2193 &quot;enableVpcScopedDns&quot;: True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
2194 # with network_attachment.
2195 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint hash of contents stored in this network interface.
2196 # This field will be ignored when inserting an Instance or
2197 # adding a NetworkInterface. An up-to-date
2198 # 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.
2199 &quot;igmpQuery&quot;: &quot;A String&quot;, # Indicate whether igmp query is enabled on the network interface
2200 # or not. If enabled, also indicates the version of IGMP supported.
2201 &quot;internalIpv6PrefixLength&quot;: 42, # The prefix length of the primary internal IPv6 range.
2202 &quot;ipv6AccessConfigs&quot;: [ # An array of IPv6 access configurations for this interface. Currently, only
2203 # one IPv6 access config, DIRECT_IPV6, is supported. If there
2204 # is no ipv6AccessConfig specified, then this instance will
2205 # have no external IPv6 Internet access.
2206 { # An access configuration attached to an instance&#x27;s network interface.
2207 # Only one access config per instance is supported.
2208 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
2209 # The first IPv6 address of the external IPv6 range associated
2210 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
2211 # use a static external IP address, it must be unused and in the same region
2212 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
2213 # assign an external IPv6 address from the instance&#x27;s subnetwork.
2214 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
2215 # external IPv6 range.
2216 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
2217 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
2218 # (IPv4), the default and recommended name is External NAT, but
2219 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
2220 # recommend name is External IPv6.
2221 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
2222 # address associated with this instance. Specify an unused static
2223 # external IP address available to the project or leave this field undefined
2224 # to use an IP from a shared ephemeral IP address pool. If you specify a
2225 # static external IP address, it must live in the same region as the zone of
2226 # the instance.
2227 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
2228 # configuration and can only take the following values: PREMIUM,STANDARD.
2229 #
2230 # If an AccessConfig is specified without a valid external IP address, an
2231 # ephemeral IP will be created with this networkTier.
2232 #
2233 # If an AccessConfig with a valid external IP address is specified, it must
2234 # match that of the networkTier associated with the Address resource owning
2235 # that IP.
2236 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
2237 #
2238 # 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
2239 # first IP in associated external IPv6 range.
2240 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
2241 # config.
2242 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
2243 # external IP address of the instance to a DNS domain name.
2244 #
2245 # This field is not used in ipv6AccessConfig. A default PTR
2246 # record will be created if the VM has external IPv6 range associated.
2247 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
2248 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
2249 },
2250 ],
2251 &quot;ipv6AccessType&quot;: &quot;A String&quot;, # Output only. [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be
2252 # accessed from the Internet. This field is always inherited from its
2253 # subnetwork.
2254 #
2255 # Valid only if stackType is IPV4_IPV6.
2256 &quot;ipv6Address&quot;: &quot;A String&quot;, # An IPv6 internal network address for this network interface. To
2257 # use a static internal IP address, it must be unused and in the same region
2258 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
2259 # assign an internal IPv6 address from the instance&#x27;s subnetwork.
2260 &quot;kind&quot;: &quot;compute#networkInterface&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#networkInterface for network interfaces.
2261 &quot;name&quot;: &quot;A String&quot;, # [Output Only] The name of the network interface, which is generated by the
2262 # server. For a VM, the network interface uses the nicN naming
2263 # format. Where N is a value between 0 and7. The default interface value is nic0.
2264 &quot;network&quot;: &quot;A String&quot;, # URL of the VPC network resource for this instance. When creating an
2265 # instance, if neither the network nor the subnetwork is specified, the
2266 # default network global/networks/default is used. If the
2267 # selected project doesn&#x27;t have the default network, you must specify a
2268 # network or subnet. If the network is not specified but the subnetwork is
2269 # specified, the network is inferred.
2270 #
2271 # If you specify this property, you can specify the network as
2272 # a full or partial URL. For example, the following are all valid URLs:
2273 #
2274 #
2275 # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
2276 # - projects/project/global/networks/network
2277 # - global/networks/default
2278 &quot;networkAttachment&quot;: &quot;A String&quot;, # The URL of the network attachment that this interface should connect
2279 # to in the following format:
2280 # projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.
2281 &quot;networkIP&quot;: &quot;A String&quot;, # An IPv4 internal IP address to assign to the instance for this network
2282 # interface. If not specified by the user, an unused internal IP is
2283 # assigned by the system.
2284 &quot;nicType&quot;: &quot;A String&quot;, # The type of vNIC to be used on this interface. This may be gVNIC or
2285 # VirtioNet.
2286 &quot;parentNicName&quot;: &quot;A String&quot;, # Name of the parent network interface of a dynamic network interface.
2287 &quot;queueCount&quot;: 42, # The networking queue count that&#x27;s specified by users for the network
2288 # interface. Both Rx and Tx queues will be set to this number. It&#x27;ll be empty
2289 # if not specified by the users.
2290 &quot;serviceClassId&quot;: &quot;A String&quot;, # Optional. Producer Service&#x27;s Service class Id for the region of this network
2291 # interface. Can only be used with network_attachment. It is not possible to
2292 # use on its own however, network_attachment can be used without
2293 # service_class_id.
2294 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for this network interface. To assign only IPv4 addresses,
2295 # use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, useIPV4_IPV6. If not specified, IPV4_ONLY is used.
2296 #
2297 # This field can be both set at instance creation and update network
2298 # interface operations.
2299 &quot;subnetwork&quot;: &quot;A String&quot;, # The URL of the Subnetwork resource for this instance. If the network
2300 # resource is inlegacy
2301 # mode, do not specify this field. If the network is in auto subnet
2302 # mode, specifying the subnetwork is optional. If the network is in custom
2303 # subnet mode, specifying the subnetwork is required. If you specify this
2304 # field, you can specify the subnetwork as a full or partial URL. For
2305 # example, the following are all valid URLs:
2306 #
2307 #
2308 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
2309 # - regions/region/subnetworks/subnetwork
2310 &quot;vlan&quot;: 42, # VLAN tag of a dynamic network interface, must be an integer in the range
2311 # from 2 to 255 inclusively.
2312 },
2313 ],
2314 &quot;networkPerformanceConfig&quot;: {
2315 &quot;totalEgressBandwidthTier&quot;: &quot;A String&quot;,
2316 },
2317 &quot;params&quot;: { # Additional instance params. # Input only. [Input Only] Additional params passed with the request, but not persisted
2318 # as part of resource payload.
2319 &quot;requestValidForDuration&quot;: { # A Duration represents a fixed-length span of time represented # Relative deadline for waiting for capacity. Relevant only for
2320 # Instances.Insert API.
2321 # as a count of seconds and fractions of seconds at nanosecond
2322 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
2323 # or &quot;month&quot;. Range is approximately 10,000 years.
2324 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
2325 # Durations less than one second are represented with a 0
2326 # `seconds` field and a positive `nanos` field. Must be from 0
2327 # to 999,999,999 inclusive.
2328 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
2329 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
2330 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
2331 },
2332 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the instance. Tag keys and values
2333 # have the same definition as resource
2334 # manager tags. Keys and values can be either in numeric format,
2335 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
2336 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
2337 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
2338 # PATCH) when empty.
2339 &quot;a_key&quot;: &quot;A String&quot;,
2340 },
2341 },
2342 &quot;privateIpv6GoogleAccess&quot;: &quot;A String&quot;, # The private IPv6 google access type for the VM.
2343 # If not specified, use INHERIT_FROM_SUBNETWORK as default.
2344 &quot;reservationAffinity&quot;: { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.
2345 &quot;consumeReservationType&quot;: &quot;A String&quot;, # Specifies the type of reservation from which this instance can consume
2346 # resources: ANY_RESERVATION (default),SPECIFIC_RESERVATION, or NO_RESERVATION. See
2347 # Consuming reserved instances for examples.
2348 &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
2349 # the name of your reservation as its value.
2350 &quot;values&quot;: [ # Corresponds to the label values of a reservation resource. This can be
2351 # either a name to a reservation in the same project or
2352 # &quot;projects/different-project/reservations/some-reservation-name&quot; to target a
2353 # shared reservation in the same zone but in a different project.
2354 &quot;A String&quot;,
2355 ],
2356 },
2357 &quot;resourcePolicies&quot;: [ # Resource policies applied to this instance.
2358 &quot;A String&quot;,
2359 ],
2360 &quot;resourceStatus&quot;: { # Contains output only fields. # Output only. [Output Only] Specifies values set for instance attributes as
2361 # compared to the values requested by user in the corresponding input only
2362 # field.
2363 # Use this sub-message for actual values set on Instance attributes as compared
2364 # to the value requested by the user (intent) in their instance CRUD calls.
2365 &quot;effectiveInstanceMetadata&quot;: { # Effective values of predefined metadata keys for an instance. # Output only. [Output Only] Effective metadata is a field that consolidates project,
2366 # zonal instance settings, and instance-level predefined metadata keys to
2367 # provide the overridden value for those metadata keys at the instance level.
2368 &quot;blockProjectSshKeysMetadataValue&quot;: True or False, # Effective block-project-ssh-keys value at Instance level.
2369 &quot;enableGuestAttributesMetadataValue&quot;: True or False, # Effective enable-guest-attributes value at Instance level.
2370 &quot;enableOsInventoryMetadataValue&quot;: True or False, # Effective enable-os-inventory value at Instance level.
2371 &quot;enableOsconfigMetadataValue&quot;: True or False, # Effective enable-osconfig value at Instance level.
2372 &quot;enableOsloginMetadataValue&quot;: True or False, # Effective enable-oslogin value at Instance level.
2373 &quot;gceContainerDeclarationMetadataValue&quot;: True or False, # Effective gce-container-declaration value at Instance level.
2374 &quot;serialPortEnableMetadataValue&quot;: True or False, # Effective serial-port-enable value at Instance level.
2375 &quot;serialPortLoggingEnableMetadataValue&quot;: True or False, # Effective serial-port-logging-enable value at Instance level.
2376 &quot;vmDnsSettingMetadataValue&quot;: &quot;A String&quot;, # Effective VM DNS setting at Instance level.
2377 },
2378 &quot;physicalHost&quot;: &quot;A String&quot;, # Output only. [Output Only] The precise location of your instance within the zone&#x27;s data
2379 # center, including the block, sub-block, and host. The field is formatted as
2380 # follows: blockId/subBlockId/hostId.
2381 &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
2382 # Engine cluster, as well as the ID of the block, sub-block, and host on
2383 # which the running instance is located.
2384 # running.
2385 &quot;additionalAttributes&quot;: { # Additional location information of the running instance. # Output only. [Output Only] Additional location information of the running instance.
2386 &quot;acceleratorTopologyIds&quot;: { # Output only. The IDs of the accelerator topologies the instance belongs to. For
2387 # example
2388 # The key will be topologies like &quot;4x4&quot;, &quot;2x2x2&quot; and the value will be
2389 # the location ID of the topologies.
2390 &quot;a_key&quot;: &quot;A String&quot;,
2391 },
2392 },
2393 &quot;block&quot;: &quot;A String&quot;, # [Output Only] The ID of the block in which the running instance is
2394 # located. Instances within the same block experience low network latency.
2395 &quot;cluster&quot;: &quot;A String&quot;, # [Output Only] The global name of the Compute Engine cluster where the
2396 # running instance is located.
2397 &quot;host&quot;: &quot;A String&quot;, # [Output Only] The ID of the host on which the running instance is located.
2398 # Instances on the same host experience the lowest possible network
2399 # latency.
2400 &quot;subblock&quot;: &quot;A String&quot;, # [Output Only] The ID of the sub-block in which the running instance is
2401 # located. Instances in the same sub-block experience lower network latency
2402 # than instances in the same block.
2403 },
2404 &quot;reservationConsumptionInfo&quot;: { # Reservation consumption information that the instance is consuming from. # Output only. [Output Only] Reservation information that the instance is consuming from.
2405 &quot;consumedReservation&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the reservation that this
2406 # instance is consuming from.
2407 },
2408 &quot;scheduling&quot;: {
2409 &quot;availabilityDomain&quot;: 42, # Specifies the availability domain to place the instance in. The value
2410 # must be a number between 1 and the number of availability domains
2411 # specified in the spread placement policy attached to the instance.
2412 },
2413 &quot;upcomingMaintenance&quot;: { # Upcoming Maintenance notification information.
2414 &quot;canReschedule&quot;: True or False, # Indicates if the maintenance can be customer triggered.
2415 &quot;latestWindowStartTime&quot;: &quot;A String&quot;, # The latest time for the planned maintenance window to start.
2416 # This timestamp value is in RFC3339 text format.
2417 &quot;maintenanceOnShutdown&quot;: True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown.
2418 &quot;maintenanceReasons&quot;: [ # The reasons for the maintenance. Only valid for vms.
2419 &quot;A String&quot;,
2420 ],
2421 &quot;maintenanceStatus&quot;: &quot;A String&quot;,
2422 &quot;type&quot;: &quot;A String&quot;, # Defines the type of maintenance.
2423 &quot;windowEndTime&quot;: &quot;A String&quot;, # The time by which the maintenance disruption will be completed.
2424 # This timestamp value is in RFC3339 text format.
2425 &quot;windowStartTime&quot;: &quot;A String&quot;, # The current start time of the maintenance window.
2426 # This timestamp value is in RFC3339 text format.
2427 },
2428 },
2429 &quot;satisfiesPzi&quot;: True or False, # Output only. [Output Only] Reserved for future use.
2430 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
2431 &quot;scheduling&quot;: { # Sets the scheduling options for an Instance. # Sets the scheduling options for this instance.
2432 &quot;automaticRestart&quot;: True or False, # Specifies whether the instance should be automatically restarted if it is
2433 # terminated by Compute Engine (not terminated by a user). You can only set
2434 # the automatic restart option for standard instances.Preemptible instances
2435 # cannot be automatically restarted.
2436 #
2437 # By default, this is set to true so an instance is
2438 # automatically restarted if it is terminated by Compute Engine.
2439 &quot;availabilityDomain&quot;: 42, # Specifies the availability domain to place the instance in. The value
2440 # must be a number between 1 and the number of availability domains
2441 # specified in the spread placement policy attached to the instance.
2442 &quot;hostErrorTimeoutSeconds&quot;: 42, # Specify the time in seconds for host error detection, the value must be
2443 # within the range of [90, 330] with the increment of 30, if unset, the
2444 # default behavior of host error recovery will be used.
2445 &quot;instanceTerminationAction&quot;: &quot;A String&quot;, # Specifies the termination action for the instance.
2446 &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
2447 # recovery of the Local Ssd state is attempted. Its value should be in
2448 # between 0 and 168 hours with hour granularity and the default value being 1
2449 # hour.
2450 # as a count of seconds and fractions of seconds at nanosecond
2451 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
2452 # or &quot;month&quot;. Range is approximately 10,000 years.
2453 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
2454 # Durations less than one second are represented with a 0
2455 # `seconds` field and a positive `nanos` field. Must be from 0
2456 # to 999,999,999 inclusive.
2457 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
2458 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
2459 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
2460 },
2461 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the instance close to other
2462 # resources.
2463 # This field is for use by internal tools that use the public API.
2464 &quot;maxRunDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the max run duration for the given instance. If specified,
2465 # the instance termination action will be performed at the end of the run
2466 # duration.
2467 # as a count of seconds and fractions of seconds at nanosecond
2468 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
2469 # or &quot;month&quot;. Range is approximately 10,000 years.
2470 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
2471 # Durations less than one second are represented with a 0
2472 # `seconds` field and a positive `nanos` field. Must be from 0
2473 # to 999,999,999 inclusive.
2474 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
2475 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
2476 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
2477 },
2478 &quot;minNodeCpus&quot;: 42, # The minimum number of virtual CPUs this instance will consume when running
2479 # on a sole-tenant node.
2480 &quot;nodeAffinities&quot;: [ # A set of node affinity and anti-affinity configurations. Refer toConfiguring node
2481 # affinity for more information.
2482 # Overrides reservationAffinity.
2483 { # Node Affinity: the configuration of desired nodes onto which this Instance
2484 # could be scheduled.
2485 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of Node resource.
2486 &quot;operator&quot;: &quot;A String&quot;, # Defines the operation of node selection. Valid operators areIN for affinity and NOT_IN for anti-affinity.
2487 &quot;values&quot;: [ # Corresponds to the label values of Node resource.
2488 &quot;A String&quot;,
2489 ],
2490 },
2491 ],
2492 &quot;onHostMaintenance&quot;: &quot;A String&quot;, # Defines the maintenance behavior for this instance. For standard instances,
2493 # the default behavior is MIGRATE. Forpreemptible instances,
2494 # the default and only possible behavior is TERMINATE. For more
2495 # information, see
2496 # Set
2497 # VM host maintenance policy.
2498 &quot;onInstanceStopAction&quot;: { # Defines the behaviour for instances with the instance_termination_actionSTOP.
2499 &quot;discardLocalSsd&quot;: True or False, # If true, the contents of any attached Local SSD disks will be discarded
2500 # else, the Local SSD data will be preserved when the instance is stopped
2501 # at the end of the run duration/termination time.
2502 },
2503 &quot;preemptible&quot;: True or False, # Defines whether the instance is preemptible. This can only be set during
2504 # instance creation or while the instance isstopped and
2505 # therefore, in a `TERMINATED` state. SeeInstance Life
2506 # Cycle for more information on the possible instance states.
2507 &quot;provisioningModel&quot;: &quot;A String&quot;, # Specifies the provisioning model of the instance.
2508 &quot;skipGuestOsShutdown&quot;: True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
2509 # Off and ACPI G3 Mechanical
2510 # Off for Standard VMs and 30 seconds for Spot VMs.
2511 &quot;terminationTime&quot;: &quot;A String&quot;, # Specifies the timestamp, when the instance will be terminated, inRFC3339 text format. If specified, the instance
2512 # termination action will be performed at the termination time.
2513 },
2514 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
2515 &quot;serviceAccounts&quot;: [ # A list of service accounts, with their specified scopes, authorized for
2516 # this instance. Only one service account per VM instance is supported.
2517 #
2518 # Service accounts generate access tokens that can be accessed
2519 # through the metadata server and used to authenticate applications on the
2520 # instance. SeeService Accounts
2521 # for more information.
2522 { # A service account.
2523 &quot;email&quot;: &quot;A String&quot;, # Email address of the service account.
2524 &quot;scopes&quot;: [ # The list of scopes to be made available for this service account.
2525 &quot;A String&quot;,
2526 ],
2527 },
2528 ],
2529 &quot;shieldedInstanceConfig&quot;: { # A set of Shielded Instance options.
2530 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.Enabled by
2531 # default.
2532 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.Disabled by
2533 # default.
2534 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.Enabled by
2535 # default.
2536 },
2537 &quot;shieldedInstanceIntegrityPolicy&quot;: { # The policy describes the baseline against which
2538 # Instance boot integrity is measured.
2539 &quot;updateAutoLearnPolicy&quot;: True or False, # Updates the integrity policy baseline using the
2540 # measurements from the VM instance&#x27;s most recent boot.
2541 },
2542 &quot;sourceMachineImage&quot;: &quot;A String&quot;, # Source machine image
2543 &quot;sourceMachineImageEncryptionKey&quot;: { # Source machine image encryption key when creating an instance from a
2544 # machine image.
2545 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
2546 # For example:
2547 #
2548 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2549 # key_region/cryptoKeys/key
2550 #
2551 # The fully-qualifed key name may be returned for resource GET requests. For
2552 # example:
2553 #
2554 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2555 # key_region/cryptoKeys/key
2556 # /cryptoKeyVersions/1
2557 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
2558 # key. If absent, the Compute Engine default service account is used.
2559 # For example:
2560 #
2561 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
2562 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
2563 # encryption key, encoded in RFC
2564 # 4648 base64 to either encrypt or decrypt this resource. You can
2565 # provide either the rawKey or thersaEncryptedKey.
2566 # For example:
2567 #
2568 # &quot;rawKey&quot;:
2569 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
2570 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
2571 # customer-supplied encryption key to either encrypt or decrypt this
2572 # resource. You can provide either the rawKey or thersaEncryptedKey.
2573 # For example:
2574 #
2575 # &quot;rsaEncryptedKey&quot;:
2576 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
2577 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
2578 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
2579 #
2580 # The key must meet the following requirements before you can provide it to
2581 # Compute Engine:
2582 #
2583 # 1. The key is wrapped using a RSA public key certificate provided by
2584 # Google.
2585 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
2586 # encoding.
2587 #
2588 # Gets the RSA public key certificate provided by Google at:
2589 #
2590 #
2591 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
2592 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
2593 # 4648 base64 encoded SHA-256 hash of the customer-supplied
2594 # encryption key that protects this resource.
2595 },
2596 &quot;startRestricted&quot;: True or False, # Output only. [Output Only] Whether a VM has been restricted for start because Compute
2597 # Engine has detected suspicious activity.
2598 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the instance. One of the
2599 # following values: PROVISIONING, STAGING,RUNNING, STOPPING, SUSPENDING,SUSPENDED, REPAIRING, andTERMINATED. For more information about the status of the
2600 # instance, see
2601 # Instance life cycle.
2602 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. [Output Only] An optional, human-readable explanation of the status.
2603 &quot;tags&quot;: { # A set of instance tags. # Tags to apply to this instance. Tags are used to identify valid
2604 # sources or targets for network firewalls and are specified by the client
2605 # during instance creation. The tags can be later modified by the setTags
2606 # method. Each tag within the list must comply withRFC1035.
2607 # Multiple tags can be specified via the &#x27;tags.items&#x27; field.
2608 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
2609 # the tags&#x27; contents and used for optimistic locking. The
2610 # fingerprint is initially generated by Compute Engine and changes after
2611 # every request to modify or update tags. You must always provide an
2612 # up-to-date fingerprint hash in order to update or change tags.
2613 #
2614 # To see the latest fingerprint, make get() request to the
2615 # instance.
2616 &quot;items&quot;: [ # An array of tags. Each tag must be 1-63 characters long, and comply
2617 # with RFC1035.
2618 &quot;A String&quot;,
2619 ],
2620 },
2621 &quot;workloadIdentityConfig&quot;: {
2622 &quot;identity&quot;: &quot;A String&quot;,
2623 &quot;identityCertificateEnabled&quot;: True or False,
2624 },
2625 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the zone where the instance resides.
2626 # You must specify this field as part of the HTTP request URL. It is
2627 # not settable as a field in the request body.
2628 },
2629 ],
2630 &quot;warning&quot;: { # [Output Only] Informational warning which replaces the list of instances
2631 # when the list is empty.
2632 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2633 # Engine returns NO_RESULTS_ON_PAGE if there
2634 # are no results in the response.
2635 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2636 # value format. For example:
2637 #
2638 # &quot;data&quot;: [
2639 # {
2640 # &quot;key&quot;: &quot;scope&quot;,
2641 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2642 # }
2643 {
2644 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2645 # returned. For example, for warnings where there are no results in a list
2646 # request for a particular zone, this key might be scope and
2647 # the key value might be the zone name. Other examples might be a key
2648 # indicating a deprecated resource and a suggested replacement, or a
2649 # warning about invalid network settings (for example, if an instance
2650 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2651 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2652 },
2653 ],
2654 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2655 },
2656 },
2657 },
2658 &quot;kind&quot;: &quot;compute#instanceAggregatedList&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#instanceAggregatedList for aggregated lists of
2659 # Instance resources.
2660 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
2661 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
2662 # the query parameter pageToken in the next list request.
2663 # Subsequent list requests will have their own nextPageToken to
2664 # continue paging through the results.
2665 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
2666 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
2667 &quot;A String&quot;,
2668 ],
2669 &quot;warning&quot;: { # [Output Only] Informational warning message.
2670 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2671 # Engine returns NO_RESULTS_ON_PAGE if there
2672 # are no results in the response.
2673 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2674 # value format. For example:
2675 #
2676 # &quot;data&quot;: [
2677 # {
2678 # &quot;key&quot;: &quot;scope&quot;,
2679 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2680 # }
2681 {
2682 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2683 # returned. For example, for warnings where there are no results in a list
2684 # request for a particular zone, this key might be scope and
2685 # the key value might be the zone name. Other examples might be a key
2686 # indicating a deprecated resource and a suggested replacement, or a
2687 # warning about invalid network settings (for example, if an instance
2688 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2689 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2690 },
2691 ],
2692 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2693 },
2694 }</pre>
2695 </div>
2696
2697 <div class="method">
2698 <code class="details" id="aggregatedList_next">aggregatedList_next()</code>
2699 <pre>Retrieves the next page of results.
2700
2701 Args:
2702 previous_request: The request for the previous page. (required)
2703 previous_response: The response from the request for the previous page. (required)
2704
2705 Returns:
2706 A request object that you can call &#x27;execute()&#x27; on to request the next
2707 page. Returns None if there are no more items in the collection.
2708 </pre>
2709 </div>
2710
2711 <div class="method">
2712 <code class="details" id="attachDisk">attachDisk(project, zone, instance, body=None, forceAttach=None, requestId=None, x__xgafv=None)</code>
2713 <pre>Attaches an existing Disk resource to an instance. You must first
2714 create the disk before you can attach it. It is not possible to create
2715 and attach a disk at the same time. For more information, readAdding a
2716 persistent disk to your instance.
2717
2718 Args:
2719 project: string, Project ID for this request. (required)
2720 zone: string, The name of the zone for this request. (required)
2721 instance: string, The instance name for this request. (required)
2722 body: object, The request body.
2723 The object takes the form of:
2724
2725 { # An instance-attached disk resource.
2726 &quot;architecture&quot;: &quot;A String&quot;, # Output only. [Output Only] The architecture of the attached disk. Valid values are ARM64
2727 # or X86_64.
2728 &quot;autoDelete&quot;: True or False, # Specifies whether the disk will be auto-deleted when the instance is
2729 # deleted (but not when the disk is detached from the instance).
2730 &quot;boot&quot;: True or False, # Indicates that this is a boot disk. The virtual machine will use the first
2731 # partition of the disk for its root filesystem.
2732 &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
2733 # running within the instance. This name can be used to reference the device
2734 # for mounting, resizing, and so on, from within the instance.
2735 #
2736 # If not specified, the server chooses a default device name to apply to this
2737 # disk, in the form persistent-disk-x, where x is a number
2738 # assigned by Google Compute Engine. This field is only applicable for
2739 # persistent disks.
2740 &quot;diskEncryptionKey&quot;: { # Encrypts or decrypts a disk using acustomer-supplied
2741 # encryption key.
2742 #
2743 # If you are creating a new disk, this field encrypts the new disk using
2744 # an encryption key that you provide. If you are attaching an existing
2745 # disk that is already encrypted, this field decrypts the disk using
2746 # the customer-supplied encryption key.
2747 #
2748 # If you encrypt a disk using a customer-supplied key, you must provide the
2749 # same key again when you attempt to use this resource at a later time. For
2750 # example, you must provide the key when you create a snapshot or an image
2751 # from the disk or when you attach the disk to a virtual machine instance.
2752 #
2753 # If you do not provide an encryption key, then the disk will be encrypted
2754 # using an automatically generated key and you do not need to provide a key
2755 # to use the disk later.
2756 #
2757 # Note:
2758 #
2759 # Instance templates do not storecustomer-supplied
2760 # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
2761 #
2762 # You cannot create VMs that have disks with customer-supplied keys using
2763 # the bulk
2764 # insert method.
2765 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
2766 # For example:
2767 #
2768 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2769 # key_region/cryptoKeys/key
2770 #
2771 # The fully-qualifed key name may be returned for resource GET requests. For
2772 # example:
2773 #
2774 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2775 # key_region/cryptoKeys/key
2776 # /cryptoKeyVersions/1
2777 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
2778 # key. If absent, the Compute Engine default service account is used.
2779 # For example:
2780 #
2781 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
2782 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
2783 # encryption key, encoded in RFC
2784 # 4648 base64 to either encrypt or decrypt this resource. You can
2785 # provide either the rawKey or thersaEncryptedKey.
2786 # For example:
2787 #
2788 # &quot;rawKey&quot;:
2789 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
2790 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
2791 # customer-supplied encryption key to either encrypt or decrypt this
2792 # resource. You can provide either the rawKey or thersaEncryptedKey.
2793 # For example:
2794 #
2795 # &quot;rsaEncryptedKey&quot;:
2796 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
2797 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
2798 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
2799 #
2800 # The key must meet the following requirements before you can provide it to
2801 # Compute Engine:
2802 #
2803 # 1. The key is wrapped using a RSA public key certificate provided by
2804 # Google.
2805 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
2806 # encoding.
2807 #
2808 # Gets the RSA public key certificate provided by Google at:
2809 #
2810 #
2811 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
2812 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
2813 # 4648 base64 encoded SHA-256 hash of the customer-supplied
2814 # encryption key that protects this resource.
2815 },
2816 &quot;diskSizeGb&quot;: &quot;A String&quot;, # The size of the disk in GB.
2817 &quot;forceAttach&quot;: True or False, # [Input Only] Whether to force attach the regional disk even if it&#x27;s
2818 # currently attached to another instance. If you try to force attach a zonal
2819 # disk to an instance, you will receive an error.
2820 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
2821 # only for bootable images. Read
2822 # Enabling guest operating system features to see a list of available
2823 # options.
2824 { # Guest OS features.
2825 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
2826 # separate values. Set to one or more of the following values:
2827 #
2828 # - VIRTIO_SCSI_MULTIQUEUE
2829 # - WINDOWS
2830 # - MULTI_IP_SUBNET
2831 # - UEFI_COMPATIBLE
2832 # - GVNIC
2833 # - SEV_CAPABLE
2834 # - SUSPEND_RESUME_COMPATIBLE
2835 # - SEV_LIVE_MIGRATABLE_V2
2836 # - SEV_SNP_CAPABLE
2837 # - TDX_CAPABLE
2838 # - IDPF
2839 # - SNP_SVSM_CAPABLE
2840 # - CCA_CAPABLE
2841 #
2842 #
2843 # For more information, see
2844 # Enabling guest operating system features.
2845 },
2846 ],
2847 &quot;index&quot;: 42, # Output only. [Output Only] A zero-based index to this disk, where 0 is reserved for the
2848 # boot disk. If you have many disks attached to an instance, each
2849 # disk would have a unique index number.
2850 &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
2851 # alongside the new instance. Use initialization parameters to create boot
2852 # disks or local SSDs attached to the new instance.
2853 #
2854 # This property is mutually exclusive with the source property;
2855 # you can only define one or the other, but not both.
2856 # alongside the new instance. Use initialization parameters to create boot
2857 # disks or local SSDs attached to the new instance.
2858 #
2859 # This field is persisted and returned for instanceTemplate and not returned
2860 # in the context of instance.
2861 #
2862 # This property is mutually exclusive with the source property;
2863 # you can only define one or the other, but not both.
2864 &quot;architecture&quot;: &quot;A String&quot;, # The architecture of the attached disk. Valid values are
2865 # arm64 or x86_64.
2866 &quot;description&quot;: &quot;A String&quot;, # An optional description. Provide this property when creating the disk.
2867 &quot;diskName&quot;: &quot;A String&quot;, # Specifies the disk name. If not specified, the default is to use the name
2868 # of the instance. If a disk with the same name already exists in the given
2869 # region, the existing disk is attached to the new instance and the
2870 # new disk is not created.
2871 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB. The size must be at least
2872 # 10 GB. If you specify a sourceImage, which is required for
2873 # boot disks, the default size is the size of the sourceImage.
2874 # If you do not specify a sourceImage, the default disk size
2875 # is 500 GB.
2876 &quot;diskType&quot;: &quot;A String&quot;,
2877 &quot;enableConfidentialCompute&quot;: True or False, # Whether this disk is using confidential compute mode.
2878 &quot;labels&quot;: { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
2879 # persistent disks.
2880 &quot;a_key&quot;: &quot;A String&quot;,
2881 },
2882 &quot;licenses&quot;: [ # A list of publicly visible licenses. Reserved for Google&#x27;s use.
2883 &quot;A String&quot;,
2884 ],
2885 &quot;onUpdateAction&quot;: &quot;A String&quot;, # Specifies which action to take on instance update with this disk. Default
2886 # is to use the existing disk.
2887 &quot;provisionedIops&quot;: &quot;A String&quot;, # Indicates how many IOPS to provision for the disk. This sets the number
2888 # of I/O operations per second that the disk can handle. Values must be
2889 # between 10,000 and 120,000. For more details, see theExtreme persistent
2890 # disk documentation.
2891 &quot;provisionedThroughput&quot;: &quot;A String&quot;, # Indicates how much throughput to provision for the disk. This sets the
2892 # number of throughput mb per second that the disk can handle. Values must
2893 # greater than or equal to 1.
2894 &quot;replicaZones&quot;: [ # Required for each regional disk associated with the instance. Specify
2895 # the URLs of the zones where the disk should be replicated to.
2896 # You must provide exactly two replica zones, and one zone must be the same
2897 # as the instance zone.
2898 &quot;A String&quot;,
2899 ],
2900 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
2901 # have the same definition as resource
2902 # manager tags. Keys and values can be either in numeric format,
2903 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
2904 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
2905 # `{tag_value_short_name}`. The field is ignored (both PUT &amp; PATCH) when
2906 # empty.
2907 &quot;a_key&quot;: &quot;A String&quot;,
2908 },
2909 &quot;resourcePolicies&quot;: [ # Resource policies applied to this disk for automatic snapshot creations.
2910 # Specified using the full or partial URL. For instance template, specify
2911 # only the resource policy name.
2912 &quot;A String&quot;,
2913 ],
2914 &quot;sourceImage&quot;: &quot;A String&quot;, # The source image to create this disk. When creating a new instance boot
2915 # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
2916 # is required.
2917 #
2918 # To create a disk with one of the public operating system
2919 # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
2920 #
2921 # projects/debian-cloud/global/images/family/debian-9
2922 #
2923 #
2924 # Alternatively, use a specific version of a public operating system image:
2925 #
2926 # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
2927 #
2928 #
2929 # To create a disk with a custom image that you created, specify the
2930 # image name in the following format:
2931 #
2932 # global/images/my-custom-image
2933 #
2934 #
2935 # You can also specify a custom image by its image family, which returns
2936 # the latest version of the image in that family. Replace the image name
2937 # with family/family-name:
2938 #
2939 # global/images/family/my-image-family
2940 #
2941 #
2942 # If the source image is deleted later, this field will not be set.
2943 &quot;sourceImageEncryptionKey&quot;: { # Thecustomer-supplied
2944 # encryption key of the source image. Required if the source image is
2945 # protected by a customer-supplied encryption key.
2946 #
2947 # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
2948 # encryption keys, so you cannot create disks for instances in a managed instance group if the
2949 # source images are encrypted with your own keys.
2950 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
2951 # For example:
2952 #
2953 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2954 # key_region/cryptoKeys/key
2955 #
2956 # The fully-qualifed key name may be returned for resource GET requests. For
2957 # example:
2958 #
2959 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2960 # key_region/cryptoKeys/key
2961 # /cryptoKeyVersions/1
2962 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
2963 # key. If absent, the Compute Engine default service account is used.
2964 # For example:
2965 #
2966 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
2967 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
2968 # encryption key, encoded in RFC
2969 # 4648 base64 to either encrypt or decrypt this resource. You can
2970 # provide either the rawKey or thersaEncryptedKey.
2971 # For example:
2972 #
2973 # &quot;rawKey&quot;:
2974 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
2975 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
2976 # customer-supplied encryption key to either encrypt or decrypt this
2977 # resource. You can provide either the rawKey or thersaEncryptedKey.
2978 # For example:
2979 #
2980 # &quot;rsaEncryptedKey&quot;:
2981 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
2982 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
2983 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
2984 #
2985 # The key must meet the following requirements before you can provide it to
2986 # Compute Engine:
2987 #
2988 # 1. The key is wrapped using a RSA public key certificate provided by
2989 # Google.
2990 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
2991 # encoding.
2992 #
2993 # Gets the RSA public key certificate provided by Google at:
2994 #
2995 #
2996 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
2997 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
2998 # 4648 base64 encoded SHA-256 hash of the customer-supplied
2999 # encryption key that protects this resource.
3000 },
3001 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # The source snapshot to create this disk. When creating a new instance
3002 # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
3003 # is required.
3004 #
3005 # To create a disk with a snapshot that you created, specify the
3006 # snapshot name in the following format:
3007 #
3008 # global/snapshots/my-backup
3009 #
3010 #
3011 # If the source snapshot is deleted later, this field will not be set.
3012 #
3013 # Note: You cannot create VMs in bulk using a snapshot as the source. Use
3014 # an image instead when you create VMs using
3015 # the bulk
3016 # insert method.
3017 &quot;sourceSnapshotEncryptionKey&quot;: { # Thecustomer-supplied
3018 # encryption key of the source snapshot.
3019 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
3020 # For example:
3021 #
3022 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3023 # key_region/cryptoKeys/key
3024 #
3025 # The fully-qualifed key name may be returned for resource GET requests. For
3026 # example:
3027 #
3028 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3029 # key_region/cryptoKeys/key
3030 # /cryptoKeyVersions/1
3031 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
3032 # key. If absent, the Compute Engine default service account is used.
3033 # For example:
3034 #
3035 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
3036 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
3037 # encryption key, encoded in RFC
3038 # 4648 base64 to either encrypt or decrypt this resource. You can
3039 # provide either the rawKey or thersaEncryptedKey.
3040 # For example:
3041 #
3042 # &quot;rawKey&quot;:
3043 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
3044 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
3045 # customer-supplied encryption key to either encrypt or decrypt this
3046 # resource. You can provide either the rawKey or thersaEncryptedKey.
3047 # For example:
3048 #
3049 # &quot;rsaEncryptedKey&quot;:
3050 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
3051 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
3052 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
3053 #
3054 # The key must meet the following requirements before you can provide it to
3055 # Compute Engine:
3056 #
3057 # 1. The key is wrapped using a RSA public key certificate provided by
3058 # Google.
3059 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
3060 # encoding.
3061 #
3062 # Gets the RSA public key certificate provided by Google at:
3063 #
3064 #
3065 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
3066 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
3067 # 4648 base64 encoded SHA-256 hash of the customer-supplied
3068 # encryption key that protects this resource.
3069 },
3070 &quot;storagePool&quot;: &quot;A String&quot;, # The storage pool in which the new disk is created. You can provide
3071 # this as a partial or full URL to the resource. For example, the following
3072 # are valid values:
3073 #
3074 #
3075 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
3076 # - projects/project/zones/zone/storagePools/storagePool
3077 # - zones/zone/storagePools/storagePool
3078 },
3079 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is
3080 # either SCSI or NVME. For most machine types, the
3081 # default is SCSI. Local SSDs can use either NVME or SCSI.
3082 # In certain configurations, persistent disks can use NVMe. For more
3083 # information, seeAbout
3084 # persistent disks.
3085 &quot;kind&quot;: &quot;compute#attachedDisk&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
3086 &quot;licenses&quot;: [ # Output only. [Output Only] Any valid publicly visible licenses.
3087 &quot;A String&quot;,
3088 ],
3089 &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
3090 # in READ_WRITE mode.
3091 &quot;savedState&quot;: &quot;A String&quot;, # Output only. For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
3092 # field is set to PRESERVED if the LocalSSD data has been saved
3093 # to a persistent location by customer request. (see the
3094 # discard_local_ssd option on Stop/Suspend).
3095 # Read-only in the api.
3096 &quot;shieldedInstanceInitialState&quot;: { # Initial State for shielded instance, # Output only. [Output Only] shielded vm initial state stored on disk
3097 # these are public keys which are safe to store in public
3098 &quot;dbs&quot;: [ # The Key Database (db).
3099 {
3100 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
3101 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
3102 },
3103 ],
3104 &quot;dbxs&quot;: [ # The forbidden key database (dbx).
3105 {
3106 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
3107 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
3108 },
3109 ],
3110 &quot;keks&quot;: [ # The Key Exchange Key (KEK).
3111 {
3112 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
3113 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
3114 },
3115 ],
3116 &quot;pk&quot;: { # The Platform Key (PK).
3117 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
3118 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
3119 },
3120 },
3121 &quot;source&quot;: &quot;A String&quot;, # Specifies a valid partial or full URL to an existing Persistent Disk
3122 # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
3123 # is required.
3124 #
3125 # If desired, you can also attach existing non-root persistent disks using
3126 # this property. This field is only applicable for persistent disks.
3127 #
3128 # Note that for InstanceTemplate, specify the disk name for zonal disk,
3129 # and the URL for regional disk.
3130 &quot;type&quot;: &quot;A String&quot;, # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
3131 }
3132
3133 forceAttach: boolean, Whether to force attach the regional disk even if it&#x27;s currently attached
3134 to another instance. If you try to force attach a zonal disk to an
3135 instance, you will receive an error.
3136 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
3137 that if you must retry your request, the server will know to ignore the
3138 request if it has already been completed.
3139
3140 For example, consider a situation where you make an initial request and
3141 the request times out. If you make the request again with the same
3142 request ID, the server can check if original operation with the same
3143 request ID was received, and if so, will ignore the second request. This
3144 prevents clients from accidentally creating duplicate commitments.
3145
3146 The request ID must be
3147 a valid UUID with the exception that zero UUID is not supported
3148 (00000000-0000-0000-0000-000000000000).
3149 x__xgafv: string, V1 error format.
3150 Allowed values
3151 1 - v1 error format
3152 2 - v2 error format
3153
3154 Returns:
3155 An object of the form:
3156
3157 { # Represents an Operation resource.
3158 #
3159 # Google Compute Engine has three Operation resources:
3160 #
3161 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
3162 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
3163 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
3164 #
3165 # You can use an operation resource to manage asynchronous API requests.
3166 # For more information, readHandling
3167 # API responses.
3168 #
3169 # Operations can be global, regional or zonal.
3170 #
3171 # - For global operations, use the `globalOperations`
3172 # resource.
3173 # - For regional operations, use the
3174 # `regionOperations` resource.
3175 # - For zonal operations, use
3176 # the `zoneOperations` resource.
3177 #
3178 #
3179 #
3180 # For more information, read
3181 # Global, Regional, and Zonal Resources.
3182 #
3183 # Note that completed Operation resources have a limited
3184 # retention period.
3185 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
3186 # Not present otherwise.
3187 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
3188 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
3189 # set when the operation is created.
3190 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
3191 # text format.
3192 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
3193 # this field will be populated.
3194 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
3195 # operation.
3196 {
3197 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
3198 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
3199 # details. There is a set of defined message types to use for providing
3200 # details.The syntax depends on the error code. For example,
3201 # QuotaExceededInfo will have details when the error code is
3202 # QUOTA_EXCEEDED.
3203 {
3204 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
3205 #
3206 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
3207 # is not enabled:
3208 #
3209 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
3210 # &quot;domain&quot;: &quot;googleapis.com&quot;
3211 # &quot;metadata&quot;: {
3212 # &quot;resource&quot;: &quot;projects/123&quot;,
3213 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
3214 # }
3215 # }
3216 #
3217 # This response indicates that the pubsub.googleapis.com API is not enabled.
3218 #
3219 # Example of an error that is returned when attempting to create a Spanner
3220 # instance in a region that is out of stock:
3221 #
3222 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
3223 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
3224 # &quot;metadata&quot;: {
3225 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
3226 # }
3227 # }
3228 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
3229 # is typically the registered service name of the tool or product that
3230 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
3231 # generated by some common infrastructure, the error domain must be a
3232 # globally unique value that identifies the infrastructure. For Google API
3233 # infrastructure, the error domain is &quot;googleapis.com&quot;.
3234 &quot;metadatas&quot;: { # Additional structured details about this error.
3235 #
3236 # Keys must match a regular expression of `a-z+` but should
3237 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
3238 # length. When identifying the current value of an exceeded limit, the units
3239 # should be contained in the key, not the value. For example, rather than
3240 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
3241 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
3242 # instances that can be created in a single (batch) request.
3243 &quot;a_key&quot;: &quot;A String&quot;,
3244 },
3245 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
3246 # proximate cause of the error. Error reasons are unique within a particular
3247 # domain of errors. This should be at most 63 characters and match a
3248 # regular expression of `A-Z+[A-Z0-9]`, which represents
3249 # UPPER_SNAKE_CASE.
3250 },
3251 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
3252 #
3253 # For example, if a quota check failed with an error indicating the calling
3254 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
3255 # directly to the right place in the developer console to flip the bit.
3256 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
3257 { # Describes a URL link.
3258 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
3259 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
3260 },
3261 ],
3262 },
3263 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
3264 # which can be attached to an RPC error.
3265 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
3266 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
3267 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
3268 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
3269 },
3270 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
3271 &quot;dimensions&quot;: { # The map holding related quota dimensions.
3272 &quot;a_key&quot;: &quot;A String&quot;,
3273 },
3274 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
3275 # type or metric.
3276 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
3277 # or metric.
3278 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
3279 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
3280 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
3281 },
3282 },
3283 ],
3284 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
3285 # This property is optional.
3286 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
3287 },
3288 ],
3289 },
3290 &quot;getVersionOperationMetadata&quot;: {
3291 &quot;inlineSbomInfo&quot;: {
3292 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
3293 # appropriate identifiers.
3294 &quot;a_key&quot;: &quot;A String&quot;,
3295 },
3296 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
3297 # identifiers.
3298 &quot;a_key&quot;: &quot;A String&quot;,
3299 },
3300 },
3301 },
3302 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
3303 # message that was returned, such as `NOT FOUND`.
3304 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
3305 # status code that was returned. For example, a `404` means the
3306 # resource was not found.
3307 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
3308 # defined by the server.
3309 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
3310 # This value is inRFC3339
3311 # text format.
3312 &quot;instancesBulkInsertOperationMetadata&quot;: {
3313 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
3314 # Example key: zones/us-central1-a
3315 &quot;a_key&quot;: {
3316 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
3317 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
3318 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
3319 # error.
3320 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
3321 # if the flow is rolling forward or rolling back.
3322 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
3323 },
3324 },
3325 },
3326 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
3327 # Operation resources.
3328 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
3329 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
3330 # group of operations results from a `bulkInsert` API request.
3331 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
3332 # `update`, or `delete`, and so on.
3333 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
3334 # There is no requirement that this be linear or support any granularity of
3335 # operations. This should not be used to guess when the operation will be
3336 # complete. This number should monotonically increase as the operation
3337 # progresses.
3338 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
3339 # applicable when performing regional operations.
3340 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
3341 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
3342 # this field will contain information on all underlying zonal actions and
3343 # their state.
3344 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
3345 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
3346 # Example key: zones/us-central1-a
3347 &quot;a_key&quot;: {
3348 &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
3349 # populated.
3350 # different programming environments, including REST APIs and RPC APIs. It is
3351 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
3352 # three pieces of data: error code, error message, and error details.
3353 #
3354 # You can find out more about this error model and how to work with it in the
3355 # [API Design Guide](https://cloud.google.com/apis/design/errors).
3356 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
3357 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
3358 # message types for APIs to use.
3359 {
3360 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
3361 },
3362 ],
3363 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
3364 # user-facing error message should be localized and sent in the
3365 # google.rpc.Status.details field, or localized by the client.
3366 },
3367 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
3368 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
3369 },
3370 },
3371 },
3372 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
3373 # This value is inRFC3339
3374 # text format.
3375 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
3376 # following:
3377 # `PENDING`, `RUNNING`, or `DONE`.
3378 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
3379 # operation.
3380 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
3381 # of the target resource.
3382 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
3383 # operations related to creating a snapshot, this points to the disk
3384 # that the snapshot was created from.
3385 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
3386 # `[email protected]` or
3387 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
3388 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
3389 # operation, this field will be populated.
3390 {
3391 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
3392 # Engine returns NO_RESULTS_ON_PAGE if there
3393 # are no results in the response.
3394 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
3395 # value format. For example:
3396 #
3397 # &quot;data&quot;: [
3398 # {
3399 # &quot;key&quot;: &quot;scope&quot;,
3400 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
3401 # }
3402 {
3403 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
3404 # returned. For example, for warnings where there are no results in a list
3405 # request for a particular zone, this key might be scope and
3406 # the key value might be the zone name. Other examples might be a key
3407 # indicating a deprecated resource and a suggested replacement, or a
3408 # warning about invalid network settings (for example, if an instance
3409 # attempts to perform IP forwarding but is not enabled for IP forwarding).
3410 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
3411 },
3412 ],
3413 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
3414 },
3415 ],
3416 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
3417 # applicable when performing per-zone operations.
3418 }</pre>
3419 </div>
3420
3421 <div class="method">
3422 <code class="details" id="bulkInsert">bulkInsert(project, zone, body=None, requestId=None, x__xgafv=None)</code>
3423 <pre>Creates multiple instances. Count specifies the number of instances to
3424 create. For more information, seeAbout bulk
3425 creation of VMs.
3426
3427 Args:
3428 project: string, Project ID for this request. (required)
3429 zone: string, The name of the zone for this request. (required)
3430 body: object, The request body.
3431 The object takes the form of:
3432
3433 { # A transient resource used in compute.instances.bulkInsert and
3434 # compute.regionInstances.bulkInsert . This resource is not persisted
3435 # anywhere, it is used only for processing the requests.
3436 &quot;count&quot;: &quot;A String&quot;, # The maximum number of instances to create.
3437 &quot;instanceFlexibilityPolicy&quot;: { # A flexible specification of machine types for instances to create. # A flexible specification of machine type of instances to create.
3438 &quot;instanceSelections&quot;: { # Specification of alternative, flexible instance subsets.
3439 # One of them will be selected to create the instances
3440 # based on various criteria, like:
3441 # - ranks,
3442 # - location policy,
3443 # - current capacity,
3444 # - available reservations (you can specify affinity in
3445 # InstanceProperties),
3446 # - SWAN/GOOSE limitations.
3447 # Key is an arbitrary, unique RFC1035 string that identifies the instance
3448 # selection.
3449 &quot;a_key&quot;: { # Specification of machine type to use. Every position inside this message
3450 # is an alternative.
3451 # The count specified in the shape flexibility must not exceed the number
3452 # of entries in per_instance_properties or the capacity of the
3453 # name_pattern, if used.
3454 &quot;disks&quot;: [ # Disks to be attached to the instances created from in this selection.
3455 # They override the disks specified in the instance properties.
3456 { # An instance-attached disk resource.
3457 &quot;architecture&quot;: &quot;A String&quot;, # Output only. [Output Only] The architecture of the attached disk. Valid values are ARM64
3458 # or X86_64.
3459 &quot;autoDelete&quot;: True or False, # Specifies whether the disk will be auto-deleted when the instance is
3460 # deleted (but not when the disk is detached from the instance).
3461 &quot;boot&quot;: True or False, # Indicates that this is a boot disk. The virtual machine will use the first
3462 # partition of the disk for its root filesystem.
3463 &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
3464 # running within the instance. This name can be used to reference the device
3465 # for mounting, resizing, and so on, from within the instance.
3466 #
3467 # If not specified, the server chooses a default device name to apply to this
3468 # disk, in the form persistent-disk-x, where x is a number
3469 # assigned by Google Compute Engine. This field is only applicable for
3470 # persistent disks.
3471 &quot;diskEncryptionKey&quot;: { # Encrypts or decrypts a disk using acustomer-supplied
3472 # encryption key.
3473 #
3474 # If you are creating a new disk, this field encrypts the new disk using
3475 # an encryption key that you provide. If you are attaching an existing
3476 # disk that is already encrypted, this field decrypts the disk using
3477 # the customer-supplied encryption key.
3478 #
3479 # If you encrypt a disk using a customer-supplied key, you must provide the
3480 # same key again when you attempt to use this resource at a later time. For
3481 # example, you must provide the key when you create a snapshot or an image
3482 # from the disk or when you attach the disk to a virtual machine instance.
3483 #
3484 # If you do not provide an encryption key, then the disk will be encrypted
3485 # using an automatically generated key and you do not need to provide a key
3486 # to use the disk later.
3487 #
3488 # Note:
3489 #
3490 # Instance templates do not storecustomer-supplied
3491 # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
3492 #
3493 # You cannot create VMs that have disks with customer-supplied keys using
3494 # the bulk
3495 # insert method.
3496 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
3497 # For example:
3498 #
3499 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3500 # key_region/cryptoKeys/key
3501 #
3502 # The fully-qualifed key name may be returned for resource GET requests. For
3503 # example:
3504 #
3505 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3506 # key_region/cryptoKeys/key
3507 # /cryptoKeyVersions/1
3508 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
3509 # key. If absent, the Compute Engine default service account is used.
3510 # For example:
3511 #
3512 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
3513 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
3514 # encryption key, encoded in RFC
3515 # 4648 base64 to either encrypt or decrypt this resource. You can
3516 # provide either the rawKey or thersaEncryptedKey.
3517 # For example:
3518 #
3519 # &quot;rawKey&quot;:
3520 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
3521 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
3522 # customer-supplied encryption key to either encrypt or decrypt this
3523 # resource. You can provide either the rawKey or thersaEncryptedKey.
3524 # For example:
3525 #
3526 # &quot;rsaEncryptedKey&quot;:
3527 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
3528 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
3529 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
3530 #
3531 # The key must meet the following requirements before you can provide it to
3532 # Compute Engine:
3533 #
3534 # 1. The key is wrapped using a RSA public key certificate provided by
3535 # Google.
3536 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
3537 # encoding.
3538 #
3539 # Gets the RSA public key certificate provided by Google at:
3540 #
3541 #
3542 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
3543 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
3544 # 4648 base64 encoded SHA-256 hash of the customer-supplied
3545 # encryption key that protects this resource.
3546 },
3547 &quot;diskSizeGb&quot;: &quot;A String&quot;, # The size of the disk in GB.
3548 &quot;forceAttach&quot;: True or False, # [Input Only] Whether to force attach the regional disk even if it&#x27;s
3549 # currently attached to another instance. If you try to force attach a zonal
3550 # disk to an instance, you will receive an error.
3551 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
3552 # only for bootable images. Read
3553 # Enabling guest operating system features to see a list of available
3554 # options.
3555 { # Guest OS features.
3556 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
3557 # separate values. Set to one or more of the following values:
3558 #
3559 # - VIRTIO_SCSI_MULTIQUEUE
3560 # - WINDOWS
3561 # - MULTI_IP_SUBNET
3562 # - UEFI_COMPATIBLE
3563 # - GVNIC
3564 # - SEV_CAPABLE
3565 # - SUSPEND_RESUME_COMPATIBLE
3566 # - SEV_LIVE_MIGRATABLE_V2
3567 # - SEV_SNP_CAPABLE
3568 # - TDX_CAPABLE
3569 # - IDPF
3570 # - SNP_SVSM_CAPABLE
3571 # - CCA_CAPABLE
3572 #
3573 #
3574 # For more information, see
3575 # Enabling guest operating system features.
3576 },
3577 ],
3578 &quot;index&quot;: 42, # Output only. [Output Only] A zero-based index to this disk, where 0 is reserved for the
3579 # boot disk. If you have many disks attached to an instance, each
3580 # disk would have a unique index number.
3581 &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
3582 # alongside the new instance. Use initialization parameters to create boot
3583 # disks or local SSDs attached to the new instance.
3584 #
3585 # This property is mutually exclusive with the source property;
3586 # you can only define one or the other, but not both.
3587 # alongside the new instance. Use initialization parameters to create boot
3588 # disks or local SSDs attached to the new instance.
3589 #
3590 # This field is persisted and returned for instanceTemplate and not returned
3591 # in the context of instance.
3592 #
3593 # This property is mutually exclusive with the source property;
3594 # you can only define one or the other, but not both.
3595 &quot;architecture&quot;: &quot;A String&quot;, # The architecture of the attached disk. Valid values are
3596 # arm64 or x86_64.
3597 &quot;description&quot;: &quot;A String&quot;, # An optional description. Provide this property when creating the disk.
3598 &quot;diskName&quot;: &quot;A String&quot;, # Specifies the disk name. If not specified, the default is to use the name
3599 # of the instance. If a disk with the same name already exists in the given
3600 # region, the existing disk is attached to the new instance and the
3601 # new disk is not created.
3602 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB. The size must be at least
3603 # 10 GB. If you specify a sourceImage, which is required for
3604 # boot disks, the default size is the size of the sourceImage.
3605 # If you do not specify a sourceImage, the default disk size
3606 # is 500 GB.
3607 &quot;diskType&quot;: &quot;A String&quot;,
3608 &quot;enableConfidentialCompute&quot;: True or False, # Whether this disk is using confidential compute mode.
3609 &quot;labels&quot;: { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
3610 # persistent disks.
3611 &quot;a_key&quot;: &quot;A String&quot;,
3612 },
3613 &quot;licenses&quot;: [ # A list of publicly visible licenses. Reserved for Google&#x27;s use.
3614 &quot;A String&quot;,
3615 ],
3616 &quot;onUpdateAction&quot;: &quot;A String&quot;, # Specifies which action to take on instance update with this disk. Default
3617 # is to use the existing disk.
3618 &quot;provisionedIops&quot;: &quot;A String&quot;, # Indicates how many IOPS to provision for the disk. This sets the number
3619 # of I/O operations per second that the disk can handle. Values must be
3620 # between 10,000 and 120,000. For more details, see theExtreme persistent
3621 # disk documentation.
3622 &quot;provisionedThroughput&quot;: &quot;A String&quot;, # Indicates how much throughput to provision for the disk. This sets the
3623 # number of throughput mb per second that the disk can handle. Values must
3624 # greater than or equal to 1.
3625 &quot;replicaZones&quot;: [ # Required for each regional disk associated with the instance. Specify
3626 # the URLs of the zones where the disk should be replicated to.
3627 # You must provide exactly two replica zones, and one zone must be the same
3628 # as the instance zone.
3629 &quot;A String&quot;,
3630 ],
3631 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
3632 # have the same definition as resource
3633 # manager tags. Keys and values can be either in numeric format,
3634 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
3635 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
3636 # `{tag_value_short_name}`. The field is ignored (both PUT &amp; PATCH) when
3637 # empty.
3638 &quot;a_key&quot;: &quot;A String&quot;,
3639 },
3640 &quot;resourcePolicies&quot;: [ # Resource policies applied to this disk for automatic snapshot creations.
3641 # Specified using the full or partial URL. For instance template, specify
3642 # only the resource policy name.
3643 &quot;A String&quot;,
3644 ],
3645 &quot;sourceImage&quot;: &quot;A String&quot;, # The source image to create this disk. When creating a new instance boot
3646 # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
3647 # is required.
3648 #
3649 # To create a disk with one of the public operating system
3650 # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
3651 #
3652 # projects/debian-cloud/global/images/family/debian-9
3653 #
3654 #
3655 # Alternatively, use a specific version of a public operating system image:
3656 #
3657 # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
3658 #
3659 #
3660 # To create a disk with a custom image that you created, specify the
3661 # image name in the following format:
3662 #
3663 # global/images/my-custom-image
3664 #
3665 #
3666 # You can also specify a custom image by its image family, which returns
3667 # the latest version of the image in that family. Replace the image name
3668 # with family/family-name:
3669 #
3670 # global/images/family/my-image-family
3671 #
3672 #
3673 # If the source image is deleted later, this field will not be set.
3674 &quot;sourceImageEncryptionKey&quot;: { # Thecustomer-supplied
3675 # encryption key of the source image. Required if the source image is
3676 # protected by a customer-supplied encryption key.
3677 #
3678 # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
3679 # encryption keys, so you cannot create disks for instances in a managed instance group if the
3680 # source images are encrypted with your own keys.
3681 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
3682 # For example:
3683 #
3684 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3685 # key_region/cryptoKeys/key
3686 #
3687 # The fully-qualifed key name may be returned for resource GET requests. For
3688 # example:
3689 #
3690 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3691 # key_region/cryptoKeys/key
3692 # /cryptoKeyVersions/1
3693 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
3694 # key. If absent, the Compute Engine default service account is used.
3695 # For example:
3696 #
3697 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
3698 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
3699 # encryption key, encoded in RFC
3700 # 4648 base64 to either encrypt or decrypt this resource. You can
3701 # provide either the rawKey or thersaEncryptedKey.
3702 # For example:
3703 #
3704 # &quot;rawKey&quot;:
3705 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
3706 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
3707 # customer-supplied encryption key to either encrypt or decrypt this
3708 # resource. You can provide either the rawKey or thersaEncryptedKey.
3709 # For example:
3710 #
3711 # &quot;rsaEncryptedKey&quot;:
3712 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
3713 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
3714 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
3715 #
3716 # The key must meet the following requirements before you can provide it to
3717 # Compute Engine:
3718 #
3719 # 1. The key is wrapped using a RSA public key certificate provided by
3720 # Google.
3721 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
3722 # encoding.
3723 #
3724 # Gets the RSA public key certificate provided by Google at:
3725 #
3726 #
3727 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
3728 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
3729 # 4648 base64 encoded SHA-256 hash of the customer-supplied
3730 # encryption key that protects this resource.
3731 },
3732 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # The source snapshot to create this disk. When creating a new instance
3733 # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
3734 # is required.
3735 #
3736 # To create a disk with a snapshot that you created, specify the
3737 # snapshot name in the following format:
3738 #
3739 # global/snapshots/my-backup
3740 #
3741 #
3742 # If the source snapshot is deleted later, this field will not be set.
3743 #
3744 # Note: You cannot create VMs in bulk using a snapshot as the source. Use
3745 # an image instead when you create VMs using
3746 # the bulk
3747 # insert method.
3748 &quot;sourceSnapshotEncryptionKey&quot;: { # Thecustomer-supplied
3749 # encryption key of the source snapshot.
3750 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
3751 # For example:
3752 #
3753 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3754 # key_region/cryptoKeys/key
3755 #
3756 # The fully-qualifed key name may be returned for resource GET requests. For
3757 # example:
3758 #
3759 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3760 # key_region/cryptoKeys/key
3761 # /cryptoKeyVersions/1
3762 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
3763 # key. If absent, the Compute Engine default service account is used.
3764 # For example:
3765 #
3766 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
3767 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
3768 # encryption key, encoded in RFC
3769 # 4648 base64 to either encrypt or decrypt this resource. You can
3770 # provide either the rawKey or thersaEncryptedKey.
3771 # For example:
3772 #
3773 # &quot;rawKey&quot;:
3774 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
3775 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
3776 # customer-supplied encryption key to either encrypt or decrypt this
3777 # resource. You can provide either the rawKey or thersaEncryptedKey.
3778 # For example:
3779 #
3780 # &quot;rsaEncryptedKey&quot;:
3781 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
3782 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
3783 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
3784 #
3785 # The key must meet the following requirements before you can provide it to
3786 # Compute Engine:
3787 #
3788 # 1. The key is wrapped using a RSA public key certificate provided by
3789 # Google.
3790 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
3791 # encoding.
3792 #
3793 # Gets the RSA public key certificate provided by Google at:
3794 #
3795 #
3796 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
3797 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
3798 # 4648 base64 encoded SHA-256 hash of the customer-supplied
3799 # encryption key that protects this resource.
3800 },
3801 &quot;storagePool&quot;: &quot;A String&quot;, # The storage pool in which the new disk is created. You can provide
3802 # this as a partial or full URL to the resource. For example, the following
3803 # are valid values:
3804 #
3805 #
3806 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
3807 # - projects/project/zones/zone/storagePools/storagePool
3808 # - zones/zone/storagePools/storagePool
3809 },
3810 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is
3811 # either SCSI or NVME. For most machine types, the
3812 # default is SCSI. Local SSDs can use either NVME or SCSI.
3813 # In certain configurations, persistent disks can use NVMe. For more
3814 # information, seeAbout
3815 # persistent disks.
3816 &quot;kind&quot;: &quot;compute#attachedDisk&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
3817 &quot;licenses&quot;: [ # Output only. [Output Only] Any valid publicly visible licenses.
3818 &quot;A String&quot;,
3819 ],
3820 &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
3821 # in READ_WRITE mode.
3822 &quot;savedState&quot;: &quot;A String&quot;, # Output only. For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
3823 # field is set to PRESERVED if the LocalSSD data has been saved
3824 # to a persistent location by customer request. (see the
3825 # discard_local_ssd option on Stop/Suspend).
3826 # Read-only in the api.
3827 &quot;shieldedInstanceInitialState&quot;: { # Initial State for shielded instance, # Output only. [Output Only] shielded vm initial state stored on disk
3828 # these are public keys which are safe to store in public
3829 &quot;dbs&quot;: [ # The Key Database (db).
3830 {
3831 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
3832 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
3833 },
3834 ],
3835 &quot;dbxs&quot;: [ # The forbidden key database (dbx).
3836 {
3837 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
3838 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
3839 },
3840 ],
3841 &quot;keks&quot;: [ # The Key Exchange Key (KEK).
3842 {
3843 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
3844 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
3845 },
3846 ],
3847 &quot;pk&quot;: { # The Platform Key (PK).
3848 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
3849 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
3850 },
3851 },
3852 &quot;source&quot;: &quot;A String&quot;, # Specifies a valid partial or full URL to an existing Persistent Disk
3853 # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
3854 # is required.
3855 #
3856 # If desired, you can also attach existing non-root persistent disks using
3857 # this property. This field is only applicable for persistent disks.
3858 #
3859 # Note that for InstanceTemplate, specify the disk name for zonal disk,
3860 # and the URL for regional disk.
3861 &quot;type&quot;: &quot;A String&quot;, # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
3862 },
3863 ],
3864 &quot;machineTypes&quot;: [ # Alternative machine types to use for instances that are created from
3865 # these properties. This field only accepts a machine type names, for
3866 # example `n2-standard-4` and not URLs or partial URLs.
3867 &quot;A String&quot;,
3868 ],
3869 &quot;rank&quot;: &quot;A String&quot;, # Rank when prioritizing the shape flexibilities.
3870 # The instance selections with rank are considered
3871 # first, in the ascending order of the rank.
3872 # If not set, defaults to 0.
3873 },
3874 },
3875 },
3876 &quot;instanceProperties&quot;: { # The instance properties defining the VM instances to be created. Required
3877 # if sourceInstanceTemplate is not provided.
3878 &quot;advancedMachineFeatures&quot;: { # Specifies options for controlling advanced machine features. # Controls for advanced machine-related behavior features.
3879 # Note that for MachineImage, this is not supported yet.
3880 # Options that would traditionally be configured in a BIOS belong
3881 # here. Features that require operating system support may have
3882 # corresponding entries in the GuestOsFeatures of anImage (e.g., whether or not the OS in theImage supports nested virtualization being enabled or
3883 # disabled).
3884 &quot;enableNestedVirtualization&quot;: True or False, # Whether to enable nested virtualization or not (default is false).
3885 &quot;enableUefiNetworking&quot;: True or False, # Whether to enable UEFI networking for instance creation.
3886 &quot;performanceMonitoringUnit&quot;: &quot;A String&quot;, # Type of Performance Monitoring Unit requested on instance.
3887 &quot;threadsPerCore&quot;: 42, # The number of threads per physical core. To disable simultaneous
3888 # multithreading (SMT) set this to 1. If unset, the maximum number
3889 # of threads supported per core by the underlying processor is
3890 # assumed.
3891 &quot;turboMode&quot;: &quot;A String&quot;, # Turbo frequency mode to use for the instance.
3892 # Supported modes include:
3893 # * ALL_CORE_MAX
3894 #
3895 # Using empty string or not setting this field will use the platform-specific
3896 # default turbo mode.
3897 &quot;visibleCoreCount&quot;: 42, # The number of physical cores to expose to an instance. Multiply by
3898 # the number of threads per core to compute the total number of virtual
3899 # CPUs to expose to the instance. If unset, the number of cores is
3900 # inferred from the instance&#x27;s nominal CPU count and the underlying
3901 # platform&#x27;s SMT width.
3902 },
3903 &quot;canIpForward&quot;: True or False, # Enables instances created based on these properties to send packets with
3904 # source IP addresses other than their own and receive packets with
3905 # destination IP addresses other than their own. If these instances will be
3906 # used as an IP gateway or it will be set as the next-hop in a Route
3907 # resource, specify true. If unsure, leave this set tofalse. See theEnable IP forwarding
3908 # documentation for more information.
3909 &quot;confidentialInstanceConfig&quot;: { # A set of Confidential Instance options. # Specifies the Confidential Instance options.
3910 # Note that for MachineImage, this is not supported yet.
3911 &quot;confidentialInstanceType&quot;: &quot;A String&quot;, # Defines the type of technology used by the confidential instance.
3912 &quot;enableConfidentialCompute&quot;: True or False, # Defines whether the instance should have confidential compute enabled.
3913 },
3914 &quot;description&quot;: &quot;A String&quot;, # An optional text description for the instances that are created from these
3915 # properties.
3916 &quot;disks&quot;: [ # An array of disks that are associated with the instances that are created
3917 # from these properties.
3918 { # An instance-attached disk resource.
3919 &quot;architecture&quot;: &quot;A String&quot;, # Output only. [Output Only] The architecture of the attached disk. Valid values are ARM64
3920 # or X86_64.
3921 &quot;autoDelete&quot;: True or False, # Specifies whether the disk will be auto-deleted when the instance is
3922 # deleted (but not when the disk is detached from the instance).
3923 &quot;boot&quot;: True or False, # Indicates that this is a boot disk. The virtual machine will use the first
3924 # partition of the disk for its root filesystem.
3925 &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
3926 # running within the instance. This name can be used to reference the device
3927 # for mounting, resizing, and so on, from within the instance.
3928 #
3929 # If not specified, the server chooses a default device name to apply to this
3930 # disk, in the form persistent-disk-x, where x is a number
3931 # assigned by Google Compute Engine. This field is only applicable for
3932 # persistent disks.
3933 &quot;diskEncryptionKey&quot;: { # Encrypts or decrypts a disk using acustomer-supplied
3934 # encryption key.
3935 #
3936 # If you are creating a new disk, this field encrypts the new disk using
3937 # an encryption key that you provide. If you are attaching an existing
3938 # disk that is already encrypted, this field decrypts the disk using
3939 # the customer-supplied encryption key.
3940 #
3941 # If you encrypt a disk using a customer-supplied key, you must provide the
3942 # same key again when you attempt to use this resource at a later time. For
3943 # example, you must provide the key when you create a snapshot or an image
3944 # from the disk or when you attach the disk to a virtual machine instance.
3945 #
3946 # If you do not provide an encryption key, then the disk will be encrypted
3947 # using an automatically generated key and you do not need to provide a key
3948 # to use the disk later.
3949 #
3950 # Note:
3951 #
3952 # Instance templates do not storecustomer-supplied
3953 # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
3954 #
3955 # You cannot create VMs that have disks with customer-supplied keys using
3956 # the bulk
3957 # insert method.
3958 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
3959 # For example:
3960 #
3961 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3962 # key_region/cryptoKeys/key
3963 #
3964 # The fully-qualifed key name may be returned for resource GET requests. For
3965 # example:
3966 #
3967 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3968 # key_region/cryptoKeys/key
3969 # /cryptoKeyVersions/1
3970 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
3971 # key. If absent, the Compute Engine default service account is used.
3972 # For example:
3973 #
3974 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
3975 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
3976 # encryption key, encoded in RFC
3977 # 4648 base64 to either encrypt or decrypt this resource. You can
3978 # provide either the rawKey or thersaEncryptedKey.
3979 # For example:
3980 #
3981 # &quot;rawKey&quot;:
3982 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
3983 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
3984 # customer-supplied encryption key to either encrypt or decrypt this
3985 # resource. You can provide either the rawKey or thersaEncryptedKey.
3986 # For example:
3987 #
3988 # &quot;rsaEncryptedKey&quot;:
3989 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
3990 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
3991 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
3992 #
3993 # The key must meet the following requirements before you can provide it to
3994 # Compute Engine:
3995 #
3996 # 1. The key is wrapped using a RSA public key certificate provided by
3997 # Google.
3998 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
3999 # encoding.
4000 #
4001 # Gets the RSA public key certificate provided by Google at:
4002 #
4003 #
4004 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
4005 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
4006 # 4648 base64 encoded SHA-256 hash of the customer-supplied
4007 # encryption key that protects this resource.
4008 },
4009 &quot;diskSizeGb&quot;: &quot;A String&quot;, # The size of the disk in GB.
4010 &quot;forceAttach&quot;: True or False, # [Input Only] Whether to force attach the regional disk even if it&#x27;s
4011 # currently attached to another instance. If you try to force attach a zonal
4012 # disk to an instance, you will receive an error.
4013 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
4014 # only for bootable images. Read
4015 # Enabling guest operating system features to see a list of available
4016 # options.
4017 { # Guest OS features.
4018 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
4019 # separate values. Set to one or more of the following values:
4020 #
4021 # - VIRTIO_SCSI_MULTIQUEUE
4022 # - WINDOWS
4023 # - MULTI_IP_SUBNET
4024 # - UEFI_COMPATIBLE
4025 # - GVNIC
4026 # - SEV_CAPABLE
4027 # - SUSPEND_RESUME_COMPATIBLE
4028 # - SEV_LIVE_MIGRATABLE_V2
4029 # - SEV_SNP_CAPABLE
4030 # - TDX_CAPABLE
4031 # - IDPF
4032 # - SNP_SVSM_CAPABLE
4033 # - CCA_CAPABLE
4034 #
4035 #
4036 # For more information, see
4037 # Enabling guest operating system features.
4038 },
4039 ],
4040 &quot;index&quot;: 42, # Output only. [Output Only] A zero-based index to this disk, where 0 is reserved for the
4041 # boot disk. If you have many disks attached to an instance, each
4042 # disk would have a unique index number.
4043 &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
4044 # alongside the new instance. Use initialization parameters to create boot
4045 # disks or local SSDs attached to the new instance.
4046 #
4047 # This property is mutually exclusive with the source property;
4048 # you can only define one or the other, but not both.
4049 # alongside the new instance. Use initialization parameters to create boot
4050 # disks or local SSDs attached to the new instance.
4051 #
4052 # This field is persisted and returned for instanceTemplate and not returned
4053 # in the context of instance.
4054 #
4055 # This property is mutually exclusive with the source property;
4056 # you can only define one or the other, but not both.
4057 &quot;architecture&quot;: &quot;A String&quot;, # The architecture of the attached disk. Valid values are
4058 # arm64 or x86_64.
4059 &quot;description&quot;: &quot;A String&quot;, # An optional description. Provide this property when creating the disk.
4060 &quot;diskName&quot;: &quot;A String&quot;, # Specifies the disk name. If not specified, the default is to use the name
4061 # of the instance. If a disk with the same name already exists in the given
4062 # region, the existing disk is attached to the new instance and the
4063 # new disk is not created.
4064 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB. The size must be at least
4065 # 10 GB. If you specify a sourceImage, which is required for
4066 # boot disks, the default size is the size of the sourceImage.
4067 # If you do not specify a sourceImage, the default disk size
4068 # is 500 GB.
4069 &quot;diskType&quot;: &quot;A String&quot;,
4070 &quot;enableConfidentialCompute&quot;: True or False, # Whether this disk is using confidential compute mode.
4071 &quot;labels&quot;: { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
4072 # persistent disks.
4073 &quot;a_key&quot;: &quot;A String&quot;,
4074 },
4075 &quot;licenses&quot;: [ # A list of publicly visible licenses. Reserved for Google&#x27;s use.
4076 &quot;A String&quot;,
4077 ],
4078 &quot;onUpdateAction&quot;: &quot;A String&quot;, # Specifies which action to take on instance update with this disk. Default
4079 # is to use the existing disk.
4080 &quot;provisionedIops&quot;: &quot;A String&quot;, # Indicates how many IOPS to provision for the disk. This sets the number
4081 # of I/O operations per second that the disk can handle. Values must be
4082 # between 10,000 and 120,000. For more details, see theExtreme persistent
4083 # disk documentation.
4084 &quot;provisionedThroughput&quot;: &quot;A String&quot;, # Indicates how much throughput to provision for the disk. This sets the
4085 # number of throughput mb per second that the disk can handle. Values must
4086 # greater than or equal to 1.
4087 &quot;replicaZones&quot;: [ # Required for each regional disk associated with the instance. Specify
4088 # the URLs of the zones where the disk should be replicated to.
4089 # You must provide exactly two replica zones, and one zone must be the same
4090 # as the instance zone.
4091 &quot;A String&quot;,
4092 ],
4093 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
4094 # have the same definition as resource
4095 # manager tags. Keys and values can be either in numeric format,
4096 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
4097 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
4098 # `{tag_value_short_name}`. The field is ignored (both PUT &amp; PATCH) when
4099 # empty.
4100 &quot;a_key&quot;: &quot;A String&quot;,
4101 },
4102 &quot;resourcePolicies&quot;: [ # Resource policies applied to this disk for automatic snapshot creations.
4103 # Specified using the full or partial URL. For instance template, specify
4104 # only the resource policy name.
4105 &quot;A String&quot;,
4106 ],
4107 &quot;sourceImage&quot;: &quot;A String&quot;, # The source image to create this disk. When creating a new instance boot
4108 # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
4109 # is required.
4110 #
4111 # To create a disk with one of the public operating system
4112 # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
4113 #
4114 # projects/debian-cloud/global/images/family/debian-9
4115 #
4116 #
4117 # Alternatively, use a specific version of a public operating system image:
4118 #
4119 # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
4120 #
4121 #
4122 # To create a disk with a custom image that you created, specify the
4123 # image name in the following format:
4124 #
4125 # global/images/my-custom-image
4126 #
4127 #
4128 # You can also specify a custom image by its image family, which returns
4129 # the latest version of the image in that family. Replace the image name
4130 # with family/family-name:
4131 #
4132 # global/images/family/my-image-family
4133 #
4134 #
4135 # If the source image is deleted later, this field will not be set.
4136 &quot;sourceImageEncryptionKey&quot;: { # Thecustomer-supplied
4137 # encryption key of the source image. Required if the source image is
4138 # protected by a customer-supplied encryption key.
4139 #
4140 # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
4141 # encryption keys, so you cannot create disks for instances in a managed instance group if the
4142 # source images are encrypted with your own keys.
4143 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
4144 # For example:
4145 #
4146 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
4147 # key_region/cryptoKeys/key
4148 #
4149 # The fully-qualifed key name may be returned for resource GET requests. For
4150 # example:
4151 #
4152 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
4153 # key_region/cryptoKeys/key
4154 # /cryptoKeyVersions/1
4155 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
4156 # key. If absent, the Compute Engine default service account is used.
4157 # For example:
4158 #
4159 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
4160 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
4161 # encryption key, encoded in RFC
4162 # 4648 base64 to either encrypt or decrypt this resource. You can
4163 # provide either the rawKey or thersaEncryptedKey.
4164 # For example:
4165 #
4166 # &quot;rawKey&quot;:
4167 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
4168 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
4169 # customer-supplied encryption key to either encrypt or decrypt this
4170 # resource. You can provide either the rawKey or thersaEncryptedKey.
4171 # For example:
4172 #
4173 # &quot;rsaEncryptedKey&quot;:
4174 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
4175 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
4176 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
4177 #
4178 # The key must meet the following requirements before you can provide it to
4179 # Compute Engine:
4180 #
4181 # 1. The key is wrapped using a RSA public key certificate provided by
4182 # Google.
4183 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
4184 # encoding.
4185 #
4186 # Gets the RSA public key certificate provided by Google at:
4187 #
4188 #
4189 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
4190 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
4191 # 4648 base64 encoded SHA-256 hash of the customer-supplied
4192 # encryption key that protects this resource.
4193 },
4194 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # The source snapshot to create this disk. When creating a new instance
4195 # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
4196 # is required.
4197 #
4198 # To create a disk with a snapshot that you created, specify the
4199 # snapshot name in the following format:
4200 #
4201 # global/snapshots/my-backup
4202 #
4203 #
4204 # If the source snapshot is deleted later, this field will not be set.
4205 #
4206 # Note: You cannot create VMs in bulk using a snapshot as the source. Use
4207 # an image instead when you create VMs using
4208 # the bulk
4209 # insert method.
4210 &quot;sourceSnapshotEncryptionKey&quot;: { # Thecustomer-supplied
4211 # encryption key of the source snapshot.
4212 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
4213 # For example:
4214 #
4215 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
4216 # key_region/cryptoKeys/key
4217 #
4218 # The fully-qualifed key name may be returned for resource GET requests. For
4219 # example:
4220 #
4221 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
4222 # key_region/cryptoKeys/key
4223 # /cryptoKeyVersions/1
4224 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
4225 # key. If absent, the Compute Engine default service account is used.
4226 # For example:
4227 #
4228 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
4229 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
4230 # encryption key, encoded in RFC
4231 # 4648 base64 to either encrypt or decrypt this resource. You can
4232 # provide either the rawKey or thersaEncryptedKey.
4233 # For example:
4234 #
4235 # &quot;rawKey&quot;:
4236 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
4237 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
4238 # customer-supplied encryption key to either encrypt or decrypt this
4239 # resource. You can provide either the rawKey or thersaEncryptedKey.
4240 # For example:
4241 #
4242 # &quot;rsaEncryptedKey&quot;:
4243 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
4244 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
4245 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
4246 #
4247 # The key must meet the following requirements before you can provide it to
4248 # Compute Engine:
4249 #
4250 # 1. The key is wrapped using a RSA public key certificate provided by
4251 # Google.
4252 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
4253 # encoding.
4254 #
4255 # Gets the RSA public key certificate provided by Google at:
4256 #
4257 #
4258 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
4259 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
4260 # 4648 base64 encoded SHA-256 hash of the customer-supplied
4261 # encryption key that protects this resource.
4262 },
4263 &quot;storagePool&quot;: &quot;A String&quot;, # The storage pool in which the new disk is created. You can provide
4264 # this as a partial or full URL to the resource. For example, the following
4265 # are valid values:
4266 #
4267 #
4268 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
4269 # - projects/project/zones/zone/storagePools/storagePool
4270 # - zones/zone/storagePools/storagePool
4271 },
4272 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is
4273 # either SCSI or NVME. For most machine types, the
4274 # default is SCSI. Local SSDs can use either NVME or SCSI.
4275 # In certain configurations, persistent disks can use NVMe. For more
4276 # information, seeAbout
4277 # persistent disks.
4278 &quot;kind&quot;: &quot;compute#attachedDisk&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
4279 &quot;licenses&quot;: [ # Output only. [Output Only] Any valid publicly visible licenses.
4280 &quot;A String&quot;,
4281 ],
4282 &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
4283 # in READ_WRITE mode.
4284 &quot;savedState&quot;: &quot;A String&quot;, # Output only. For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
4285 # field is set to PRESERVED if the LocalSSD data has been saved
4286 # to a persistent location by customer request. (see the
4287 # discard_local_ssd option on Stop/Suspend).
4288 # Read-only in the api.
4289 &quot;shieldedInstanceInitialState&quot;: { # Initial State for shielded instance, # Output only. [Output Only] shielded vm initial state stored on disk
4290 # these are public keys which are safe to store in public
4291 &quot;dbs&quot;: [ # The Key Database (db).
4292 {
4293 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
4294 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
4295 },
4296 ],
4297 &quot;dbxs&quot;: [ # The forbidden key database (dbx).
4298 {
4299 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
4300 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
4301 },
4302 ],
4303 &quot;keks&quot;: [ # The Key Exchange Key (KEK).
4304 {
4305 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
4306 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
4307 },
4308 ],
4309 &quot;pk&quot;: { # The Platform Key (PK).
4310 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
4311 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
4312 },
4313 },
4314 &quot;source&quot;: &quot;A String&quot;, # Specifies a valid partial or full URL to an existing Persistent Disk
4315 # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
4316 # is required.
4317 #
4318 # If desired, you can also attach existing non-root persistent disks using
4319 # this property. This field is only applicable for persistent disks.
4320 #
4321 # Note that for InstanceTemplate, specify the disk name for zonal disk,
4322 # and the URL for regional disk.
4323 &quot;type&quot;: &quot;A String&quot;, # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
4324 },
4325 ],
4326 &quot;guestAccelerators&quot;: [ # A list of guest accelerator cards&#x27; type and count to use for instances
4327 # created from these properties.
4328 { # A specification of the type and number of accelerator cards attached to the
4329 # instance.
4330 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
4331 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this
4332 # instance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100
4333 # If you are creating an instance template, specify only the
4334 # accelerator name.
4335 # See GPUs on Compute Engine
4336 # for a full list of accelerator types.
4337 },
4338 ],
4339 &quot;keyRevocationActionType&quot;: &quot;A String&quot;, # KeyRevocationActionType of the instance. Supported options are &quot;STOP&quot; and
4340 # &quot;NONE&quot;. The default value is &quot;NONE&quot; if it is not specified.
4341 &quot;labels&quot;: { # Labels to apply to instances that are created from these properties.
4342 &quot;a_key&quot;: &quot;A String&quot;,
4343 },
4344 &quot;machineType&quot;: &quot;A String&quot;, # The machine type to use for instances that are created from these
4345 # properties.
4346 # This field only accepts a machine type name, for example `n2-standard-4`.
4347 # If you use the machine type full or partial URL, for example
4348 # `projects/my-l7ilb-project/zones/us-central1-a/machineTypes/n2-standard-4`,
4349 # the request will result in an `INTERNAL_ERROR`.
4350 &quot;metadata&quot;: { # A metadata key/value entry. # The metadata key/value pairs to assign to instances that are created from
4351 # these properties. These pairs can consist of custom metadata or predefined
4352 # keys. SeeProject and
4353 # instance metadata for more information.
4354 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
4355 # the metadata&#x27;s contents and used for optimistic locking. The
4356 # fingerprint is initially generated by Compute Engine and changes after
4357 # every request to modify or update metadata. You must always provide an
4358 # up-to-date fingerprint hash in order to update or change metadata,
4359 # otherwise the request will fail with error412 conditionNotMet.
4360 #
4361 # To see the latest fingerprint, make a get() request to
4362 # retrieve the resource.
4363 &quot;items&quot;: [ # Array of key/value pairs. The total size of all keys and values must be
4364 # less than 512 KB.
4365 { # Metadata
4366 &quot;key&quot;: &quot;A String&quot;, # Key for the metadata entry. Keys must conform to the following
4367 # regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length.
4368 # This is reflected as part of a URL in the metadata server. Additionally, to
4369 # avoid ambiguity, keys must not conflict with any other metadata keys
4370 # for the project.
4371 &quot;value&quot;: &quot;A String&quot;, # Value for the metadata entry. These are free-form strings, and only
4372 # have meaning as interpreted by the image running in the instance. The
4373 # only restriction placed on values is that their size must be less than
4374 # or equal to 262144 bytes (256 KiB).
4375 },
4376 ],
4377 &quot;kind&quot;: &quot;compute#metadata&quot;, # Output only. [Output Only] Type of the resource. Always compute#metadata
4378 # for metadata.
4379 },
4380 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Minimum cpu/platform to be used by instances. The instance may be
4381 # scheduled on the specified or newer cpu/platform. Applicable values are the
4382 # friendly names of CPU platforms, such asminCpuPlatform: &quot;Intel Haswell&quot; orminCpuPlatform: &quot;Intel Sandy Bridge&quot;. For more
4383 # information, read Specifying a
4384 # Minimum CPU Platform.
4385 &quot;networkInterfaces&quot;: [ # An array of network access configurations for this interface.
4386 { # A network interface resource attached to an instance.
4387 &quot;accessConfigs&quot;: [ # An array of configurations for this interface. Currently, only one access
4388 # config, ONE_TO_ONE_NAT, is supported. If there are noaccessConfigs specified, then this instance will have
4389 # no external internet access.
4390 { # An access configuration attached to an instance&#x27;s network interface.
4391 # Only one access config per instance is supported.
4392 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
4393 # The first IPv6 address of the external IPv6 range associated
4394 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
4395 # use a static external IP address, it must be unused and in the same region
4396 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
4397 # assign an external IPv6 address from the instance&#x27;s subnetwork.
4398 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
4399 # external IPv6 range.
4400 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
4401 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
4402 # (IPv4), the default and recommended name is External NAT, but
4403 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
4404 # recommend name is External IPv6.
4405 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
4406 # address associated with this instance. Specify an unused static
4407 # external IP address available to the project or leave this field undefined
4408 # to use an IP from a shared ephemeral IP address pool. If you specify a
4409 # static external IP address, it must live in the same region as the zone of
4410 # the instance.
4411 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
4412 # configuration and can only take the following values: PREMIUM,STANDARD.
4413 #
4414 # If an AccessConfig is specified without a valid external IP address, an
4415 # ephemeral IP will be created with this networkTier.
4416 #
4417 # If an AccessConfig with a valid external IP address is specified, it must
4418 # match that of the networkTier associated with the Address resource owning
4419 # that IP.
4420 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
4421 #
4422 # 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
4423 # first IP in associated external IPv6 range.
4424 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
4425 # config.
4426 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
4427 # external IP address of the instance to a DNS domain name.
4428 #
4429 # This field is not used in ipv6AccessConfig. A default PTR
4430 # record will be created if the VM has external IPv6 range associated.
4431 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
4432 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
4433 },
4434 ],
4435 &quot;aliasIpRanges&quot;: [ # An array of alias IP ranges for this network interface.
4436 # You can only specify this field for network interfaces in VPC networks.
4437 { # An alias IP range attached to an instance&#x27;s network interface.
4438 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
4439 # must belong to the specified subnetwork and cannot contain IP addresses
4440 # reserved by system or used by other network interfaces. This range may be
4441 # 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).
4442 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
4443 # alias range. If not specified, the primary range of the subnetwork is used.
4444 },
4445 ],
4446 &quot;aliasIpv6Ranges&quot;: [ # An array of alias IPv6 ranges for this network interface.
4447 # You can only specify this field for network interfaces in VPC networks.
4448 { # An alias IP range attached to an instance&#x27;s network interface.
4449 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
4450 # must belong to the specified subnetwork and cannot contain IP addresses
4451 # reserved by system or used by other network interfaces. This range may be
4452 # 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).
4453 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
4454 # alias range. If not specified, the primary range of the subnetwork is used.
4455 },
4456 ],
4457 &quot;enableVpcScopedDns&quot;: True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
4458 # with network_attachment.
4459 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint hash of contents stored in this network interface.
4460 # This field will be ignored when inserting an Instance or
4461 # adding a NetworkInterface. An up-to-date
4462 # 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.
4463 &quot;igmpQuery&quot;: &quot;A String&quot;, # Indicate whether igmp query is enabled on the network interface
4464 # or not. If enabled, also indicates the version of IGMP supported.
4465 &quot;internalIpv6PrefixLength&quot;: 42, # The prefix length of the primary internal IPv6 range.
4466 &quot;ipv6AccessConfigs&quot;: [ # An array of IPv6 access configurations for this interface. Currently, only
4467 # one IPv6 access config, DIRECT_IPV6, is supported. If there
4468 # is no ipv6AccessConfig specified, then this instance will
4469 # have no external IPv6 Internet access.
4470 { # An access configuration attached to an instance&#x27;s network interface.
4471 # Only one access config per instance is supported.
4472 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
4473 # The first IPv6 address of the external IPv6 range associated
4474 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
4475 # use a static external IP address, it must be unused and in the same region
4476 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
4477 # assign an external IPv6 address from the instance&#x27;s subnetwork.
4478 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
4479 # external IPv6 range.
4480 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
4481 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
4482 # (IPv4), the default and recommended name is External NAT, but
4483 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
4484 # recommend name is External IPv6.
4485 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
4486 # address associated with this instance. Specify an unused static
4487 # external IP address available to the project or leave this field undefined
4488 # to use an IP from a shared ephemeral IP address pool. If you specify a
4489 # static external IP address, it must live in the same region as the zone of
4490 # the instance.
4491 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
4492 # configuration and can only take the following values: PREMIUM,STANDARD.
4493 #
4494 # If an AccessConfig is specified without a valid external IP address, an
4495 # ephemeral IP will be created with this networkTier.
4496 #
4497 # If an AccessConfig with a valid external IP address is specified, it must
4498 # match that of the networkTier associated with the Address resource owning
4499 # that IP.
4500 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
4501 #
4502 # 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
4503 # first IP in associated external IPv6 range.
4504 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
4505 # config.
4506 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
4507 # external IP address of the instance to a DNS domain name.
4508 #
4509 # This field is not used in ipv6AccessConfig. A default PTR
4510 # record will be created if the VM has external IPv6 range associated.
4511 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
4512 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
4513 },
4514 ],
4515 &quot;ipv6AccessType&quot;: &quot;A String&quot;, # Output only. [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be
4516 # accessed from the Internet. This field is always inherited from its
4517 # subnetwork.
4518 #
4519 # Valid only if stackType is IPV4_IPV6.
4520 &quot;ipv6Address&quot;: &quot;A String&quot;, # An IPv6 internal network address for this network interface. To
4521 # use a static internal IP address, it must be unused and in the same region
4522 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
4523 # assign an internal IPv6 address from the instance&#x27;s subnetwork.
4524 &quot;kind&quot;: &quot;compute#networkInterface&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#networkInterface for network interfaces.
4525 &quot;name&quot;: &quot;A String&quot;, # [Output Only] The name of the network interface, which is generated by the
4526 # server. For a VM, the network interface uses the nicN naming
4527 # format. Where N is a value between 0 and7. The default interface value is nic0.
4528 &quot;network&quot;: &quot;A String&quot;, # URL of the VPC network resource for this instance. When creating an
4529 # instance, if neither the network nor the subnetwork is specified, the
4530 # default network global/networks/default is used. If the
4531 # selected project doesn&#x27;t have the default network, you must specify a
4532 # network or subnet. If the network is not specified but the subnetwork is
4533 # specified, the network is inferred.
4534 #
4535 # If you specify this property, you can specify the network as
4536 # a full or partial URL. For example, the following are all valid URLs:
4537 #
4538 #
4539 # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
4540 # - projects/project/global/networks/network
4541 # - global/networks/default
4542 &quot;networkAttachment&quot;: &quot;A String&quot;, # The URL of the network attachment that this interface should connect
4543 # to in the following format:
4544 # projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.
4545 &quot;networkIP&quot;: &quot;A String&quot;, # An IPv4 internal IP address to assign to the instance for this network
4546 # interface. If not specified by the user, an unused internal IP is
4547 # assigned by the system.
4548 &quot;nicType&quot;: &quot;A String&quot;, # The type of vNIC to be used on this interface. This may be gVNIC or
4549 # VirtioNet.
4550 &quot;parentNicName&quot;: &quot;A String&quot;, # Name of the parent network interface of a dynamic network interface.
4551 &quot;queueCount&quot;: 42, # The networking queue count that&#x27;s specified by users for the network
4552 # interface. Both Rx and Tx queues will be set to this number. It&#x27;ll be empty
4553 # if not specified by the users.
4554 &quot;serviceClassId&quot;: &quot;A String&quot;, # Optional. Producer Service&#x27;s Service class Id for the region of this network
4555 # interface. Can only be used with network_attachment. It is not possible to
4556 # use on its own however, network_attachment can be used without
4557 # service_class_id.
4558 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for this network interface. To assign only IPv4 addresses,
4559 # use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, useIPV4_IPV6. If not specified, IPV4_ONLY is used.
4560 #
4561 # This field can be both set at instance creation and update network
4562 # interface operations.
4563 &quot;subnetwork&quot;: &quot;A String&quot;, # The URL of the Subnetwork resource for this instance. If the network
4564 # resource is inlegacy
4565 # mode, do not specify this field. If the network is in auto subnet
4566 # mode, specifying the subnetwork is optional. If the network is in custom
4567 # subnet mode, specifying the subnetwork is required. If you specify this
4568 # field, you can specify the subnetwork as a full or partial URL. For
4569 # example, the following are all valid URLs:
4570 #
4571 #
4572 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
4573 # - regions/region/subnetworks/subnetwork
4574 &quot;vlan&quot;: 42, # VLAN tag of a dynamic network interface, must be an integer in the range
4575 # from 2 to 255 inclusively.
4576 },
4577 ],
4578 &quot;networkPerformanceConfig&quot;: { # Note that for MachineImage, this is not supported yet.
4579 &quot;totalEgressBandwidthTier&quot;: &quot;A String&quot;,
4580 },
4581 &quot;privateIpv6GoogleAccess&quot;: &quot;A String&quot;, # The private IPv6 google access type for VMs.
4582 # If not specified, use INHERIT_FROM_SUBNETWORK as default.
4583 # Note that for MachineImage, this is not supported yet.
4584 &quot;reservationAffinity&quot;: { # Specifies the reservations that this instance can consume from. # Specifies the reservations that instances can consume from.
4585 # Note that for MachineImage, this is not supported yet.
4586 &quot;consumeReservationType&quot;: &quot;A String&quot;, # Specifies the type of reservation from which this instance can consume
4587 # resources: ANY_RESERVATION (default),SPECIFIC_RESERVATION, or NO_RESERVATION. See
4588 # Consuming reserved instances for examples.
4589 &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
4590 # the name of your reservation as its value.
4591 &quot;values&quot;: [ # Corresponds to the label values of a reservation resource. This can be
4592 # either a name to a reservation in the same project or
4593 # &quot;projects/different-project/reservations/some-reservation-name&quot; to target a
4594 # shared reservation in the same zone but in a different project.
4595 &quot;A String&quot;,
4596 ],
4597 },
4598 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the instance. Tag keys and values
4599 # have the same definition as resource
4600 # manager tags. Keys and values can be either in numeric format,
4601 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
4602 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
4603 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
4604 # PATCH) when empty.
4605 &quot;a_key&quot;: &quot;A String&quot;,
4606 },
4607 &quot;resourcePolicies&quot;: [ # Resource policies (names, not URLs) applied to instances created from
4608 # these properties.
4609 # Note that for MachineImage, this is not supported yet.
4610 &quot;A String&quot;,
4611 ],
4612 &quot;scheduling&quot;: { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from
4613 # these properties.
4614 &quot;automaticRestart&quot;: True or False, # Specifies whether the instance should be automatically restarted if it is
4615 # terminated by Compute Engine (not terminated by a user). You can only set
4616 # the automatic restart option for standard instances.Preemptible instances
4617 # cannot be automatically restarted.
4618 #
4619 # By default, this is set to true so an instance is
4620 # automatically restarted if it is terminated by Compute Engine.
4621 &quot;availabilityDomain&quot;: 42, # Specifies the availability domain to place the instance in. The value
4622 # must be a number between 1 and the number of availability domains
4623 # specified in the spread placement policy attached to the instance.
4624 &quot;hostErrorTimeoutSeconds&quot;: 42, # Specify the time in seconds for host error detection, the value must be
4625 # within the range of [90, 330] with the increment of 30, if unset, the
4626 # default behavior of host error recovery will be used.
4627 &quot;instanceTerminationAction&quot;: &quot;A String&quot;, # Specifies the termination action for the instance.
4628 &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
4629 # recovery of the Local Ssd state is attempted. Its value should be in
4630 # between 0 and 168 hours with hour granularity and the default value being 1
4631 # hour.
4632 # as a count of seconds and fractions of seconds at nanosecond
4633 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
4634 # or &quot;month&quot;. Range is approximately 10,000 years.
4635 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
4636 # Durations less than one second are represented with a 0
4637 # `seconds` field and a positive `nanos` field. Must be from 0
4638 # to 999,999,999 inclusive.
4639 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
4640 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
4641 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
4642 },
4643 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the instance close to other
4644 # resources.
4645 # This field is for use by internal tools that use the public API.
4646 &quot;maxRunDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the max run duration for the given instance. If specified,
4647 # the instance termination action will be performed at the end of the run
4648 # duration.
4649 # as a count of seconds and fractions of seconds at nanosecond
4650 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
4651 # or &quot;month&quot;. Range is approximately 10,000 years.
4652 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
4653 # Durations less than one second are represented with a 0
4654 # `seconds` field and a positive `nanos` field. Must be from 0
4655 # to 999,999,999 inclusive.
4656 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
4657 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
4658 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
4659 },
4660 &quot;minNodeCpus&quot;: 42, # The minimum number of virtual CPUs this instance will consume when running
4661 # on a sole-tenant node.
4662 &quot;nodeAffinities&quot;: [ # A set of node affinity and anti-affinity configurations. Refer toConfiguring node
4663 # affinity for more information.
4664 # Overrides reservationAffinity.
4665 { # Node Affinity: the configuration of desired nodes onto which this Instance
4666 # could be scheduled.
4667 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of Node resource.
4668 &quot;operator&quot;: &quot;A String&quot;, # Defines the operation of node selection. Valid operators areIN for affinity and NOT_IN for anti-affinity.
4669 &quot;values&quot;: [ # Corresponds to the label values of Node resource.
4670 &quot;A String&quot;,
4671 ],
4672 },
4673 ],
4674 &quot;onHostMaintenance&quot;: &quot;A String&quot;, # Defines the maintenance behavior for this instance. For standard instances,
4675 # the default behavior is MIGRATE. Forpreemptible instances,
4676 # the default and only possible behavior is TERMINATE. For more
4677 # information, see
4678 # Set
4679 # VM host maintenance policy.
4680 &quot;onInstanceStopAction&quot;: { # Defines the behaviour for instances with the instance_termination_actionSTOP.
4681 &quot;discardLocalSsd&quot;: True or False, # If true, the contents of any attached Local SSD disks will be discarded
4682 # else, the Local SSD data will be preserved when the instance is stopped
4683 # at the end of the run duration/termination time.
4684 },
4685 &quot;preemptible&quot;: True or False, # Defines whether the instance is preemptible. This can only be set during
4686 # instance creation or while the instance isstopped and
4687 # therefore, in a `TERMINATED` state. SeeInstance Life
4688 # Cycle for more information on the possible instance states.
4689 &quot;provisioningModel&quot;: &quot;A String&quot;, # Specifies the provisioning model of the instance.
4690 &quot;skipGuestOsShutdown&quot;: True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
4691 # Off and ACPI G3 Mechanical
4692 # Off for Standard VMs and 30 seconds for Spot VMs.
4693 &quot;terminationTime&quot;: &quot;A String&quot;, # Specifies the timestamp, when the instance will be terminated, inRFC3339 text format. If specified, the instance
4694 # termination action will be performed at the termination time.
4695 },
4696 &quot;serviceAccounts&quot;: [ # A list of service accounts with specified scopes. Access tokens for these
4697 # service accounts are available to the instances that are created from
4698 # these properties. Use metadata queries to obtain the access tokens for
4699 # these instances.
4700 { # A service account.
4701 &quot;email&quot;: &quot;A String&quot;, # Email address of the service account.
4702 &quot;scopes&quot;: [ # The list of scopes to be made available for this service account.
4703 &quot;A String&quot;,
4704 ],
4705 },
4706 ],
4707 &quot;shieldedInstanceConfig&quot;: { # A set of Shielded Instance options. # Note that for MachineImage, this is not supported yet.
4708 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.Enabled by
4709 # default.
4710 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.Disabled by
4711 # default.
4712 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.Enabled by
4713 # default.
4714 },
4715 &quot;tags&quot;: { # A set of instance tags. # A list of tags to apply to the instances that are created from these
4716 # properties. The tags identify valid sources or targets for network
4717 # firewalls. The setTags method can modify this list of tags. Each tag within
4718 # the list must comply with RFC1035.
4719 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
4720 # the tags&#x27; contents and used for optimistic locking. The
4721 # fingerprint is initially generated by Compute Engine and changes after
4722 # every request to modify or update tags. You must always provide an
4723 # up-to-date fingerprint hash in order to update or change tags.
4724 #
4725 # To see the latest fingerprint, make get() request to the
4726 # instance.
4727 &quot;items&quot;: [ # An array of tags. Each tag must be 1-63 characters long, and comply
4728 # with RFC1035.
4729 &quot;A String&quot;,
4730 ],
4731 },
4732 &quot;workloadIdentityConfig&quot;: {
4733 &quot;identity&quot;: &quot;A String&quot;,
4734 &quot;identityCertificateEnabled&quot;: True or False,
4735 },
4736 },
4737 &quot;locationPolicy&quot;: { # Configuration for location policy among multiple possible locations # Policy for choosing target zone. For more information, seeCreate VMs in
4738 # bulk.
4739 # (e.g. preferences for zone selection among zones in a single region).
4740 &quot;locations&quot;: { # Location configurations mapped by location name.
4741 # Currently only zone names are supported and must be represented as valid
4742 # internal URLs, such as zones/us-central1-a.
4743 # The bulkInsert operation doesn&#x27;t create instances in an AI zone, even if
4744 # an AI zone is available in the specified region. For example, if you set a
4745 # DENY preference for us-central1-a, Compute Engine will consider
4746 # us-central1-b and us-central1-c for instance creation, but not
4747 # us-central1-ai1a. Also, you can&#x27;t use the locations[] configuration to
4748 # allow instance creation in an AI zone. To include an AI zone in bulkInsert
4749 # operations, use the locationPolicy.zones[] field.
4750 &quot;a_key&quot;: {
4751 &quot;constraints&quot;: { # Per-zone constraints on location policy for this zone. # Constraints that the caller requires on the result distribution
4752 # in this zone.
4753 &quot;maxCount&quot;: 42, # Maximum number of items that are allowed to be placed in this zone.
4754 # The value must be non-negative.
4755 },
4756 &quot;preference&quot;: &quot;A String&quot;, # Preference for a given location. Set to either ALLOW orDENY.
4757 },
4758 },
4759 &quot;targetShape&quot;: &quot;A String&quot;, # Strategy for distributing VMs across zones in a region.
4760 &quot;zones&quot;: [ # The bulkInsert operation applies any preferences set in the locations
4761 # field to the specific zones listed in the zones field if the same zones
4762 # are specified in both fields.
4763 {
4764 &quot;zone&quot;: &quot;A String&quot;, # The URL of the zone.
4765 # The zone must exist in the region where the request is called.
4766 # Zones must be represented as valid partial URLs,
4767 # such as zones/us-central1-a.
4768 },
4769 ],
4770 },
4771 &quot;minCount&quot;: &quot;A String&quot;, # The minimum number of instances to create. If no min_count is
4772 # specified then count is used as the default value. Ifmin_count instances cannot be created, then no instances will
4773 # be created and instances already created will be deleted.
4774 &quot;namePattern&quot;: &quot;A String&quot;, # The string pattern used for the names of the VMs.
4775 # Either name_pattern or per_instance_properties
4776 # must be set. The pattern must contain one continuous sequence of
4777 # placeholder hash characters (#) with each character corresponding to one
4778 # digit of the generated instance name. Example: a name_pattern
4779 # of inst-#### generates instance names such asinst-0001 and inst-0002. If existing instances
4780 # in the same project and zone have names that match the name pattern
4781 # then the generated instance numbers start after the biggest
4782 # 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
4783 # placeholder #...# can contain up to 18 characters.
4784 &quot;perInstanceProperties&quot;: { # Per-instance properties to be set on individual instances.
4785 # Keys of this map specify requested instance names.
4786 # Can be empty if name_pattern is used.
4787 &quot;a_key&quot;: { # Per-instance properties to be set on individual instances.
4788 # To be extended in the future.
4789 &quot;hostname&quot;: &quot;A String&quot;, # Specifies the hostname of the instance. More details in:
4790 # https://cloud.google.com/compute/docs/instances/custom-hostname-vm#naming_convention
4791 &quot;name&quot;: &quot;A String&quot;, # Output only. This field is only temporary. It will be removed. Do not use it.
4792 },
4793 },
4794 &quot;sourceInstanceTemplate&quot;: &quot;A String&quot;, # Specifies the instance template from which to create instances. You may
4795 # combine sourceInstanceTemplate withinstanceProperties to override specific values from an
4796 # existing instance template. Bulk API follows the semantics of JSON Merge
4797 # Patch described by RFC
4798 # 7396.
4799 #
4800 # It can be a full or partial URL. For example, the following are
4801 # all valid URLs to an instance template:
4802 #
4803 #
4804 # - https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate
4805 # - projects/project/global/instanceTemplates/instanceTemplate
4806 # - global/instanceTemplates/instanceTemplate
4807 #
4808 #
4809 #
4810 # This field is optional.
4811 }
4812
4813 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
4814 that if you must retry your request, the server will know to ignore the
4815 request if it has already been completed.
4816
4817 For example, consider a situation where you make an initial request and
4818 the request times out. If you make the request again with the same
4819 request ID, the server can check if original operation with the same
4820 request ID was received, and if so, will ignore the second request. This
4821 prevents clients from accidentally creating duplicate commitments.
4822
4823 The request ID must be
4824 a valid UUID with the exception that zero UUID is not supported
4825 (00000000-0000-0000-0000-000000000000).
4826 x__xgafv: string, V1 error format.
4827 Allowed values
4828 1 - v1 error format
4829 2 - v2 error format
4830
4831 Returns:
4832 An object of the form:
4833
4834 { # Represents an Operation resource.
4835 #
4836 # Google Compute Engine has three Operation resources:
4837 #
4838 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
4839 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
4840 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
4841 #
4842 # You can use an operation resource to manage asynchronous API requests.
4843 # For more information, readHandling
4844 # API responses.
4845 #
4846 # Operations can be global, regional or zonal.
4847 #
4848 # - For global operations, use the `globalOperations`
4849 # resource.
4850 # - For regional operations, use the
4851 # `regionOperations` resource.
4852 # - For zonal operations, use
4853 # the `zoneOperations` resource.
4854 #
4855 #
4856 #
4857 # For more information, read
4858 # Global, Regional, and Zonal Resources.
4859 #
4860 # Note that completed Operation resources have a limited
4861 # retention period.
4862 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
4863 # Not present otherwise.
4864 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
4865 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
4866 # set when the operation is created.
4867 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
4868 # text format.
4869 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
4870 # this field will be populated.
4871 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
4872 # operation.
4873 {
4874 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
4875 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
4876 # details. There is a set of defined message types to use for providing
4877 # details.The syntax depends on the error code. For example,
4878 # QuotaExceededInfo will have details when the error code is
4879 # QUOTA_EXCEEDED.
4880 {
4881 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
4882 #
4883 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
4884 # is not enabled:
4885 #
4886 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
4887 # &quot;domain&quot;: &quot;googleapis.com&quot;
4888 # &quot;metadata&quot;: {
4889 # &quot;resource&quot;: &quot;projects/123&quot;,
4890 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
4891 # }
4892 # }
4893 #
4894 # This response indicates that the pubsub.googleapis.com API is not enabled.
4895 #
4896 # Example of an error that is returned when attempting to create a Spanner
4897 # instance in a region that is out of stock:
4898 #
4899 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
4900 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
4901 # &quot;metadata&quot;: {
4902 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
4903 # }
4904 # }
4905 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
4906 # is typically the registered service name of the tool or product that
4907 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
4908 # generated by some common infrastructure, the error domain must be a
4909 # globally unique value that identifies the infrastructure. For Google API
4910 # infrastructure, the error domain is &quot;googleapis.com&quot;.
4911 &quot;metadatas&quot;: { # Additional structured details about this error.
4912 #
4913 # Keys must match a regular expression of `a-z+` but should
4914 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
4915 # length. When identifying the current value of an exceeded limit, the units
4916 # should be contained in the key, not the value. For example, rather than
4917 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
4918 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
4919 # instances that can be created in a single (batch) request.
4920 &quot;a_key&quot;: &quot;A String&quot;,
4921 },
4922 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
4923 # proximate cause of the error. Error reasons are unique within a particular
4924 # domain of errors. This should be at most 63 characters and match a
4925 # regular expression of `A-Z+[A-Z0-9]`, which represents
4926 # UPPER_SNAKE_CASE.
4927 },
4928 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
4929 #
4930 # For example, if a quota check failed with an error indicating the calling
4931 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
4932 # directly to the right place in the developer console to flip the bit.
4933 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
4934 { # Describes a URL link.
4935 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
4936 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
4937 },
4938 ],
4939 },
4940 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
4941 # which can be attached to an RPC error.
4942 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
4943 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
4944 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
4945 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
4946 },
4947 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
4948 &quot;dimensions&quot;: { # The map holding related quota dimensions.
4949 &quot;a_key&quot;: &quot;A String&quot;,
4950 },
4951 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
4952 # type or metric.
4953 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
4954 # or metric.
4955 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
4956 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
4957 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
4958 },
4959 },
4960 ],
4961 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
4962 # This property is optional.
4963 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
4964 },
4965 ],
4966 },
4967 &quot;getVersionOperationMetadata&quot;: {
4968 &quot;inlineSbomInfo&quot;: {
4969 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
4970 # appropriate identifiers.
4971 &quot;a_key&quot;: &quot;A String&quot;,
4972 },
4973 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
4974 # identifiers.
4975 &quot;a_key&quot;: &quot;A String&quot;,
4976 },
4977 },
4978 },
4979 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
4980 # message that was returned, such as `NOT FOUND`.
4981 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
4982 # status code that was returned. For example, a `404` means the
4983 # resource was not found.
4984 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
4985 # defined by the server.
4986 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
4987 # This value is inRFC3339
4988 # text format.
4989 &quot;instancesBulkInsertOperationMetadata&quot;: {
4990 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
4991 # Example key: zones/us-central1-a
4992 &quot;a_key&quot;: {
4993 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
4994 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
4995 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
4996 # error.
4997 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
4998 # if the flow is rolling forward or rolling back.
4999 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
5000 },
5001 },
5002 },
5003 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
5004 # Operation resources.
5005 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
5006 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
5007 # group of operations results from a `bulkInsert` API request.
5008 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
5009 # `update`, or `delete`, and so on.
5010 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
5011 # There is no requirement that this be linear or support any granularity of
5012 # operations. This should not be used to guess when the operation will be
5013 # complete. This number should monotonically increase as the operation
5014 # progresses.
5015 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
5016 # applicable when performing regional operations.
5017 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
5018 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
5019 # this field will contain information on all underlying zonal actions and
5020 # their state.
5021 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
5022 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
5023 # Example key: zones/us-central1-a
5024 &quot;a_key&quot;: {
5025 &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
5026 # populated.
5027 # different programming environments, including REST APIs and RPC APIs. It is
5028 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
5029 # three pieces of data: error code, error message, and error details.
5030 #
5031 # You can find out more about this error model and how to work with it in the
5032 # [API Design Guide](https://cloud.google.com/apis/design/errors).
5033 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
5034 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
5035 # message types for APIs to use.
5036 {
5037 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
5038 },
5039 ],
5040 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
5041 # user-facing error message should be localized and sent in the
5042 # google.rpc.Status.details field, or localized by the client.
5043 },
5044 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
5045 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
5046 },
5047 },
5048 },
5049 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
5050 # This value is inRFC3339
5051 # text format.
5052 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
5053 # following:
5054 # `PENDING`, `RUNNING`, or `DONE`.
5055 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
5056 # operation.
5057 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
5058 # of the target resource.
5059 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
5060 # operations related to creating a snapshot, this points to the disk
5061 # that the snapshot was created from.
5062 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
5063 # `[email protected]` or
5064 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
5065 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
5066 # operation, this field will be populated.
5067 {
5068 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
5069 # Engine returns NO_RESULTS_ON_PAGE if there
5070 # are no results in the response.
5071 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
5072 # value format. For example:
5073 #
5074 # &quot;data&quot;: [
5075 # {
5076 # &quot;key&quot;: &quot;scope&quot;,
5077 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
5078 # }
5079 {
5080 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
5081 # returned. For example, for warnings where there are no results in a list
5082 # request for a particular zone, this key might be scope and
5083 # the key value might be the zone name. Other examples might be a key
5084 # indicating a deprecated resource and a suggested replacement, or a
5085 # warning about invalid network settings (for example, if an instance
5086 # attempts to perform IP forwarding but is not enabled for IP forwarding).
5087 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
5088 },
5089 ],
5090 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
5091 },
5092 ],
5093 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
5094 # applicable when performing per-zone operations.
5095 }</pre>
5096 </div>
5097
5098 <div class="method">
5099 <code class="details" id="close">close()</code>
5100 <pre>Close httplib2 connections.</pre>
5101 </div>
5102
5103 <div class="method">
5104 <code class="details" id="delete">delete(project, zone, instance, requestId=None, x__xgafv=None)</code>
5105 <pre>Deletes the specified Instance resource. For more information, seeDeleting
5106 an instance.
5107
5108 Args:
5109 project: string, Project ID for this request. (required)
5110 zone: string, The name of the zone for this request. (required)
5111 instance: string, Name of the instance resource to delete. (required)
5112 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
5113 that if you must retry your request, the server will know to ignore the
5114 request if it has already been completed.
5115
5116 For example, consider a situation where you make an initial request and
5117 the request times out. If you make the request again with the same
5118 request ID, the server can check if original operation with the same
5119 request ID was received, and if so, will ignore the second request. This
5120 prevents clients from accidentally creating duplicate commitments.
5121
5122 The request ID must be
5123 a valid UUID with the exception that zero UUID is not supported
5124 (00000000-0000-0000-0000-000000000000).
5125 x__xgafv: string, V1 error format.
5126 Allowed values
5127 1 - v1 error format
5128 2 - v2 error format
5129
5130 Returns:
5131 An object of the form:
5132
5133 { # Represents an Operation resource.
5134 #
5135 # Google Compute Engine has three Operation resources:
5136 #
5137 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
5138 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
5139 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
5140 #
5141 # You can use an operation resource to manage asynchronous API requests.
5142 # For more information, readHandling
5143 # API responses.
5144 #
5145 # Operations can be global, regional or zonal.
5146 #
5147 # - For global operations, use the `globalOperations`
5148 # resource.
5149 # - For regional operations, use the
5150 # `regionOperations` resource.
5151 # - For zonal operations, use
5152 # the `zoneOperations` resource.
5153 #
5154 #
5155 #
5156 # For more information, read
5157 # Global, Regional, and Zonal Resources.
5158 #
5159 # Note that completed Operation resources have a limited
5160 # retention period.
5161 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
5162 # Not present otherwise.
5163 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
5164 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
5165 # set when the operation is created.
5166 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
5167 # text format.
5168 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
5169 # this field will be populated.
5170 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
5171 # operation.
5172 {
5173 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
5174 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
5175 # details. There is a set of defined message types to use for providing
5176 # details.The syntax depends on the error code. For example,
5177 # QuotaExceededInfo will have details when the error code is
5178 # QUOTA_EXCEEDED.
5179 {
5180 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
5181 #
5182 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
5183 # is not enabled:
5184 #
5185 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
5186 # &quot;domain&quot;: &quot;googleapis.com&quot;
5187 # &quot;metadata&quot;: {
5188 # &quot;resource&quot;: &quot;projects/123&quot;,
5189 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
5190 # }
5191 # }
5192 #
5193 # This response indicates that the pubsub.googleapis.com API is not enabled.
5194 #
5195 # Example of an error that is returned when attempting to create a Spanner
5196 # instance in a region that is out of stock:
5197 #
5198 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
5199 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
5200 # &quot;metadata&quot;: {
5201 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
5202 # }
5203 # }
5204 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
5205 # is typically the registered service name of the tool or product that
5206 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
5207 # generated by some common infrastructure, the error domain must be a
5208 # globally unique value that identifies the infrastructure. For Google API
5209 # infrastructure, the error domain is &quot;googleapis.com&quot;.
5210 &quot;metadatas&quot;: { # Additional structured details about this error.
5211 #
5212 # Keys must match a regular expression of `a-z+` but should
5213 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
5214 # length. When identifying the current value of an exceeded limit, the units
5215 # should be contained in the key, not the value. For example, rather than
5216 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
5217 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
5218 # instances that can be created in a single (batch) request.
5219 &quot;a_key&quot;: &quot;A String&quot;,
5220 },
5221 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
5222 # proximate cause of the error. Error reasons are unique within a particular
5223 # domain of errors. This should be at most 63 characters and match a
5224 # regular expression of `A-Z+[A-Z0-9]`, which represents
5225 # UPPER_SNAKE_CASE.
5226 },
5227 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
5228 #
5229 # For example, if a quota check failed with an error indicating the calling
5230 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
5231 # directly to the right place in the developer console to flip the bit.
5232 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
5233 { # Describes a URL link.
5234 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
5235 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
5236 },
5237 ],
5238 },
5239 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
5240 # which can be attached to an RPC error.
5241 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
5242 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
5243 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
5244 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
5245 },
5246 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
5247 &quot;dimensions&quot;: { # The map holding related quota dimensions.
5248 &quot;a_key&quot;: &quot;A String&quot;,
5249 },
5250 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
5251 # type or metric.
5252 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
5253 # or metric.
5254 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
5255 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
5256 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
5257 },
5258 },
5259 ],
5260 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
5261 # This property is optional.
5262 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
5263 },
5264 ],
5265 },
5266 &quot;getVersionOperationMetadata&quot;: {
5267 &quot;inlineSbomInfo&quot;: {
5268 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
5269 # appropriate identifiers.
5270 &quot;a_key&quot;: &quot;A String&quot;,
5271 },
5272 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
5273 # identifiers.
5274 &quot;a_key&quot;: &quot;A String&quot;,
5275 },
5276 },
5277 },
5278 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
5279 # message that was returned, such as `NOT FOUND`.
5280 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
5281 # status code that was returned. For example, a `404` means the
5282 # resource was not found.
5283 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
5284 # defined by the server.
5285 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
5286 # This value is inRFC3339
5287 # text format.
5288 &quot;instancesBulkInsertOperationMetadata&quot;: {
5289 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
5290 # Example key: zones/us-central1-a
5291 &quot;a_key&quot;: {
5292 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
5293 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
5294 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
5295 # error.
5296 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
5297 # if the flow is rolling forward or rolling back.
5298 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
5299 },
5300 },
5301 },
5302 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
5303 # Operation resources.
5304 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
5305 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
5306 # group of operations results from a `bulkInsert` API request.
5307 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
5308 # `update`, or `delete`, and so on.
5309 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
5310 # There is no requirement that this be linear or support any granularity of
5311 # operations. This should not be used to guess when the operation will be
5312 # complete. This number should monotonically increase as the operation
5313 # progresses.
5314 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
5315 # applicable when performing regional operations.
5316 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
5317 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
5318 # this field will contain information on all underlying zonal actions and
5319 # their state.
5320 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
5321 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
5322 # Example key: zones/us-central1-a
5323 &quot;a_key&quot;: {
5324 &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
5325 # populated.
5326 # different programming environments, including REST APIs and RPC APIs. It is
5327 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
5328 # three pieces of data: error code, error message, and error details.
5329 #
5330 # You can find out more about this error model and how to work with it in the
5331 # [API Design Guide](https://cloud.google.com/apis/design/errors).
5332 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
5333 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
5334 # message types for APIs to use.
5335 {
5336 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
5337 },
5338 ],
5339 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
5340 # user-facing error message should be localized and sent in the
5341 # google.rpc.Status.details field, or localized by the client.
5342 },
5343 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
5344 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
5345 },
5346 },
5347 },
5348 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
5349 # This value is inRFC3339
5350 # text format.
5351 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
5352 # following:
5353 # `PENDING`, `RUNNING`, or `DONE`.
5354 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
5355 # operation.
5356 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
5357 # of the target resource.
5358 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
5359 # operations related to creating a snapshot, this points to the disk
5360 # that the snapshot was created from.
5361 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
5362 # `[email protected]` or
5363 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
5364 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
5365 # operation, this field will be populated.
5366 {
5367 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
5368 # Engine returns NO_RESULTS_ON_PAGE if there
5369 # are no results in the response.
5370 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
5371 # value format. For example:
5372 #
5373 # &quot;data&quot;: [
5374 # {
5375 # &quot;key&quot;: &quot;scope&quot;,
5376 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
5377 # }
5378 {
5379 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
5380 # returned. For example, for warnings where there are no results in a list
5381 # request for a particular zone, this key might be scope and
5382 # the key value might be the zone name. Other examples might be a key
5383 # indicating a deprecated resource and a suggested replacement, or a
5384 # warning about invalid network settings (for example, if an instance
5385 # attempts to perform IP forwarding but is not enabled for IP forwarding).
5386 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
5387 },
5388 ],
5389 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
5390 },
5391 ],
5392 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
5393 # applicable when performing per-zone operations.
5394 }</pre>
5395 </div>
5396
5397 <div class="method">
5398 <code class="details" id="deleteAccessConfig">deleteAccessConfig(project, zone, instance, accessConfig, networkInterface, requestId=None, x__xgafv=None)</code>
5399 <pre>Deletes an access config from an instance&#x27;s network interface.
5400
5401 Args:
5402 project: string, Project ID for this request. (required)
5403 zone: string, The name of the zone for this request. (required)
5404 instance: string, The instance name for this request. (required)
5405 accessConfig: string, The name of the access config to delete. (required)
5406 networkInterface: string, The name of the network interface. (required)
5407 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
5408 that if you must retry your request, the server will know to ignore the
5409 request if it has already been completed.
5410
5411 For example, consider a situation where you make an initial request and
5412 the request times out. If you make the request again with the same
5413 request ID, the server can check if original operation with the same
5414 request ID was received, and if so, will ignore the second request. This
5415 prevents clients from accidentally creating duplicate commitments.
5416
5417 The request ID must be
5418 a valid UUID with the exception that zero UUID is not supported
5419 (00000000-0000-0000-0000-000000000000).
5420 x__xgafv: string, V1 error format.
5421 Allowed values
5422 1 - v1 error format
5423 2 - v2 error format
5424
5425 Returns:
5426 An object of the form:
5427
5428 { # Represents an Operation resource.
5429 #
5430 # Google Compute Engine has three Operation resources:
5431 #
5432 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
5433 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
5434 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
5435 #
5436 # You can use an operation resource to manage asynchronous API requests.
5437 # For more information, readHandling
5438 # API responses.
5439 #
5440 # Operations can be global, regional or zonal.
5441 #
5442 # - For global operations, use the `globalOperations`
5443 # resource.
5444 # - For regional operations, use the
5445 # `regionOperations` resource.
5446 # - For zonal operations, use
5447 # the `zoneOperations` resource.
5448 #
5449 #
5450 #
5451 # For more information, read
5452 # Global, Regional, and Zonal Resources.
5453 #
5454 # Note that completed Operation resources have a limited
5455 # retention period.
5456 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
5457 # Not present otherwise.
5458 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
5459 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
5460 # set when the operation is created.
5461 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
5462 # text format.
5463 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
5464 # this field will be populated.
5465 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
5466 # operation.
5467 {
5468 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
5469 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
5470 # details. There is a set of defined message types to use for providing
5471 # details.The syntax depends on the error code. For example,
5472 # QuotaExceededInfo will have details when the error code is
5473 # QUOTA_EXCEEDED.
5474 {
5475 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
5476 #
5477 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
5478 # is not enabled:
5479 #
5480 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
5481 # &quot;domain&quot;: &quot;googleapis.com&quot;
5482 # &quot;metadata&quot;: {
5483 # &quot;resource&quot;: &quot;projects/123&quot;,
5484 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
5485 # }
5486 # }
5487 #
5488 # This response indicates that the pubsub.googleapis.com API is not enabled.
5489 #
5490 # Example of an error that is returned when attempting to create a Spanner
5491 # instance in a region that is out of stock:
5492 #
5493 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
5494 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
5495 # &quot;metadata&quot;: {
5496 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
5497 # }
5498 # }
5499 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
5500 # is typically the registered service name of the tool or product that
5501 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
5502 # generated by some common infrastructure, the error domain must be a
5503 # globally unique value that identifies the infrastructure. For Google API
5504 # infrastructure, the error domain is &quot;googleapis.com&quot;.
5505 &quot;metadatas&quot;: { # Additional structured details about this error.
5506 #
5507 # Keys must match a regular expression of `a-z+` but should
5508 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
5509 # length. When identifying the current value of an exceeded limit, the units
5510 # should be contained in the key, not the value. For example, rather than
5511 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
5512 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
5513 # instances that can be created in a single (batch) request.
5514 &quot;a_key&quot;: &quot;A String&quot;,
5515 },
5516 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
5517 # proximate cause of the error. Error reasons are unique within a particular
5518 # domain of errors. This should be at most 63 characters and match a
5519 # regular expression of `A-Z+[A-Z0-9]`, which represents
5520 # UPPER_SNAKE_CASE.
5521 },
5522 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
5523 #
5524 # For example, if a quota check failed with an error indicating the calling
5525 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
5526 # directly to the right place in the developer console to flip the bit.
5527 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
5528 { # Describes a URL link.
5529 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
5530 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
5531 },
5532 ],
5533 },
5534 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
5535 # which can be attached to an RPC error.
5536 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
5537 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
5538 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
5539 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
5540 },
5541 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
5542 &quot;dimensions&quot;: { # The map holding related quota dimensions.
5543 &quot;a_key&quot;: &quot;A String&quot;,
5544 },
5545 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
5546 # type or metric.
5547 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
5548 # or metric.
5549 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
5550 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
5551 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
5552 },
5553 },
5554 ],
5555 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
5556 # This property is optional.
5557 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
5558 },
5559 ],
5560 },
5561 &quot;getVersionOperationMetadata&quot;: {
5562 &quot;inlineSbomInfo&quot;: {
5563 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
5564 # appropriate identifiers.
5565 &quot;a_key&quot;: &quot;A String&quot;,
5566 },
5567 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
5568 # identifiers.
5569 &quot;a_key&quot;: &quot;A String&quot;,
5570 },
5571 },
5572 },
5573 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
5574 # message that was returned, such as `NOT FOUND`.
5575 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
5576 # status code that was returned. For example, a `404` means the
5577 # resource was not found.
5578 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
5579 # defined by the server.
5580 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
5581 # This value is inRFC3339
5582 # text format.
5583 &quot;instancesBulkInsertOperationMetadata&quot;: {
5584 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
5585 # Example key: zones/us-central1-a
5586 &quot;a_key&quot;: {
5587 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
5588 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
5589 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
5590 # error.
5591 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
5592 # if the flow is rolling forward or rolling back.
5593 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
5594 },
5595 },
5596 },
5597 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
5598 # Operation resources.
5599 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
5600 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
5601 # group of operations results from a `bulkInsert` API request.
5602 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
5603 # `update`, or `delete`, and so on.
5604 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
5605 # There is no requirement that this be linear or support any granularity of
5606 # operations. This should not be used to guess when the operation will be
5607 # complete. This number should monotonically increase as the operation
5608 # progresses.
5609 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
5610 # applicable when performing regional operations.
5611 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
5612 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
5613 # this field will contain information on all underlying zonal actions and
5614 # their state.
5615 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
5616 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
5617 # Example key: zones/us-central1-a
5618 &quot;a_key&quot;: {
5619 &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
5620 # populated.
5621 # different programming environments, including REST APIs and RPC APIs. It is
5622 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
5623 # three pieces of data: error code, error message, and error details.
5624 #
5625 # You can find out more about this error model and how to work with it in the
5626 # [API Design Guide](https://cloud.google.com/apis/design/errors).
5627 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
5628 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
5629 # message types for APIs to use.
5630 {
5631 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
5632 },
5633 ],
5634 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
5635 # user-facing error message should be localized and sent in the
5636 # google.rpc.Status.details field, or localized by the client.
5637 },
5638 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
5639 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
5640 },
5641 },
5642 },
5643 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
5644 # This value is inRFC3339
5645 # text format.
5646 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
5647 # following:
5648 # `PENDING`, `RUNNING`, or `DONE`.
5649 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
5650 # operation.
5651 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
5652 # of the target resource.
5653 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
5654 # operations related to creating a snapshot, this points to the disk
5655 # that the snapshot was created from.
5656 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
5657 # `[email protected]` or
5658 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
5659 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
5660 # operation, this field will be populated.
5661 {
5662 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
5663 # Engine returns NO_RESULTS_ON_PAGE if there
5664 # are no results in the response.
5665 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
5666 # value format. For example:
5667 #
5668 # &quot;data&quot;: [
5669 # {
5670 # &quot;key&quot;: &quot;scope&quot;,
5671 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
5672 # }
5673 {
5674 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
5675 # returned. For example, for warnings where there are no results in a list
5676 # request for a particular zone, this key might be scope and
5677 # the key value might be the zone name. Other examples might be a key
5678 # indicating a deprecated resource and a suggested replacement, or a
5679 # warning about invalid network settings (for example, if an instance
5680 # attempts to perform IP forwarding but is not enabled for IP forwarding).
5681 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
5682 },
5683 ],
5684 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
5685 },
5686 ],
5687 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
5688 # applicable when performing per-zone operations.
5689 }</pre>
5690 </div>
5691
5692 <div class="method">
5693 <code class="details" id="deleteNetworkInterface">deleteNetworkInterface(project, zone, instance, networkInterfaceName, requestId=None, x__xgafv=None)</code>
5694 <pre>Deletes one dynamic network interface from an active instance.
5695 InstancesDeleteNetworkInterfaceRequest indicates:
5696 - instance from which to delete, using project+zone+resource_id fields;
5697 - dynamic network interface to be deleted, using network_interface_name
5698 field;
5699
5700 Args:
5701 project: string, Project ID for this request. (required)
5702 zone: string, The name of the zone for this request. (required)
5703 instance: string, The instance name for this request stored as resource_id.
5704 Name should conform to RFC1035 or be an unsigned long integer. (required)
5705 networkInterfaceName: string, The name of the dynamic network interface to be deleted from the instance. (required)
5706 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
5707 that if you must retry your request, the server will know to ignore the
5708 request if it has already been completed.
5709
5710 For example, consider a situation where you make an initial request and
5711 the request times out. If you make the request again with the same
5712 request ID, the server can check if original operation with the same
5713 request ID was received, and if so, will ignore the second request. This
5714 prevents clients from accidentally creating duplicate commitments.
5715
5716 The request ID must be
5717 a valid UUID with the exception that zero UUID is not supported
5718 (00000000-0000-0000-0000-000000000000).
5719 x__xgafv: string, V1 error format.
5720 Allowed values
5721 1 - v1 error format
5722 2 - v2 error format
5723
5724 Returns:
5725 An object of the form:
5726
5727 { # Represents an Operation resource.
5728 #
5729 # Google Compute Engine has three Operation resources:
5730 #
5731 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
5732 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
5733 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
5734 #
5735 # You can use an operation resource to manage asynchronous API requests.
5736 # For more information, readHandling
5737 # API responses.
5738 #
5739 # Operations can be global, regional or zonal.
5740 #
5741 # - For global operations, use the `globalOperations`
5742 # resource.
5743 # - For regional operations, use the
5744 # `regionOperations` resource.
5745 # - For zonal operations, use
5746 # the `zoneOperations` resource.
5747 #
5748 #
5749 #
5750 # For more information, read
5751 # Global, Regional, and Zonal Resources.
5752 #
5753 # Note that completed Operation resources have a limited
5754 # retention period.
5755 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
5756 # Not present otherwise.
5757 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
5758 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
5759 # set when the operation is created.
5760 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
5761 # text format.
5762 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
5763 # this field will be populated.
5764 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
5765 # operation.
5766 {
5767 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
5768 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
5769 # details. There is a set of defined message types to use for providing
5770 # details.The syntax depends on the error code. For example,
5771 # QuotaExceededInfo will have details when the error code is
5772 # QUOTA_EXCEEDED.
5773 {
5774 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
5775 #
5776 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
5777 # is not enabled:
5778 #
5779 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
5780 # &quot;domain&quot;: &quot;googleapis.com&quot;
5781 # &quot;metadata&quot;: {
5782 # &quot;resource&quot;: &quot;projects/123&quot;,
5783 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
5784 # }
5785 # }
5786 #
5787 # This response indicates that the pubsub.googleapis.com API is not enabled.
5788 #
5789 # Example of an error that is returned when attempting to create a Spanner
5790 # instance in a region that is out of stock:
5791 #
5792 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
5793 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
5794 # &quot;metadata&quot;: {
5795 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
5796 # }
5797 # }
5798 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
5799 # is typically the registered service name of the tool or product that
5800 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
5801 # generated by some common infrastructure, the error domain must be a
5802 # globally unique value that identifies the infrastructure. For Google API
5803 # infrastructure, the error domain is &quot;googleapis.com&quot;.
5804 &quot;metadatas&quot;: { # Additional structured details about this error.
5805 #
5806 # Keys must match a regular expression of `a-z+` but should
5807 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
5808 # length. When identifying the current value of an exceeded limit, the units
5809 # should be contained in the key, not the value. For example, rather than
5810 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
5811 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
5812 # instances that can be created in a single (batch) request.
5813 &quot;a_key&quot;: &quot;A String&quot;,
5814 },
5815 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
5816 # proximate cause of the error. Error reasons are unique within a particular
5817 # domain of errors. This should be at most 63 characters and match a
5818 # regular expression of `A-Z+[A-Z0-9]`, which represents
5819 # UPPER_SNAKE_CASE.
5820 },
5821 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
5822 #
5823 # For example, if a quota check failed with an error indicating the calling
5824 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
5825 # directly to the right place in the developer console to flip the bit.
5826 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
5827 { # Describes a URL link.
5828 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
5829 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
5830 },
5831 ],
5832 },
5833 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
5834 # which can be attached to an RPC error.
5835 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
5836 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
5837 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
5838 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
5839 },
5840 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
5841 &quot;dimensions&quot;: { # The map holding related quota dimensions.
5842 &quot;a_key&quot;: &quot;A String&quot;,
5843 },
5844 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
5845 # type or metric.
5846 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
5847 # or metric.
5848 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
5849 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
5850 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
5851 },
5852 },
5853 ],
5854 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
5855 # This property is optional.
5856 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
5857 },
5858 ],
5859 },
5860 &quot;getVersionOperationMetadata&quot;: {
5861 &quot;inlineSbomInfo&quot;: {
5862 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
5863 # appropriate identifiers.
5864 &quot;a_key&quot;: &quot;A String&quot;,
5865 },
5866 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
5867 # identifiers.
5868 &quot;a_key&quot;: &quot;A String&quot;,
5869 },
5870 },
5871 },
5872 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
5873 # message that was returned, such as `NOT FOUND`.
5874 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
5875 # status code that was returned. For example, a `404` means the
5876 # resource was not found.
5877 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
5878 # defined by the server.
5879 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
5880 # This value is inRFC3339
5881 # text format.
5882 &quot;instancesBulkInsertOperationMetadata&quot;: {
5883 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
5884 # Example key: zones/us-central1-a
5885 &quot;a_key&quot;: {
5886 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
5887 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
5888 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
5889 # error.
5890 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
5891 # if the flow is rolling forward or rolling back.
5892 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
5893 },
5894 },
5895 },
5896 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
5897 # Operation resources.
5898 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
5899 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
5900 # group of operations results from a `bulkInsert` API request.
5901 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
5902 # `update`, or `delete`, and so on.
5903 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
5904 # There is no requirement that this be linear or support any granularity of
5905 # operations. This should not be used to guess when the operation will be
5906 # complete. This number should monotonically increase as the operation
5907 # progresses.
5908 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
5909 # applicable when performing regional operations.
5910 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
5911 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
5912 # this field will contain information on all underlying zonal actions and
5913 # their state.
5914 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
5915 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
5916 # Example key: zones/us-central1-a
5917 &quot;a_key&quot;: {
5918 &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
5919 # populated.
5920 # different programming environments, including REST APIs and RPC APIs. It is
5921 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
5922 # three pieces of data: error code, error message, and error details.
5923 #
5924 # You can find out more about this error model and how to work with it in the
5925 # [API Design Guide](https://cloud.google.com/apis/design/errors).
5926 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
5927 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
5928 # message types for APIs to use.
5929 {
5930 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
5931 },
5932 ],
5933 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
5934 # user-facing error message should be localized and sent in the
5935 # google.rpc.Status.details field, or localized by the client.
5936 },
5937 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
5938 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
5939 },
5940 },
5941 },
5942 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
5943 # This value is inRFC3339
5944 # text format.
5945 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
5946 # following:
5947 # `PENDING`, `RUNNING`, or `DONE`.
5948 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
5949 # operation.
5950 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
5951 # of the target resource.
5952 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
5953 # operations related to creating a snapshot, this points to the disk
5954 # that the snapshot was created from.
5955 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
5956 # `[email protected]` or
5957 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
5958 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
5959 # operation, this field will be populated.
5960 {
5961 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
5962 # Engine returns NO_RESULTS_ON_PAGE if there
5963 # are no results in the response.
5964 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
5965 # value format. For example:
5966 #
5967 # &quot;data&quot;: [
5968 # {
5969 # &quot;key&quot;: &quot;scope&quot;,
5970 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
5971 # }
5972 {
5973 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
5974 # returned. For example, for warnings where there are no results in a list
5975 # request for a particular zone, this key might be scope and
5976 # the key value might be the zone name. Other examples might be a key
5977 # indicating a deprecated resource and a suggested replacement, or a
5978 # warning about invalid network settings (for example, if an instance
5979 # attempts to perform IP forwarding but is not enabled for IP forwarding).
5980 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
5981 },
5982 ],
5983 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
5984 },
5985 ],
5986 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
5987 # applicable when performing per-zone operations.
5988 }</pre>
5989 </div>
5990
5991 <div class="method">
5992 <code class="details" id="detachDisk">detachDisk(project, zone, instance, deviceName, requestId=None, x__xgafv=None)</code>
5993 <pre>Detaches a disk from an instance.
5994
5995 Args:
5996 project: string, Project ID for this request. (required)
5997 zone: string, The name of the zone for this request. (required)
5998 instance: string, Instance name for this request. (required)
5999 deviceName: string, The device name of the disk to detach. Make a get() request on
6000 the instance to view currently attached disks and device names. (required)
6001 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
6002 that if you must retry your request, the server will know to ignore the
6003 request if it has already been completed.
6004
6005 For example, consider a situation where you make an initial request and
6006 the request times out. If you make the request again with the same
6007 request ID, the server can check if original operation with the same
6008 request ID was received, and if so, will ignore the second request. This
6009 prevents clients from accidentally creating duplicate commitments.
6010
6011 The request ID must be
6012 a valid UUID with the exception that zero UUID is not supported
6013 (00000000-0000-0000-0000-000000000000).
6014 x__xgafv: string, V1 error format.
6015 Allowed values
6016 1 - v1 error format
6017 2 - v2 error format
6018
6019 Returns:
6020 An object of the form:
6021
6022 { # Represents an Operation resource.
6023 #
6024 # Google Compute Engine has three Operation resources:
6025 #
6026 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
6027 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
6028 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
6029 #
6030 # You can use an operation resource to manage asynchronous API requests.
6031 # For more information, readHandling
6032 # API responses.
6033 #
6034 # Operations can be global, regional or zonal.
6035 #
6036 # - For global operations, use the `globalOperations`
6037 # resource.
6038 # - For regional operations, use the
6039 # `regionOperations` resource.
6040 # - For zonal operations, use
6041 # the `zoneOperations` resource.
6042 #
6043 #
6044 #
6045 # For more information, read
6046 # Global, Regional, and Zonal Resources.
6047 #
6048 # Note that completed Operation resources have a limited
6049 # retention period.
6050 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
6051 # Not present otherwise.
6052 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
6053 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
6054 # set when the operation is created.
6055 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
6056 # text format.
6057 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
6058 # this field will be populated.
6059 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
6060 # operation.
6061 {
6062 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
6063 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
6064 # details. There is a set of defined message types to use for providing
6065 # details.The syntax depends on the error code. For example,
6066 # QuotaExceededInfo will have details when the error code is
6067 # QUOTA_EXCEEDED.
6068 {
6069 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
6070 #
6071 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
6072 # is not enabled:
6073 #
6074 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
6075 # &quot;domain&quot;: &quot;googleapis.com&quot;
6076 # &quot;metadata&quot;: {
6077 # &quot;resource&quot;: &quot;projects/123&quot;,
6078 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
6079 # }
6080 # }
6081 #
6082 # This response indicates that the pubsub.googleapis.com API is not enabled.
6083 #
6084 # Example of an error that is returned when attempting to create a Spanner
6085 # instance in a region that is out of stock:
6086 #
6087 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
6088 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
6089 # &quot;metadata&quot;: {
6090 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
6091 # }
6092 # }
6093 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
6094 # is typically the registered service name of the tool or product that
6095 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
6096 # generated by some common infrastructure, the error domain must be a
6097 # globally unique value that identifies the infrastructure. For Google API
6098 # infrastructure, the error domain is &quot;googleapis.com&quot;.
6099 &quot;metadatas&quot;: { # Additional structured details about this error.
6100 #
6101 # Keys must match a regular expression of `a-z+` but should
6102 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
6103 # length. When identifying the current value of an exceeded limit, the units
6104 # should be contained in the key, not the value. For example, rather than
6105 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
6106 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
6107 # instances that can be created in a single (batch) request.
6108 &quot;a_key&quot;: &quot;A String&quot;,
6109 },
6110 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
6111 # proximate cause of the error. Error reasons are unique within a particular
6112 # domain of errors. This should be at most 63 characters and match a
6113 # regular expression of `A-Z+[A-Z0-9]`, which represents
6114 # UPPER_SNAKE_CASE.
6115 },
6116 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
6117 #
6118 # For example, if a quota check failed with an error indicating the calling
6119 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
6120 # directly to the right place in the developer console to flip the bit.
6121 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
6122 { # Describes a URL link.
6123 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
6124 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
6125 },
6126 ],
6127 },
6128 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
6129 # which can be attached to an RPC error.
6130 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
6131 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
6132 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
6133 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
6134 },
6135 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
6136 &quot;dimensions&quot;: { # The map holding related quota dimensions.
6137 &quot;a_key&quot;: &quot;A String&quot;,
6138 },
6139 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
6140 # type or metric.
6141 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
6142 # or metric.
6143 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
6144 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
6145 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
6146 },
6147 },
6148 ],
6149 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
6150 # This property is optional.
6151 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
6152 },
6153 ],
6154 },
6155 &quot;getVersionOperationMetadata&quot;: {
6156 &quot;inlineSbomInfo&quot;: {
6157 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
6158 # appropriate identifiers.
6159 &quot;a_key&quot;: &quot;A String&quot;,
6160 },
6161 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
6162 # identifiers.
6163 &quot;a_key&quot;: &quot;A String&quot;,
6164 },
6165 },
6166 },
6167 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
6168 # message that was returned, such as `NOT FOUND`.
6169 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
6170 # status code that was returned. For example, a `404` means the
6171 # resource was not found.
6172 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
6173 # defined by the server.
6174 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
6175 # This value is inRFC3339
6176 # text format.
6177 &quot;instancesBulkInsertOperationMetadata&quot;: {
6178 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
6179 # Example key: zones/us-central1-a
6180 &quot;a_key&quot;: {
6181 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
6182 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
6183 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
6184 # error.
6185 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
6186 # if the flow is rolling forward or rolling back.
6187 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
6188 },
6189 },
6190 },
6191 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
6192 # Operation resources.
6193 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
6194 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
6195 # group of operations results from a `bulkInsert` API request.
6196 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
6197 # `update`, or `delete`, and so on.
6198 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
6199 # There is no requirement that this be linear or support any granularity of
6200 # operations. This should not be used to guess when the operation will be
6201 # complete. This number should monotonically increase as the operation
6202 # progresses.
6203 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
6204 # applicable when performing regional operations.
6205 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
6206 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
6207 # this field will contain information on all underlying zonal actions and
6208 # their state.
6209 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
6210 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
6211 # Example key: zones/us-central1-a
6212 &quot;a_key&quot;: {
6213 &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
6214 # populated.
6215 # different programming environments, including REST APIs and RPC APIs. It is
6216 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
6217 # three pieces of data: error code, error message, and error details.
6218 #
6219 # You can find out more about this error model and how to work with it in the
6220 # [API Design Guide](https://cloud.google.com/apis/design/errors).
6221 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
6222 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
6223 # message types for APIs to use.
6224 {
6225 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
6226 },
6227 ],
6228 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
6229 # user-facing error message should be localized and sent in the
6230 # google.rpc.Status.details field, or localized by the client.
6231 },
6232 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
6233 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
6234 },
6235 },
6236 },
6237 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
6238 # This value is inRFC3339
6239 # text format.
6240 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
6241 # following:
6242 # `PENDING`, `RUNNING`, or `DONE`.
6243 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
6244 # operation.
6245 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
6246 # of the target resource.
6247 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
6248 # operations related to creating a snapshot, this points to the disk
6249 # that the snapshot was created from.
6250 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
6251 # `[email protected]` or
6252 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
6253 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
6254 # operation, this field will be populated.
6255 {
6256 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
6257 # Engine returns NO_RESULTS_ON_PAGE if there
6258 # are no results in the response.
6259 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
6260 # value format. For example:
6261 #
6262 # &quot;data&quot;: [
6263 # {
6264 # &quot;key&quot;: &quot;scope&quot;,
6265 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
6266 # }
6267 {
6268 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
6269 # returned. For example, for warnings where there are no results in a list
6270 # request for a particular zone, this key might be scope and
6271 # the key value might be the zone name. Other examples might be a key
6272 # indicating a deprecated resource and a suggested replacement, or a
6273 # warning about invalid network settings (for example, if an instance
6274 # attempts to perform IP forwarding but is not enabled for IP forwarding).
6275 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
6276 },
6277 ],
6278 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
6279 },
6280 ],
6281 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
6282 # applicable when performing per-zone operations.
6283 }</pre>
6284 </div>
6285
6286 <div class="method">
6287 <code class="details" id="get">get(project, zone, instance, x__xgafv=None)</code>
6288 <pre>Returns the specified Instance resource.
6289
6290 Args:
6291 project: string, Project ID for this request. (required)
6292 zone: string, The name of the zone for this request. (required)
6293 instance: string, Name of the instance resource to return. (required)
6294 x__xgafv: string, V1 error format.
6295 Allowed values
6296 1 - v1 error format
6297 2 - v2 error format
6298
6299 Returns:
6300 An object of the form:
6301
6302 { # Represents an Instance resource.
6303 #
6304 # An instance is a virtual machine that is hosted on Google Cloud Platform.
6305 # For more information, readVirtual Machine Instances.
6306 &quot;advancedMachineFeatures&quot;: { # Specifies options for controlling advanced machine features. # Controls for advanced machine-related behavior features.
6307 # Options that would traditionally be configured in a BIOS belong
6308 # here. Features that require operating system support may have
6309 # corresponding entries in the GuestOsFeatures of anImage (e.g., whether or not the OS in theImage supports nested virtualization being enabled or
6310 # disabled).
6311 &quot;enableNestedVirtualization&quot;: True or False, # Whether to enable nested virtualization or not (default is false).
6312 &quot;enableUefiNetworking&quot;: True or False, # Whether to enable UEFI networking for instance creation.
6313 &quot;performanceMonitoringUnit&quot;: &quot;A String&quot;, # Type of Performance Monitoring Unit requested on instance.
6314 &quot;threadsPerCore&quot;: 42, # The number of threads per physical core. To disable simultaneous
6315 # multithreading (SMT) set this to 1. If unset, the maximum number
6316 # of threads supported per core by the underlying processor is
6317 # assumed.
6318 &quot;turboMode&quot;: &quot;A String&quot;, # Turbo frequency mode to use for the instance.
6319 # Supported modes include:
6320 # * ALL_CORE_MAX
6321 #
6322 # Using empty string or not setting this field will use the platform-specific
6323 # default turbo mode.
6324 &quot;visibleCoreCount&quot;: 42, # The number of physical cores to expose to an instance. Multiply by
6325 # the number of threads per core to compute the total number of virtual
6326 # CPUs to expose to the instance. If unset, the number of cores is
6327 # inferred from the instance&#x27;s nominal CPU count and the underlying
6328 # platform&#x27;s SMT width.
6329 },
6330 &quot;canIpForward&quot;: True or False, # Allows this instance to send and receive packets with non-matching
6331 # destination or source IPs. This is required if you plan to use this
6332 # instance to forward routes. For more information, seeEnabling IP Forwarding.
6333 &quot;confidentialInstanceConfig&quot;: { # A set of Confidential Instance options.
6334 &quot;confidentialInstanceType&quot;: &quot;A String&quot;, # Defines the type of technology used by the confidential instance.
6335 &quot;enableConfidentialCompute&quot;: True or False, # Defines whether the instance should have confidential compute enabled.
6336 },
6337 &quot;cpuPlatform&quot;: &quot;A String&quot;, # Output only. [Output Only] The CPU platform used by this instance.
6338 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339 text format.
6339 &quot;deletionProtection&quot;: True or False, # Whether the resource should be protected against deletion.
6340 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
6341 # create the resource.
6342 &quot;disks&quot;: [ # Array of disks associated with this instance. Persistent disks must be
6343 # created before you can assign them.
6344 { # An instance-attached disk resource.
6345 &quot;architecture&quot;: &quot;A String&quot;, # Output only. [Output Only] The architecture of the attached disk. Valid values are ARM64
6346 # or X86_64.
6347 &quot;autoDelete&quot;: True or False, # Specifies whether the disk will be auto-deleted when the instance is
6348 # deleted (but not when the disk is detached from the instance).
6349 &quot;boot&quot;: True or False, # Indicates that this is a boot disk. The virtual machine will use the first
6350 # partition of the disk for its root filesystem.
6351 &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
6352 # running within the instance. This name can be used to reference the device
6353 # for mounting, resizing, and so on, from within the instance.
6354 #
6355 # If not specified, the server chooses a default device name to apply to this
6356 # disk, in the form persistent-disk-x, where x is a number
6357 # assigned by Google Compute Engine. This field is only applicable for
6358 # persistent disks.
6359 &quot;diskEncryptionKey&quot;: { # Encrypts or decrypts a disk using acustomer-supplied
6360 # encryption key.
6361 #
6362 # If you are creating a new disk, this field encrypts the new disk using
6363 # an encryption key that you provide. If you are attaching an existing
6364 # disk that is already encrypted, this field decrypts the disk using
6365 # the customer-supplied encryption key.
6366 #
6367 # If you encrypt a disk using a customer-supplied key, you must provide the
6368 # same key again when you attempt to use this resource at a later time. For
6369 # example, you must provide the key when you create a snapshot or an image
6370 # from the disk or when you attach the disk to a virtual machine instance.
6371 #
6372 # If you do not provide an encryption key, then the disk will be encrypted
6373 # using an automatically generated key and you do not need to provide a key
6374 # to use the disk later.
6375 #
6376 # Note:
6377 #
6378 # Instance templates do not storecustomer-supplied
6379 # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
6380 #
6381 # You cannot create VMs that have disks with customer-supplied keys using
6382 # the bulk
6383 # insert method.
6384 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
6385 # For example:
6386 #
6387 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
6388 # key_region/cryptoKeys/key
6389 #
6390 # The fully-qualifed key name may be returned for resource GET requests. For
6391 # example:
6392 #
6393 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
6394 # key_region/cryptoKeys/key
6395 # /cryptoKeyVersions/1
6396 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
6397 # key. If absent, the Compute Engine default service account is used.
6398 # For example:
6399 #
6400 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
6401 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
6402 # encryption key, encoded in RFC
6403 # 4648 base64 to either encrypt or decrypt this resource. You can
6404 # provide either the rawKey or thersaEncryptedKey.
6405 # For example:
6406 #
6407 # &quot;rawKey&quot;:
6408 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
6409 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
6410 # customer-supplied encryption key to either encrypt or decrypt this
6411 # resource. You can provide either the rawKey or thersaEncryptedKey.
6412 # For example:
6413 #
6414 # &quot;rsaEncryptedKey&quot;:
6415 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
6416 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
6417 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
6418 #
6419 # The key must meet the following requirements before you can provide it to
6420 # Compute Engine:
6421 #
6422 # 1. The key is wrapped using a RSA public key certificate provided by
6423 # Google.
6424 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
6425 # encoding.
6426 #
6427 # Gets the RSA public key certificate provided by Google at:
6428 #
6429 #
6430 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
6431 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
6432 # 4648 base64 encoded SHA-256 hash of the customer-supplied
6433 # encryption key that protects this resource.
6434 },
6435 &quot;diskSizeGb&quot;: &quot;A String&quot;, # The size of the disk in GB.
6436 &quot;forceAttach&quot;: True or False, # [Input Only] Whether to force attach the regional disk even if it&#x27;s
6437 # currently attached to another instance. If you try to force attach a zonal
6438 # disk to an instance, you will receive an error.
6439 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
6440 # only for bootable images. Read
6441 # Enabling guest operating system features to see a list of available
6442 # options.
6443 { # Guest OS features.
6444 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
6445 # separate values. Set to one or more of the following values:
6446 #
6447 # - VIRTIO_SCSI_MULTIQUEUE
6448 # - WINDOWS
6449 # - MULTI_IP_SUBNET
6450 # - UEFI_COMPATIBLE
6451 # - GVNIC
6452 # - SEV_CAPABLE
6453 # - SUSPEND_RESUME_COMPATIBLE
6454 # - SEV_LIVE_MIGRATABLE_V2
6455 # - SEV_SNP_CAPABLE
6456 # - TDX_CAPABLE
6457 # - IDPF
6458 # - SNP_SVSM_CAPABLE
6459 # - CCA_CAPABLE
6460 #
6461 #
6462 # For more information, see
6463 # Enabling guest operating system features.
6464 },
6465 ],
6466 &quot;index&quot;: 42, # Output only. [Output Only] A zero-based index to this disk, where 0 is reserved for the
6467 # boot disk. If you have many disks attached to an instance, each
6468 # disk would have a unique index number.
6469 &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
6470 # alongside the new instance. Use initialization parameters to create boot
6471 # disks or local SSDs attached to the new instance.
6472 #
6473 # This property is mutually exclusive with the source property;
6474 # you can only define one or the other, but not both.
6475 # alongside the new instance. Use initialization parameters to create boot
6476 # disks or local SSDs attached to the new instance.
6477 #
6478 # This field is persisted and returned for instanceTemplate and not returned
6479 # in the context of instance.
6480 #
6481 # This property is mutually exclusive with the source property;
6482 # you can only define one or the other, but not both.
6483 &quot;architecture&quot;: &quot;A String&quot;, # The architecture of the attached disk. Valid values are
6484 # arm64 or x86_64.
6485 &quot;description&quot;: &quot;A String&quot;, # An optional description. Provide this property when creating the disk.
6486 &quot;diskName&quot;: &quot;A String&quot;, # Specifies the disk name. If not specified, the default is to use the name
6487 # of the instance. If a disk with the same name already exists in the given
6488 # region, the existing disk is attached to the new instance and the
6489 # new disk is not created.
6490 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB. The size must be at least
6491 # 10 GB. If you specify a sourceImage, which is required for
6492 # boot disks, the default size is the size of the sourceImage.
6493 # If you do not specify a sourceImage, the default disk size
6494 # is 500 GB.
6495 &quot;diskType&quot;: &quot;A String&quot;,
6496 &quot;enableConfidentialCompute&quot;: True or False, # Whether this disk is using confidential compute mode.
6497 &quot;labels&quot;: { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
6498 # persistent disks.
6499 &quot;a_key&quot;: &quot;A String&quot;,
6500 },
6501 &quot;licenses&quot;: [ # A list of publicly visible licenses. Reserved for Google&#x27;s use.
6502 &quot;A String&quot;,
6503 ],
6504 &quot;onUpdateAction&quot;: &quot;A String&quot;, # Specifies which action to take on instance update with this disk. Default
6505 # is to use the existing disk.
6506 &quot;provisionedIops&quot;: &quot;A String&quot;, # Indicates how many IOPS to provision for the disk. This sets the number
6507 # of I/O operations per second that the disk can handle. Values must be
6508 # between 10,000 and 120,000. For more details, see theExtreme persistent
6509 # disk documentation.
6510 &quot;provisionedThroughput&quot;: &quot;A String&quot;, # Indicates how much throughput to provision for the disk. This sets the
6511 # number of throughput mb per second that the disk can handle. Values must
6512 # greater than or equal to 1.
6513 &quot;replicaZones&quot;: [ # Required for each regional disk associated with the instance. Specify
6514 # the URLs of the zones where the disk should be replicated to.
6515 # You must provide exactly two replica zones, and one zone must be the same
6516 # as the instance zone.
6517 &quot;A String&quot;,
6518 ],
6519 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
6520 # have the same definition as resource
6521 # manager tags. Keys and values can be either in numeric format,
6522 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
6523 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
6524 # `{tag_value_short_name}`. The field is ignored (both PUT &amp; PATCH) when
6525 # empty.
6526 &quot;a_key&quot;: &quot;A String&quot;,
6527 },
6528 &quot;resourcePolicies&quot;: [ # Resource policies applied to this disk for automatic snapshot creations.
6529 # Specified using the full or partial URL. For instance template, specify
6530 # only the resource policy name.
6531 &quot;A String&quot;,
6532 ],
6533 &quot;sourceImage&quot;: &quot;A String&quot;, # The source image to create this disk. When creating a new instance boot
6534 # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
6535 # is required.
6536 #
6537 # To create a disk with one of the public operating system
6538 # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
6539 #
6540 # projects/debian-cloud/global/images/family/debian-9
6541 #
6542 #
6543 # Alternatively, use a specific version of a public operating system image:
6544 #
6545 # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
6546 #
6547 #
6548 # To create a disk with a custom image that you created, specify the
6549 # image name in the following format:
6550 #
6551 # global/images/my-custom-image
6552 #
6553 #
6554 # You can also specify a custom image by its image family, which returns
6555 # the latest version of the image in that family. Replace the image name
6556 # with family/family-name:
6557 #
6558 # global/images/family/my-image-family
6559 #
6560 #
6561 # If the source image is deleted later, this field will not be set.
6562 &quot;sourceImageEncryptionKey&quot;: { # Thecustomer-supplied
6563 # encryption key of the source image. Required if the source image is
6564 # protected by a customer-supplied encryption key.
6565 #
6566 # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
6567 # encryption keys, so you cannot create disks for instances in a managed instance group if the
6568 # source images are encrypted with your own keys.
6569 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
6570 # For example:
6571 #
6572 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
6573 # key_region/cryptoKeys/key
6574 #
6575 # The fully-qualifed key name may be returned for resource GET requests. For
6576 # example:
6577 #
6578 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
6579 # key_region/cryptoKeys/key
6580 # /cryptoKeyVersions/1
6581 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
6582 # key. If absent, the Compute Engine default service account is used.
6583 # For example:
6584 #
6585 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
6586 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
6587 # encryption key, encoded in RFC
6588 # 4648 base64 to either encrypt or decrypt this resource. You can
6589 # provide either the rawKey or thersaEncryptedKey.
6590 # For example:
6591 #
6592 # &quot;rawKey&quot;:
6593 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
6594 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
6595 # customer-supplied encryption key to either encrypt or decrypt this
6596 # resource. You can provide either the rawKey or thersaEncryptedKey.
6597 # For example:
6598 #
6599 # &quot;rsaEncryptedKey&quot;:
6600 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
6601 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
6602 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
6603 #
6604 # The key must meet the following requirements before you can provide it to
6605 # Compute Engine:
6606 #
6607 # 1. The key is wrapped using a RSA public key certificate provided by
6608 # Google.
6609 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
6610 # encoding.
6611 #
6612 # Gets the RSA public key certificate provided by Google at:
6613 #
6614 #
6615 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
6616 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
6617 # 4648 base64 encoded SHA-256 hash of the customer-supplied
6618 # encryption key that protects this resource.
6619 },
6620 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # The source snapshot to create this disk. When creating a new instance
6621 # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
6622 # is required.
6623 #
6624 # To create a disk with a snapshot that you created, specify the
6625 # snapshot name in the following format:
6626 #
6627 # global/snapshots/my-backup
6628 #
6629 #
6630 # If the source snapshot is deleted later, this field will not be set.
6631 #
6632 # Note: You cannot create VMs in bulk using a snapshot as the source. Use
6633 # an image instead when you create VMs using
6634 # the bulk
6635 # insert method.
6636 &quot;sourceSnapshotEncryptionKey&quot;: { # Thecustomer-supplied
6637 # encryption key of the source snapshot.
6638 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
6639 # For example:
6640 #
6641 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
6642 # key_region/cryptoKeys/key
6643 #
6644 # The fully-qualifed key name may be returned for resource GET requests. For
6645 # example:
6646 #
6647 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
6648 # key_region/cryptoKeys/key
6649 # /cryptoKeyVersions/1
6650 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
6651 # key. If absent, the Compute Engine default service account is used.
6652 # For example:
6653 #
6654 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
6655 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
6656 # encryption key, encoded in RFC
6657 # 4648 base64 to either encrypt or decrypt this resource. You can
6658 # provide either the rawKey or thersaEncryptedKey.
6659 # For example:
6660 #
6661 # &quot;rawKey&quot;:
6662 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
6663 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
6664 # customer-supplied encryption key to either encrypt or decrypt this
6665 # resource. You can provide either the rawKey or thersaEncryptedKey.
6666 # For example:
6667 #
6668 # &quot;rsaEncryptedKey&quot;:
6669 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
6670 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
6671 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
6672 #
6673 # The key must meet the following requirements before you can provide it to
6674 # Compute Engine:
6675 #
6676 # 1. The key is wrapped using a RSA public key certificate provided by
6677 # Google.
6678 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
6679 # encoding.
6680 #
6681 # Gets the RSA public key certificate provided by Google at:
6682 #
6683 #
6684 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
6685 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
6686 # 4648 base64 encoded SHA-256 hash of the customer-supplied
6687 # encryption key that protects this resource.
6688 },
6689 &quot;storagePool&quot;: &quot;A String&quot;, # The storage pool in which the new disk is created. You can provide
6690 # this as a partial or full URL to the resource. For example, the following
6691 # are valid values:
6692 #
6693 #
6694 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
6695 # - projects/project/zones/zone/storagePools/storagePool
6696 # - zones/zone/storagePools/storagePool
6697 },
6698 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is
6699 # either SCSI or NVME. For most machine types, the
6700 # default is SCSI. Local SSDs can use either NVME or SCSI.
6701 # In certain configurations, persistent disks can use NVMe. For more
6702 # information, seeAbout
6703 # persistent disks.
6704 &quot;kind&quot;: &quot;compute#attachedDisk&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
6705 &quot;licenses&quot;: [ # Output only. [Output Only] Any valid publicly visible licenses.
6706 &quot;A String&quot;,
6707 ],
6708 &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
6709 # in READ_WRITE mode.
6710 &quot;savedState&quot;: &quot;A String&quot;, # Output only. For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
6711 # field is set to PRESERVED if the LocalSSD data has been saved
6712 # to a persistent location by customer request. (see the
6713 # discard_local_ssd option on Stop/Suspend).
6714 # Read-only in the api.
6715 &quot;shieldedInstanceInitialState&quot;: { # Initial State for shielded instance, # Output only. [Output Only] shielded vm initial state stored on disk
6716 # these are public keys which are safe to store in public
6717 &quot;dbs&quot;: [ # The Key Database (db).
6718 {
6719 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
6720 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
6721 },
6722 ],
6723 &quot;dbxs&quot;: [ # The forbidden key database (dbx).
6724 {
6725 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
6726 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
6727 },
6728 ],
6729 &quot;keks&quot;: [ # The Key Exchange Key (KEK).
6730 {
6731 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
6732 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
6733 },
6734 ],
6735 &quot;pk&quot;: { # The Platform Key (PK).
6736 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
6737 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
6738 },
6739 },
6740 &quot;source&quot;: &quot;A String&quot;, # Specifies a valid partial or full URL to an existing Persistent Disk
6741 # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
6742 # is required.
6743 #
6744 # If desired, you can also attach existing non-root persistent disks using
6745 # this property. This field is only applicable for persistent disks.
6746 #
6747 # Note that for InstanceTemplate, specify the disk name for zonal disk,
6748 # and the URL for regional disk.
6749 &quot;type&quot;: &quot;A String&quot;, # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
6750 },
6751 ],
6752 &quot;displayDevice&quot;: { # A set of Display Device options # Enables display device for the instance.
6753 &quot;enableDisplay&quot;: True or False, # Defines whether the instance has Display enabled.
6754 },
6755 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this resource, which is essentially a hash of
6756 # the instance&#x27;s contents and used for optimistic locking. The
6757 # fingerprint is initially generated by Compute Engine and changes after
6758 # every request to modify or update the instance. You must always provide an
6759 # up-to-date fingerprint hash in order to update the instance.
6760 #
6761 # To see the latest fingerprint, make get() request to the
6762 # instance.
6763 &quot;guestAccelerators&quot;: [ # A list of the type and count of accelerator cards attached to the instance.
6764 { # A specification of the type and number of accelerator cards attached to the
6765 # instance.
6766 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
6767 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this
6768 # instance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100
6769 # If you are creating an instance template, specify only the
6770 # accelerator name.
6771 # See GPUs on Compute Engine
6772 # for a full list of accelerator types.
6773 },
6774 ],
6775 &quot;hostname&quot;: &quot;A String&quot;, # Specifies the hostname of the instance. The specified hostname must be
6776 # RFC1035 compliant. If hostname is not specified, the default hostname is
6777 # [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and
6778 # [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.
6779 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
6780 # defined by the server.
6781 &quot;instanceEncryptionKey&quot;: { # Encrypts suspended data for an instance with acustomer-managed
6782 # encryption key.
6783 #
6784 # If you are creating a new instance, this field will encrypt the local SSD
6785 # and in-memory contents of the instance during the suspend operation.
6786 #
6787 # If you do not provide an encryption key when creating the instance, then
6788 # the local SSD and in-memory contents will be encrypted using
6789 # an automatically generated key during the suspend operation.
6790 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
6791 # For example:
6792 #
6793 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
6794 # key_region/cryptoKeys/key
6795 #
6796 # The fully-qualifed key name may be returned for resource GET requests. For
6797 # example:
6798 #
6799 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
6800 # key_region/cryptoKeys/key
6801 # /cryptoKeyVersions/1
6802 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
6803 # key. If absent, the Compute Engine default service account is used.
6804 # For example:
6805 #
6806 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
6807 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
6808 # encryption key, encoded in RFC
6809 # 4648 base64 to either encrypt or decrypt this resource. You can
6810 # provide either the rawKey or thersaEncryptedKey.
6811 # For example:
6812 #
6813 # &quot;rawKey&quot;:
6814 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
6815 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
6816 # customer-supplied encryption key to either encrypt or decrypt this
6817 # resource. You can provide either the rawKey or thersaEncryptedKey.
6818 # For example:
6819 #
6820 # &quot;rsaEncryptedKey&quot;:
6821 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
6822 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
6823 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
6824 #
6825 # The key must meet the following requirements before you can provide it to
6826 # Compute Engine:
6827 #
6828 # 1. The key is wrapped using a RSA public key certificate provided by
6829 # Google.
6830 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
6831 # encoding.
6832 #
6833 # Gets the RSA public key certificate provided by Google at:
6834 #
6835 #
6836 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
6837 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
6838 # 4648 base64 encoded SHA-256 hash of the customer-supplied
6839 # encryption key that protects this resource.
6840 },
6841 &quot;keyRevocationActionType&quot;: &quot;A String&quot;, # KeyRevocationActionType of the instance. Supported options are &quot;STOP&quot; and
6842 # &quot;NONE&quot;. The default value is &quot;NONE&quot; if it is not specified.
6843 &quot;kind&quot;: &quot;compute#instance&quot;, # Output only. [Output Only] Type of the resource. Always compute#instance
6844 # for instances.
6845 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for this request, which is essentially a hash of
6846 # the label&#x27;s contents and used for optimistic locking. The
6847 # fingerprint is initially generated by Compute Engine and changes after
6848 # every request to modify or update labels. You must always provide an
6849 # up-to-date fingerprint hash in order to update or change labels.
6850 #
6851 # To see the latest fingerprint, make get() request to the
6852 # instance.
6853 &quot;labels&quot;: { # Labels to apply to this instance. These can be later modified by
6854 # the setLabels method.
6855 &quot;a_key&quot;: &quot;A String&quot;,
6856 },
6857 &quot;lastStartTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last start timestamp inRFC3339 text format.
6858 &quot;lastStopTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last stop timestamp inRFC3339 text format.
6859 &quot;lastSuspendedTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last suspended timestamp inRFC3339 text format.
6860 &quot;machineType&quot;: &quot;A String&quot;, # Full or partial URL of the machine type resource to use for this instance,
6861 # in the format:zones/zone/machineTypes/machine-type. This is provided by the client
6862 # when the instance is created. For example, the following is a valid partial
6863 # url to a predefined
6864 # machine type:
6865 #
6866 # zones/us-central1-f/machineTypes/n1-standard-1
6867 #
6868 #
6869 # To create acustom
6870 # machine type, provide a URL to a machine type in the following format,
6871 # where CPUS is 1 or an even number up to 32 (2,
6872 # 4, 6, ... 24, etc), and MEMORY is the total
6873 # memory for this instance. Memory must be a multiple of 256 MB and must
6874 # be supplied in MB (e.g. 5 GB of memory is 5120 MB):
6875 #
6876 # zones/zone/machineTypes/custom-CPUS-MEMORY
6877 #
6878 #
6879 # For example: zones/us-central1-f/machineTypes/custom-4-5120
6880 # For a full list of restrictions, read theSpecifications
6881 # for custom machine types.
6882 &quot;metadata&quot;: { # A metadata key/value entry. # The metadata key/value pairs assigned
6883 # to this instance. This includes metadata keys that were explicitly defined
6884 # for the instance.
6885 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
6886 # the metadata&#x27;s contents and used for optimistic locking. The
6887 # fingerprint is initially generated by Compute Engine and changes after
6888 # every request to modify or update metadata. You must always provide an
6889 # up-to-date fingerprint hash in order to update or change metadata,
6890 # otherwise the request will fail with error412 conditionNotMet.
6891 #
6892 # To see the latest fingerprint, make a get() request to
6893 # retrieve the resource.
6894 &quot;items&quot;: [ # Array of key/value pairs. The total size of all keys and values must be
6895 # less than 512 KB.
6896 { # Metadata
6897 &quot;key&quot;: &quot;A String&quot;, # Key for the metadata entry. Keys must conform to the following
6898 # regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length.
6899 # This is reflected as part of a URL in the metadata server. Additionally, to
6900 # avoid ambiguity, keys must not conflict with any other metadata keys
6901 # for the project.
6902 &quot;value&quot;: &quot;A String&quot;, # Value for the metadata entry. These are free-form strings, and only
6903 # have meaning as interpreted by the image running in the instance. The
6904 # only restriction placed on values is that their size must be less than
6905 # or equal to 262144 bytes (256 KiB).
6906 },
6907 ],
6908 &quot;kind&quot;: &quot;compute#metadata&quot;, # Output only. [Output Only] Type of the resource. Always compute#metadata
6909 # for metadata.
6910 },
6911 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Specifies aminimum CPU
6912 # platform for the VM instance. Applicable values are the friendly names
6913 # of CPU platforms, such as minCpuPlatform: &quot;Intel
6914 # Haswell&quot; or minCpuPlatform: &quot;Intel Sandy
6915 # Bridge&quot;.
6916 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating
6917 # the resource. The resource name must be 1-63 characters long, and comply
6918 # withRFC1035.
6919 # Specifically, the name must be 1-63 characters long and match the regular
6920 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
6921 # character must be a lowercase letter, and all following characters must be
6922 # a dash, lowercase letter, or digit, except the last character, which cannot
6923 # be a dash.
6924 &quot;networkInterfaces&quot;: [ # An array of network configurations for this instance. These specify how
6925 # interfaces are configured to interact with other network services, such as
6926 # connecting to the internet. Multiple interfaces are supported
6927 # per instance.
6928 { # A network interface resource attached to an instance.
6929 &quot;accessConfigs&quot;: [ # An array of configurations for this interface. Currently, only one access
6930 # config, ONE_TO_ONE_NAT, is supported. If there are noaccessConfigs specified, then this instance will have
6931 # no external internet access.
6932 { # An access configuration attached to an instance&#x27;s network interface.
6933 # Only one access config per instance is supported.
6934 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
6935 # The first IPv6 address of the external IPv6 range associated
6936 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
6937 # use a static external IP address, it must be unused and in the same region
6938 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
6939 # assign an external IPv6 address from the instance&#x27;s subnetwork.
6940 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
6941 # external IPv6 range.
6942 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
6943 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
6944 # (IPv4), the default and recommended name is External NAT, but
6945 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
6946 # recommend name is External IPv6.
6947 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
6948 # address associated with this instance. Specify an unused static
6949 # external IP address available to the project or leave this field undefined
6950 # to use an IP from a shared ephemeral IP address pool. If you specify a
6951 # static external IP address, it must live in the same region as the zone of
6952 # the instance.
6953 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
6954 # configuration and can only take the following values: PREMIUM,STANDARD.
6955 #
6956 # If an AccessConfig is specified without a valid external IP address, an
6957 # ephemeral IP will be created with this networkTier.
6958 #
6959 # If an AccessConfig with a valid external IP address is specified, it must
6960 # match that of the networkTier associated with the Address resource owning
6961 # that IP.
6962 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
6963 #
6964 # 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
6965 # first IP in associated external IPv6 range.
6966 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
6967 # config.
6968 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
6969 # external IP address of the instance to a DNS domain name.
6970 #
6971 # This field is not used in ipv6AccessConfig. A default PTR
6972 # record will be created if the VM has external IPv6 range associated.
6973 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
6974 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
6975 },
6976 ],
6977 &quot;aliasIpRanges&quot;: [ # An array of alias IP ranges for this network interface.
6978 # You can only specify this field for network interfaces in VPC networks.
6979 { # An alias IP range attached to an instance&#x27;s network interface.
6980 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
6981 # must belong to the specified subnetwork and cannot contain IP addresses
6982 # reserved by system or used by other network interfaces. This range may be
6983 # 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).
6984 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
6985 # alias range. If not specified, the primary range of the subnetwork is used.
6986 },
6987 ],
6988 &quot;aliasIpv6Ranges&quot;: [ # An array of alias IPv6 ranges for this network interface.
6989 # You can only specify this field for network interfaces in VPC networks.
6990 { # An alias IP range attached to an instance&#x27;s network interface.
6991 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
6992 # must belong to the specified subnetwork and cannot contain IP addresses
6993 # reserved by system or used by other network interfaces. This range may be
6994 # 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).
6995 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
6996 # alias range. If not specified, the primary range of the subnetwork is used.
6997 },
6998 ],
6999 &quot;enableVpcScopedDns&quot;: True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
7000 # with network_attachment.
7001 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint hash of contents stored in this network interface.
7002 # This field will be ignored when inserting an Instance or
7003 # adding a NetworkInterface. An up-to-date
7004 # 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.
7005 &quot;igmpQuery&quot;: &quot;A String&quot;, # Indicate whether igmp query is enabled on the network interface
7006 # or not. If enabled, also indicates the version of IGMP supported.
7007 &quot;internalIpv6PrefixLength&quot;: 42, # The prefix length of the primary internal IPv6 range.
7008 &quot;ipv6AccessConfigs&quot;: [ # An array of IPv6 access configurations for this interface. Currently, only
7009 # one IPv6 access config, DIRECT_IPV6, is supported. If there
7010 # is no ipv6AccessConfig specified, then this instance will
7011 # have no external IPv6 Internet access.
7012 { # An access configuration attached to an instance&#x27;s network interface.
7013 # Only one access config per instance is supported.
7014 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
7015 # The first IPv6 address of the external IPv6 range associated
7016 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
7017 # use a static external IP address, it must be unused and in the same region
7018 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
7019 # assign an external IPv6 address from the instance&#x27;s subnetwork.
7020 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
7021 # external IPv6 range.
7022 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
7023 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
7024 # (IPv4), the default and recommended name is External NAT, but
7025 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
7026 # recommend name is External IPv6.
7027 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
7028 # address associated with this instance. Specify an unused static
7029 # external IP address available to the project or leave this field undefined
7030 # to use an IP from a shared ephemeral IP address pool. If you specify a
7031 # static external IP address, it must live in the same region as the zone of
7032 # the instance.
7033 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
7034 # configuration and can only take the following values: PREMIUM,STANDARD.
7035 #
7036 # If an AccessConfig is specified without a valid external IP address, an
7037 # ephemeral IP will be created with this networkTier.
7038 #
7039 # If an AccessConfig with a valid external IP address is specified, it must
7040 # match that of the networkTier associated with the Address resource owning
7041 # that IP.
7042 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
7043 #
7044 # 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
7045 # first IP in associated external IPv6 range.
7046 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
7047 # config.
7048 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
7049 # external IP address of the instance to a DNS domain name.
7050 #
7051 # This field is not used in ipv6AccessConfig. A default PTR
7052 # record will be created if the VM has external IPv6 range associated.
7053 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
7054 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
7055 },
7056 ],
7057 &quot;ipv6AccessType&quot;: &quot;A String&quot;, # Output only. [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be
7058 # accessed from the Internet. This field is always inherited from its
7059 # subnetwork.
7060 #
7061 # Valid only if stackType is IPV4_IPV6.
7062 &quot;ipv6Address&quot;: &quot;A String&quot;, # An IPv6 internal network address for this network interface. To
7063 # use a static internal IP address, it must be unused and in the same region
7064 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
7065 # assign an internal IPv6 address from the instance&#x27;s subnetwork.
7066 &quot;kind&quot;: &quot;compute#networkInterface&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#networkInterface for network interfaces.
7067 &quot;name&quot;: &quot;A String&quot;, # [Output Only] The name of the network interface, which is generated by the
7068 # server. For a VM, the network interface uses the nicN naming
7069 # format. Where N is a value between 0 and7. The default interface value is nic0.
7070 &quot;network&quot;: &quot;A String&quot;, # URL of the VPC network resource for this instance. When creating an
7071 # instance, if neither the network nor the subnetwork is specified, the
7072 # default network global/networks/default is used. If the
7073 # selected project doesn&#x27;t have the default network, you must specify a
7074 # network or subnet. If the network is not specified but the subnetwork is
7075 # specified, the network is inferred.
7076 #
7077 # If you specify this property, you can specify the network as
7078 # a full or partial URL. For example, the following are all valid URLs:
7079 #
7080 #
7081 # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
7082 # - projects/project/global/networks/network
7083 # - global/networks/default
7084 &quot;networkAttachment&quot;: &quot;A String&quot;, # The URL of the network attachment that this interface should connect
7085 # to in the following format:
7086 # projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.
7087 &quot;networkIP&quot;: &quot;A String&quot;, # An IPv4 internal IP address to assign to the instance for this network
7088 # interface. If not specified by the user, an unused internal IP is
7089 # assigned by the system.
7090 &quot;nicType&quot;: &quot;A String&quot;, # The type of vNIC to be used on this interface. This may be gVNIC or
7091 # VirtioNet.
7092 &quot;parentNicName&quot;: &quot;A String&quot;, # Name of the parent network interface of a dynamic network interface.
7093 &quot;queueCount&quot;: 42, # The networking queue count that&#x27;s specified by users for the network
7094 # interface. Both Rx and Tx queues will be set to this number. It&#x27;ll be empty
7095 # if not specified by the users.
7096 &quot;serviceClassId&quot;: &quot;A String&quot;, # Optional. Producer Service&#x27;s Service class Id for the region of this network
7097 # interface. Can only be used with network_attachment. It is not possible to
7098 # use on its own however, network_attachment can be used without
7099 # service_class_id.
7100 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for this network interface. To assign only IPv4 addresses,
7101 # use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, useIPV4_IPV6. If not specified, IPV4_ONLY is used.
7102 #
7103 # This field can be both set at instance creation and update network
7104 # interface operations.
7105 &quot;subnetwork&quot;: &quot;A String&quot;, # The URL of the Subnetwork resource for this instance. If the network
7106 # resource is inlegacy
7107 # mode, do not specify this field. If the network is in auto subnet
7108 # mode, specifying the subnetwork is optional. If the network is in custom
7109 # subnet mode, specifying the subnetwork is required. If you specify this
7110 # field, you can specify the subnetwork as a full or partial URL. For
7111 # example, the following are all valid URLs:
7112 #
7113 #
7114 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
7115 # - regions/region/subnetworks/subnetwork
7116 &quot;vlan&quot;: 42, # VLAN tag of a dynamic network interface, must be an integer in the range
7117 # from 2 to 255 inclusively.
7118 },
7119 ],
7120 &quot;networkPerformanceConfig&quot;: {
7121 &quot;totalEgressBandwidthTier&quot;: &quot;A String&quot;,
7122 },
7123 &quot;params&quot;: { # Additional instance params. # Input only. [Input Only] Additional params passed with the request, but not persisted
7124 # as part of resource payload.
7125 &quot;requestValidForDuration&quot;: { # A Duration represents a fixed-length span of time represented # Relative deadline for waiting for capacity. Relevant only for
7126 # Instances.Insert API.
7127 # as a count of seconds and fractions of seconds at nanosecond
7128 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
7129 # or &quot;month&quot;. Range is approximately 10,000 years.
7130 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
7131 # Durations less than one second are represented with a 0
7132 # `seconds` field and a positive `nanos` field. Must be from 0
7133 # to 999,999,999 inclusive.
7134 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
7135 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
7136 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
7137 },
7138 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the instance. Tag keys and values
7139 # have the same definition as resource
7140 # manager tags. Keys and values can be either in numeric format,
7141 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
7142 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
7143 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
7144 # PATCH) when empty.
7145 &quot;a_key&quot;: &quot;A String&quot;,
7146 },
7147 },
7148 &quot;privateIpv6GoogleAccess&quot;: &quot;A String&quot;, # The private IPv6 google access type for the VM.
7149 # If not specified, use INHERIT_FROM_SUBNETWORK as default.
7150 &quot;reservationAffinity&quot;: { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.
7151 &quot;consumeReservationType&quot;: &quot;A String&quot;, # Specifies the type of reservation from which this instance can consume
7152 # resources: ANY_RESERVATION (default),SPECIFIC_RESERVATION, or NO_RESERVATION. See
7153 # Consuming reserved instances for examples.
7154 &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
7155 # the name of your reservation as its value.
7156 &quot;values&quot;: [ # Corresponds to the label values of a reservation resource. This can be
7157 # either a name to a reservation in the same project or
7158 # &quot;projects/different-project/reservations/some-reservation-name&quot; to target a
7159 # shared reservation in the same zone but in a different project.
7160 &quot;A String&quot;,
7161 ],
7162 },
7163 &quot;resourcePolicies&quot;: [ # Resource policies applied to this instance.
7164 &quot;A String&quot;,
7165 ],
7166 &quot;resourceStatus&quot;: { # Contains output only fields. # Output only. [Output Only] Specifies values set for instance attributes as
7167 # compared to the values requested by user in the corresponding input only
7168 # field.
7169 # Use this sub-message for actual values set on Instance attributes as compared
7170 # to the value requested by the user (intent) in their instance CRUD calls.
7171 &quot;effectiveInstanceMetadata&quot;: { # Effective values of predefined metadata keys for an instance. # Output only. [Output Only] Effective metadata is a field that consolidates project,
7172 # zonal instance settings, and instance-level predefined metadata keys to
7173 # provide the overridden value for those metadata keys at the instance level.
7174 &quot;blockProjectSshKeysMetadataValue&quot;: True or False, # Effective block-project-ssh-keys value at Instance level.
7175 &quot;enableGuestAttributesMetadataValue&quot;: True or False, # Effective enable-guest-attributes value at Instance level.
7176 &quot;enableOsInventoryMetadataValue&quot;: True or False, # Effective enable-os-inventory value at Instance level.
7177 &quot;enableOsconfigMetadataValue&quot;: True or False, # Effective enable-osconfig value at Instance level.
7178 &quot;enableOsloginMetadataValue&quot;: True or False, # Effective enable-oslogin value at Instance level.
7179 &quot;gceContainerDeclarationMetadataValue&quot;: True or False, # Effective gce-container-declaration value at Instance level.
7180 &quot;serialPortEnableMetadataValue&quot;: True or False, # Effective serial-port-enable value at Instance level.
7181 &quot;serialPortLoggingEnableMetadataValue&quot;: True or False, # Effective serial-port-logging-enable value at Instance level.
7182 &quot;vmDnsSettingMetadataValue&quot;: &quot;A String&quot;, # Effective VM DNS setting at Instance level.
7183 },
7184 &quot;physicalHost&quot;: &quot;A String&quot;, # Output only. [Output Only] The precise location of your instance within the zone&#x27;s data
7185 # center, including the block, sub-block, and host. The field is formatted as
7186 # follows: blockId/subBlockId/hostId.
7187 &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
7188 # Engine cluster, as well as the ID of the block, sub-block, and host on
7189 # which the running instance is located.
7190 # running.
7191 &quot;additionalAttributes&quot;: { # Additional location information of the running instance. # Output only. [Output Only] Additional location information of the running instance.
7192 &quot;acceleratorTopologyIds&quot;: { # Output only. The IDs of the accelerator topologies the instance belongs to. For
7193 # example
7194 # The key will be topologies like &quot;4x4&quot;, &quot;2x2x2&quot; and the value will be
7195 # the location ID of the topologies.
7196 &quot;a_key&quot;: &quot;A String&quot;,
7197 },
7198 },
7199 &quot;block&quot;: &quot;A String&quot;, # [Output Only] The ID of the block in which the running instance is
7200 # located. Instances within the same block experience low network latency.
7201 &quot;cluster&quot;: &quot;A String&quot;, # [Output Only] The global name of the Compute Engine cluster where the
7202 # running instance is located.
7203 &quot;host&quot;: &quot;A String&quot;, # [Output Only] The ID of the host on which the running instance is located.
7204 # Instances on the same host experience the lowest possible network
7205 # latency.
7206 &quot;subblock&quot;: &quot;A String&quot;, # [Output Only] The ID of the sub-block in which the running instance is
7207 # located. Instances in the same sub-block experience lower network latency
7208 # than instances in the same block.
7209 },
7210 &quot;reservationConsumptionInfo&quot;: { # Reservation consumption information that the instance is consuming from. # Output only. [Output Only] Reservation information that the instance is consuming from.
7211 &quot;consumedReservation&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the reservation that this
7212 # instance is consuming from.
7213 },
7214 &quot;scheduling&quot;: {
7215 &quot;availabilityDomain&quot;: 42, # Specifies the availability domain to place the instance in. The value
7216 # must be a number between 1 and the number of availability domains
7217 # specified in the spread placement policy attached to the instance.
7218 },
7219 &quot;upcomingMaintenance&quot;: { # Upcoming Maintenance notification information.
7220 &quot;canReschedule&quot;: True or False, # Indicates if the maintenance can be customer triggered.
7221 &quot;latestWindowStartTime&quot;: &quot;A String&quot;, # The latest time for the planned maintenance window to start.
7222 # This timestamp value is in RFC3339 text format.
7223 &quot;maintenanceOnShutdown&quot;: True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown.
7224 &quot;maintenanceReasons&quot;: [ # The reasons for the maintenance. Only valid for vms.
7225 &quot;A String&quot;,
7226 ],
7227 &quot;maintenanceStatus&quot;: &quot;A String&quot;,
7228 &quot;type&quot;: &quot;A String&quot;, # Defines the type of maintenance.
7229 &quot;windowEndTime&quot;: &quot;A String&quot;, # The time by which the maintenance disruption will be completed.
7230 # This timestamp value is in RFC3339 text format.
7231 &quot;windowStartTime&quot;: &quot;A String&quot;, # The current start time of the maintenance window.
7232 # This timestamp value is in RFC3339 text format.
7233 },
7234 },
7235 &quot;satisfiesPzi&quot;: True or False, # Output only. [Output Only] Reserved for future use.
7236 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
7237 &quot;scheduling&quot;: { # Sets the scheduling options for an Instance. # Sets the scheduling options for this instance.
7238 &quot;automaticRestart&quot;: True or False, # Specifies whether the instance should be automatically restarted if it is
7239 # terminated by Compute Engine (not terminated by a user). You can only set
7240 # the automatic restart option for standard instances.Preemptible instances
7241 # cannot be automatically restarted.
7242 #
7243 # By default, this is set to true so an instance is
7244 # automatically restarted if it is terminated by Compute Engine.
7245 &quot;availabilityDomain&quot;: 42, # Specifies the availability domain to place the instance in. The value
7246 # must be a number between 1 and the number of availability domains
7247 # specified in the spread placement policy attached to the instance.
7248 &quot;hostErrorTimeoutSeconds&quot;: 42, # Specify the time in seconds for host error detection, the value must be
7249 # within the range of [90, 330] with the increment of 30, if unset, the
7250 # default behavior of host error recovery will be used.
7251 &quot;instanceTerminationAction&quot;: &quot;A String&quot;, # Specifies the termination action for the instance.
7252 &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
7253 # recovery of the Local Ssd state is attempted. Its value should be in
7254 # between 0 and 168 hours with hour granularity and the default value being 1
7255 # hour.
7256 # as a count of seconds and fractions of seconds at nanosecond
7257 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
7258 # or &quot;month&quot;. Range is approximately 10,000 years.
7259 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
7260 # Durations less than one second are represented with a 0
7261 # `seconds` field and a positive `nanos` field. Must be from 0
7262 # to 999,999,999 inclusive.
7263 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
7264 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
7265 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
7266 },
7267 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the instance close to other
7268 # resources.
7269 # This field is for use by internal tools that use the public API.
7270 &quot;maxRunDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the max run duration for the given instance. If specified,
7271 # the instance termination action will be performed at the end of the run
7272 # duration.
7273 # as a count of seconds and fractions of seconds at nanosecond
7274 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
7275 # or &quot;month&quot;. Range is approximately 10,000 years.
7276 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
7277 # Durations less than one second are represented with a 0
7278 # `seconds` field and a positive `nanos` field. Must be from 0
7279 # to 999,999,999 inclusive.
7280 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
7281 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
7282 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
7283 },
7284 &quot;minNodeCpus&quot;: 42, # The minimum number of virtual CPUs this instance will consume when running
7285 # on a sole-tenant node.
7286 &quot;nodeAffinities&quot;: [ # A set of node affinity and anti-affinity configurations. Refer toConfiguring node
7287 # affinity for more information.
7288 # Overrides reservationAffinity.
7289 { # Node Affinity: the configuration of desired nodes onto which this Instance
7290 # could be scheduled.
7291 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of Node resource.
7292 &quot;operator&quot;: &quot;A String&quot;, # Defines the operation of node selection. Valid operators areIN for affinity and NOT_IN for anti-affinity.
7293 &quot;values&quot;: [ # Corresponds to the label values of Node resource.
7294 &quot;A String&quot;,
7295 ],
7296 },
7297 ],
7298 &quot;onHostMaintenance&quot;: &quot;A String&quot;, # Defines the maintenance behavior for this instance. For standard instances,
7299 # the default behavior is MIGRATE. Forpreemptible instances,
7300 # the default and only possible behavior is TERMINATE. For more
7301 # information, see
7302 # Set
7303 # VM host maintenance policy.
7304 &quot;onInstanceStopAction&quot;: { # Defines the behaviour for instances with the instance_termination_actionSTOP.
7305 &quot;discardLocalSsd&quot;: True or False, # If true, the contents of any attached Local SSD disks will be discarded
7306 # else, the Local SSD data will be preserved when the instance is stopped
7307 # at the end of the run duration/termination time.
7308 },
7309 &quot;preemptible&quot;: True or False, # Defines whether the instance is preemptible. This can only be set during
7310 # instance creation or while the instance isstopped and
7311 # therefore, in a `TERMINATED` state. SeeInstance Life
7312 # Cycle for more information on the possible instance states.
7313 &quot;provisioningModel&quot;: &quot;A String&quot;, # Specifies the provisioning model of the instance.
7314 &quot;skipGuestOsShutdown&quot;: True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
7315 # Off and ACPI G3 Mechanical
7316 # Off for Standard VMs and 30 seconds for Spot VMs.
7317 &quot;terminationTime&quot;: &quot;A String&quot;, # Specifies the timestamp, when the instance will be terminated, inRFC3339 text format. If specified, the instance
7318 # termination action will be performed at the termination time.
7319 },
7320 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
7321 &quot;serviceAccounts&quot;: [ # A list of service accounts, with their specified scopes, authorized for
7322 # this instance. Only one service account per VM instance is supported.
7323 #
7324 # Service accounts generate access tokens that can be accessed
7325 # through the metadata server and used to authenticate applications on the
7326 # instance. SeeService Accounts
7327 # for more information.
7328 { # A service account.
7329 &quot;email&quot;: &quot;A String&quot;, # Email address of the service account.
7330 &quot;scopes&quot;: [ # The list of scopes to be made available for this service account.
7331 &quot;A String&quot;,
7332 ],
7333 },
7334 ],
7335 &quot;shieldedInstanceConfig&quot;: { # A set of Shielded Instance options.
7336 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.Enabled by
7337 # default.
7338 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.Disabled by
7339 # default.
7340 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.Enabled by
7341 # default.
7342 },
7343 &quot;shieldedInstanceIntegrityPolicy&quot;: { # The policy describes the baseline against which
7344 # Instance boot integrity is measured.
7345 &quot;updateAutoLearnPolicy&quot;: True or False, # Updates the integrity policy baseline using the
7346 # measurements from the VM instance&#x27;s most recent boot.
7347 },
7348 &quot;sourceMachineImage&quot;: &quot;A String&quot;, # Source machine image
7349 &quot;sourceMachineImageEncryptionKey&quot;: { # Source machine image encryption key when creating an instance from a
7350 # machine image.
7351 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
7352 # For example:
7353 #
7354 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
7355 # key_region/cryptoKeys/key
7356 #
7357 # The fully-qualifed key name may be returned for resource GET requests. For
7358 # example:
7359 #
7360 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
7361 # key_region/cryptoKeys/key
7362 # /cryptoKeyVersions/1
7363 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
7364 # key. If absent, the Compute Engine default service account is used.
7365 # For example:
7366 #
7367 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
7368 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
7369 # encryption key, encoded in RFC
7370 # 4648 base64 to either encrypt or decrypt this resource. You can
7371 # provide either the rawKey or thersaEncryptedKey.
7372 # For example:
7373 #
7374 # &quot;rawKey&quot;:
7375 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
7376 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
7377 # customer-supplied encryption key to either encrypt or decrypt this
7378 # resource. You can provide either the rawKey or thersaEncryptedKey.
7379 # For example:
7380 #
7381 # &quot;rsaEncryptedKey&quot;:
7382 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
7383 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
7384 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
7385 #
7386 # The key must meet the following requirements before you can provide it to
7387 # Compute Engine:
7388 #
7389 # 1. The key is wrapped using a RSA public key certificate provided by
7390 # Google.
7391 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
7392 # encoding.
7393 #
7394 # Gets the RSA public key certificate provided by Google at:
7395 #
7396 #
7397 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
7398 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
7399 # 4648 base64 encoded SHA-256 hash of the customer-supplied
7400 # encryption key that protects this resource.
7401 },
7402 &quot;startRestricted&quot;: True or False, # Output only. [Output Only] Whether a VM has been restricted for start because Compute
7403 # Engine has detected suspicious activity.
7404 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the instance. One of the
7405 # following values: PROVISIONING, STAGING,RUNNING, STOPPING, SUSPENDING,SUSPENDED, REPAIRING, andTERMINATED. For more information about the status of the
7406 # instance, see
7407 # Instance life cycle.
7408 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. [Output Only] An optional, human-readable explanation of the status.
7409 &quot;tags&quot;: { # A set of instance tags. # Tags to apply to this instance. Tags are used to identify valid
7410 # sources or targets for network firewalls and are specified by the client
7411 # during instance creation. The tags can be later modified by the setTags
7412 # method. Each tag within the list must comply withRFC1035.
7413 # Multiple tags can be specified via the &#x27;tags.items&#x27; field.
7414 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
7415 # the tags&#x27; contents and used for optimistic locking. The
7416 # fingerprint is initially generated by Compute Engine and changes after
7417 # every request to modify or update tags. You must always provide an
7418 # up-to-date fingerprint hash in order to update or change tags.
7419 #
7420 # To see the latest fingerprint, make get() request to the
7421 # instance.
7422 &quot;items&quot;: [ # An array of tags. Each tag must be 1-63 characters long, and comply
7423 # with RFC1035.
7424 &quot;A String&quot;,
7425 ],
7426 },
7427 &quot;workloadIdentityConfig&quot;: {
7428 &quot;identity&quot;: &quot;A String&quot;,
7429 &quot;identityCertificateEnabled&quot;: True or False,
7430 },
7431 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the zone where the instance resides.
7432 # You must specify this field as part of the HTTP request URL. It is
7433 # not settable as a field in the request body.
7434 }</pre>
7435 </div>
7436
7437 <div class="method">
7438 <code class="details" id="getEffectiveFirewalls">getEffectiveFirewalls(project, zone, instance, networkInterface, x__xgafv=None)</code>
7439 <pre>Returns effective firewalls applied to an interface of the instance.
7440
7441 Args:
7442 project: string, Project ID for this request. (required)
7443 zone: string, The name of the zone for this request. (required)
7444 instance: string, Name of the instance scoping this request. (required)
7445 networkInterface: string, The name of the network interface to get the effective firewalls. (required)
7446 x__xgafv: string, V1 error format.
7447 Allowed values
7448 1 - v1 error format
7449 2 - v2 error format
7450
7451 Returns:
7452 An object of the form:
7453
7454 {
7455 &quot;firewallPolicys&quot;: [ # [Output Only] Effective firewalls from firewall policies.
7456 {
7457 &quot;displayName&quot;: &quot;A String&quot;, # Output only. [Output Only] Deprecated, please use short name instead. The display name
7458 # of the firewall policy.
7459 &quot;name&quot;: &quot;A String&quot;, # Output only. [Output Only] The name of the firewall policy.
7460 &quot;packetMirroringRules&quot;: [ # Output only. [Output Only] The packet mirroring rules that apply to the instance.
7461 { # Represents a rule that describes one or more match conditions along with
7462 # the action to be taken when traffic matches this condition (allow or deny).
7463 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
7464 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
7465 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
7466 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
7467 # and &quot;goto_next&quot;.
7468 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
7469 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
7470 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
7471 # the firewall policy rule is not enforced and traffic behaves as if it did
7472 # not exist. If this is unspecified, the firewall policy rule will be
7473 # enabled.
7474 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
7475 # enabled, logs will be exported to the configured export destination in
7476 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
7477 # cannot enable logging on &quot;goto_next&quot; rules.
7478 &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.
7479 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
7480 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
7481 # Exactly one field must be specified.
7482 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
7483 # Maximum number of destination address groups is 10.
7484 &quot;A String&quot;,
7485 ],
7486 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
7487 # traffic destination.
7488 # Maximum number of destination fqdn allowed is 100.
7489 &quot;A String&quot;,
7490 ],
7491 &quot;destIpRanges&quot;: [ # CIDR IP address range.
7492 # Maximum number of destination CIDR IP ranges allowed is 5000.
7493 &quot;A String&quot;,
7494 ],
7495 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
7496 #
7497 #
7498 # - UNSPECIFIED
7499 # - INTERNET
7500 # - NON_INTERNET
7501 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
7502 #
7503 #
7504 # - UNSPECIFIED
7505 # - INTERNET
7506 # - NON_INTERNET
7507 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
7508 # of traffic. Should be specified as 2 letter country code defined as per
7509 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
7510 # Maximum number of dest region codes allowed is 5000.
7511 &quot;A String&quot;,
7512 ],
7513 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
7514 # The IPs in these lists will be matched against traffic destination.
7515 &quot;A String&quot;,
7516 ],
7517 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
7518 {
7519 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
7520 # required when creating a firewall rule. This value can either be
7521 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
7522 # protocol number.
7523 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
7524 # only applicable for UDP or TCP protocol. Each entry must be either
7525 # an integer or a range. If not specified, this rule applies to
7526 # connections through any port.
7527 #
7528 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
7529 &quot;A String&quot;,
7530 ],
7531 },
7532 ],
7533 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
7534 # Maximum number of source address groups is 10.
7535 &quot;A String&quot;,
7536 ],
7537 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
7538 # traffic source.
7539 # Maximum number of source fqdn allowed is 100.
7540 &quot;A String&quot;,
7541 ],
7542 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
7543 # Maximum number of source CIDR IP ranges allowed is 5000.
7544 &quot;A String&quot;,
7545 ],
7546 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
7547 #
7548 #
7549 # - UNSPECIFIED
7550 # - INTERNET
7551 # - INTRA_VPC
7552 # - NON_INTERNET
7553 # - VPC_NETWORKS
7554 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
7555 #
7556 #
7557 # - UNSPECIFIED
7558 # - INTERNET
7559 # - INTRA_VPC
7560 # - NON_INTERNET
7561 # - VPC_NETWORKS
7562 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
7563 &quot;A String&quot;,
7564 ],
7565 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
7566 # of traffic. Should be specified as 2 letter country code defined as per
7567 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
7568 # Maximum number of source region codes allowed is 5000.
7569 &quot;A String&quot;,
7570 ],
7571 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
7572 # of the traffic.
7573 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
7574 # and there is no srcIpRange, this rule will be ignored.
7575 # Maximum number of source tag values allowed is 256.
7576 {
7577 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
7578 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
7579 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
7580 # or its network is deleted.
7581 },
7582 ],
7583 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
7584 # The IPs in these lists will be matched against traffic source.
7585 &quot;A String&quot;,
7586 ],
7587 },
7588 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
7589 # must be a positive value between 0 and 2147483647.
7590 # Rules are evaluated from highest to lowest priority where 0 is the
7591 # highest priority and 2147483647 is the lowest priority.
7592 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
7593 # and can be updated.
7594 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
7595 # rule.
7596 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
7597 # Example:
7598 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
7599 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
7600 # &#x27;mirror&#x27;. Cannot be specified for other actions.
7601 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
7602 # This field allows you to control which load balancers get this rule.
7603 # For example, the following are valid values:
7604 #
7605 #
7606 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
7607 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
7608 # - projects/project/global/
7609 # forwardingRules/forwardingRule
7610 # - projects/project/regions/region/forwardingRules/
7611 # forwardingRule
7612 &quot;A String&quot;,
7613 ],
7614 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
7615 # allows you to control which network&#x27;s VMs get this rule. If this field
7616 # is left blank, all VMs within the organization will receive the rule.
7617 &quot;A String&quot;,
7618 ],
7619 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
7620 # applies to. If targetSecureTag are specified, then the
7621 # firewall rule applies only to instances in the VPC network that have one
7622 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
7623 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
7624 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
7625 # to all instances on the specified network.
7626 # Maximum number of target label tags allowed is 256.
7627 {
7628 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
7629 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
7630 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
7631 # or its network is deleted.
7632 },
7633 ],
7634 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
7635 # applied with this rule.
7636 &quot;A String&quot;,
7637 ],
7638 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
7639 # Default value is INSTANCES.
7640 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
7641 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
7642 # be set for other actions.
7643 },
7644 ],
7645 &quot;priority&quot;: 42, # Output only. [Output only] Priority of firewall policy association. Not applicable for
7646 # type=HIERARCHY.
7647 &quot;rules&quot;: [ # [Output Only] The rules that apply to the instance. Only rules that
7648 # target the specific VM instance are returned if target service accounts
7649 # or target secure tags are specified in the rules.
7650 { # Represents a rule that describes one or more match conditions along with
7651 # the action to be taken when traffic matches this condition (allow or deny).
7652 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule.
7653 # Valid actions for firewall rules are: &quot;allow&quot;, &quot;deny&quot;,
7654 # &quot;apply_security_profile_group&quot; and &quot;goto_next&quot;.
7655 # Valid actions for packet mirroring rules are: &quot;mirror&quot;, &quot;do_not_mirror&quot;
7656 # and &quot;goto_next&quot;.
7657 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
7658 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
7659 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true,
7660 # the firewall policy rule is not enforced and traffic behaves as if it did
7661 # not exist. If this is unspecified, the firewall policy rule will be
7662 # enabled.
7663 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is
7664 # enabled, logs will be exported to the configured export destination in
7665 # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you
7666 # cannot enable logging on &quot;goto_next&quot; rules.
7667 &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.
7668 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against.
7669 # If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
7670 # Exactly one field must be specified.
7671 &quot;destAddressGroups&quot;: [ # Address groups which should be matched against the traffic destination.
7672 # Maximum number of destination address groups is 10.
7673 &quot;A String&quot;,
7674 ],
7675 &quot;destFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
7676 # traffic destination.
7677 # Maximum number of destination fqdn allowed is 100.
7678 &quot;A String&quot;,
7679 ],
7680 &quot;destIpRanges&quot;: [ # CIDR IP address range.
7681 # Maximum number of destination CIDR IP ranges allowed is 5000.
7682 &quot;A String&quot;,
7683 ],
7684 &quot;destNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic destination. Allowed values are:
7685 #
7686 #
7687 # - UNSPECIFIED
7688 # - INTERNET
7689 # - NON_INTERNET
7690 &quot;destNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic destination. Allowed values are:
7691 #
7692 #
7693 # - UNSPECIFIED
7694 # - INTERNET
7695 # - NON_INTERNET
7696 &quot;destRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for destination
7697 # of traffic. Should be specified as 2 letter country code defined as per
7698 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
7699 # Maximum number of dest region codes allowed is 5000.
7700 &quot;A String&quot;,
7701 ],
7702 &quot;destThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
7703 # The IPs in these lists will be matched against traffic destination.
7704 &quot;A String&quot;,
7705 ],
7706 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
7707 {
7708 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
7709 # required when creating a firewall rule. This value can either be
7710 # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP
7711 # protocol number.
7712 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is
7713 # only applicable for UDP or TCP protocol. Each entry must be either
7714 # an integer or a range. If not specified, this rule applies to
7715 # connections through any port.
7716 #
7717 # Example inputs include: [&quot;22&quot;],[&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
7718 &quot;A String&quot;,
7719 ],
7720 },
7721 ],
7722 &quot;srcAddressGroups&quot;: [ # Address groups which should be matched against the traffic source.
7723 # Maximum number of source address groups is 10.
7724 &quot;A String&quot;,
7725 ],
7726 &quot;srcFqdns&quot;: [ # Fully Qualified Domain Name (FQDN) which should be matched against
7727 # traffic source.
7728 # Maximum number of source fqdn allowed is 100.
7729 &quot;A String&quot;,
7730 ],
7731 &quot;srcIpRanges&quot;: [ # CIDR IP address range.
7732 # Maximum number of source CIDR IP ranges allowed is 5000.
7733 &quot;A String&quot;,
7734 ],
7735 &quot;srcNetworkContext&quot;: &quot;A String&quot;, # Network context of the traffic source. Allowed values are:
7736 #
7737 #
7738 # - UNSPECIFIED
7739 # - INTERNET
7740 # - INTRA_VPC
7741 # - NON_INTERNET
7742 # - VPC_NETWORKS
7743 &quot;srcNetworkType&quot;: &quot;A String&quot;, # Network type of the traffic source. Allowed values are:
7744 #
7745 #
7746 # - UNSPECIFIED
7747 # - INTERNET
7748 # - INTRA_VPC
7749 # - NON_INTERNET
7750 # - VPC_NETWORKS
7751 &quot;srcNetworks&quot;: [ # Networks of the traffic source. It can be either a full or partial url.
7752 &quot;A String&quot;,
7753 ],
7754 &quot;srcRegionCodes&quot;: [ # Region codes whose IP addresses will be used to match for source
7755 # of traffic. Should be specified as 2 letter country code defined as per
7756 # ISO 3166 alpha-2 country codes. ex.&quot;US&quot;
7757 # Maximum number of source region codes allowed is 5000.
7758 &quot;A String&quot;,
7759 ],
7760 &quot;srcSecureTags&quot;: [ # List of secure tag values, which should be matched at the source
7761 # of the traffic.
7762 # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE,
7763 # and there is no srcIpRange, this rule will be ignored.
7764 # Maximum number of source tag values allowed is 256.
7765 {
7766 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
7767 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
7768 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
7769 # or its network is deleted.
7770 },
7771 ],
7772 &quot;srcThreatIntelligences&quot;: [ # Names of Network Threat Intelligence lists.
7773 # The IPs in these lists will be matched against traffic source.
7774 &quot;A String&quot;,
7775 ],
7776 },
7777 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority
7778 # must be a positive value between 0 and 2147483647.
7779 # Rules are evaluated from highest to lowest priority where 0 is the
7780 # highest priority and 2147483647 is the lowest priority.
7781 &quot;ruleName&quot;: &quot;A String&quot;, # An optional name for the rule. This field is not a unique identifier
7782 # and can be updated.
7783 &quot;ruleTupleCount&quot;: 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy
7784 # rule.
7785 &quot;securityProfileGroup&quot;: &quot;A String&quot;, # A fully-qualified URL of a SecurityProfile resource instance.
7786 # Example:
7787 # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group
7788 # Must be specified if action is one of &#x27;apply_security_profile_group&#x27; or
7789 # &#x27;mirror&#x27;. Cannot be specified for other actions.
7790 &quot;targetForwardingRules&quot;: [ # A list of forwarding rules to which this rule applies.
7791 # This field allows you to control which load balancers get this rule.
7792 # For example, the following are valid values:
7793 #
7794 #
7795 # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule
7796 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
7797 # - projects/project/global/
7798 # forwardingRules/forwardingRule
7799 # - projects/project/regions/region/forwardingRules/
7800 # forwardingRule
7801 &quot;A String&quot;,
7802 ],
7803 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field
7804 # allows you to control which network&#x27;s VMs get this rule. If this field
7805 # is left blank, all VMs within the organization will receive the rule.
7806 &quot;A String&quot;,
7807 ],
7808 &quot;targetSecureTags&quot;: [ # A list of secure tags that controls which instances the firewall rule
7809 # applies to. If targetSecureTag are specified, then the
7810 # firewall rule applies only to instances in the VPC network that have one
7811 # of those EFFECTIVE secure tags, if all the target_secure_tag are in
7812 # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.
7813 # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies
7814 # to all instances on the specified network.
7815 # Maximum number of target label tags allowed is 256.
7816 {
7817 &quot;name&quot;: &quot;A String&quot;, # Name of the secure tag, created with TagManager&#x27;s TagValue API.
7818 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or
7819 # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted
7820 # or its network is deleted.
7821 },
7822 ],
7823 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are
7824 # applied with this rule.
7825 &quot;A String&quot;,
7826 ],
7827 &quot;targetType&quot;: &quot;A String&quot;, # Target types of the firewall policy rule.
7828 # Default value is INSTANCES.
7829 &quot;tlsInspect&quot;: True or False, # Boolean flag indicating if the traffic should be TLS decrypted.
7830 # Can be set only if action = &#x27;apply_security_profile_group&#x27; and cannot
7831 # be set for other actions.
7832 },
7833 ],
7834 &quot;shortName&quot;: &quot;A String&quot;, # Output only. [Output Only] The short name of the firewall policy.
7835 &quot;type&quot;: &quot;A String&quot;, # Output only. [Output Only] The type of the firewall policy. Can be one of HIERARCHY,
7836 # NETWORK, NETWORK_REGIONAL, SYSTEM_GLOBAL, SYSTEM_REGIONAL.
7837 },
7838 ],
7839 &quot;firewalls&quot;: [ # Effective firewalls on the instance.
7840 { # Represents a Firewall Rule resource.
7841 #
7842 # Firewall rules allow or deny ingress traffic to, and egress traffic from your
7843 # instances. For more information, readFirewall rules.
7844 &quot;allowed&quot;: [ # The list of ALLOW rules specified by this firewall. Each rule specifies a
7845 # protocol and port-range tuple that describes a permitted connection.
7846 {
7847 &quot;IPProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
7848 # required when creating a firewall rule. This value can either be one of the
7849 # following well known protocol strings (tcp, udp,icmp, esp, ah, ipip,sctp) or the IP protocol number.
7850 &quot;ports&quot;: [ # An optional list of ports to which this rule applies.
7851 # This field is only applicable for the UDP or TCP protocol.
7852 # Each entry must be either an integer or a range.
7853 # If not specified, this rule applies to connections through any port.
7854 #
7855 # Example inputs include: [&quot;22&quot;], [&quot;80&quot;,&quot;443&quot;],
7856 # and [&quot;12345-12349&quot;].
7857 &quot;A String&quot;,
7858 ],
7859 },
7860 ],
7861 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
7862 # text format.
7863 &quot;denied&quot;: [ # The list of DENY rules specified by this firewall. Each rule specifies a
7864 # protocol and port-range tuple that describes a denied connection.
7865 {
7866 &quot;IPProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is
7867 # required when creating a firewall rule. This value can either be one of the
7868 # following well known protocol strings (tcp, udp,icmp, esp, ah, ipip,sctp) or the IP protocol number.
7869 &quot;ports&quot;: [ # An optional list of ports to which this rule applies.
7870 # This field is only applicable for the UDP or TCP protocol.
7871 # Each entry must be either an integer or a range.
7872 # If not specified, this rule applies to connections through any port.
7873 #
7874 # Example inputs include: [&quot;22&quot;], [&quot;80&quot;,&quot;443&quot;],
7875 # and [&quot;12345-12349&quot;].
7876 &quot;A String&quot;,
7877 ],
7878 },
7879 ],
7880 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this field when you
7881 # create the resource.
7882 &quot;destinationRanges&quot;: [ # If destination ranges are specified, the firewall rule applies only to
7883 # traffic that has destination IP address in these ranges. These ranges must
7884 # be expressed inCIDR format. Both IPv4 and IPv6 are supported.
7885 &quot;A String&quot;,
7886 ],
7887 &quot;direction&quot;: &quot;A String&quot;, # Direction of traffic to which this firewall applies, either `INGRESS` or
7888 # `EGRESS`. The default is `INGRESS`. For `EGRESS` traffic, you cannot
7889 # specify the sourceTags fields.
7890 &quot;disabled&quot;: True or False, # Denotes whether the firewall rule is disabled. When set to true, the
7891 # firewall rule is not enforced and the network behaves as if it did not
7892 # exist. If this is unspecified, the firewall rule will be enabled.
7893 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
7894 # defined by the server.
7895 &quot;kind&quot;: &quot;compute#firewall&quot;, # Output only. [Output Only] Type of the resource. Always compute#firewall
7896 # for firewall rules.
7897 &quot;logConfig&quot;: { # The available logging options for a firewall rule. # This field denotes the logging options for a particular firewall rule. If
7898 # logging is enabled, logs will be exported to Cloud Logging.
7899 &quot;enable&quot;: True or False, # This field denotes whether to enable logging for a particular firewall
7900 # rule.
7901 &quot;metadata&quot;: &quot;A String&quot;, # This field can only be specified for a particular firewall rule if
7902 # logging is enabled for that rule. This field denotes whether to include
7903 # or exclude metadata for firewall logs.
7904 },
7905 &quot;name&quot;: &quot;A String&quot;, # Name of the resource; provided by the client when the resource is created.
7906 # The name must be 1-63 characters long, and comply withRFC1035.
7907 # Specifically, the name must be 1-63 characters long and match the regular
7908 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character
7909 # must be a lowercase letter, and all following characters (except for the
7910 # last character) must be a dash, lowercase letter, or digit. The last
7911 # character must be a lowercase letter or digit.
7912 &quot;network&quot;: &quot;A String&quot;, # URL of the network resource for this firewall rule. If not
7913 # specified when creating a firewall rule, the default network
7914 # is used:
7915 #
7916 # global/networks/default
7917 #
7918 # If you choose to specify this field, you can specify the network as a full
7919 # or partial URL. For example, the following are all valid URLs:
7920 #
7921 # -
7922 # https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
7923 # - projects/myproject/global/networks/my-network
7924 # - global/networks/default
7925 &quot;params&quot;: { # Additional firewall parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
7926 # as part of resource payload.
7927 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
7928 # Tag keys and values have the same definition as resource
7929 # manager tags. The field is allowed for INSERT
7930 # only. The keys/values to set on the resource should be specified in
7931 # either ID { : } or Namespaced format
7932 # { : }.
7933 # For example the following are valid inputs:
7934 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
7935 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
7936 # Note:
7937 # * Invalid combinations of ID &amp; namespaced format is not supported. For
7938 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
7939 &quot;a_key&quot;: &quot;A String&quot;,
7940 },
7941 },
7942 &quot;priority&quot;: 42, # Priority for this rule.
7943 # This is an integer between `0` and `65535`, both inclusive.
7944 # The default value is `1000`.
7945 # Relative priorities determine which rule takes effect if multiple rules
7946 # apply. Lower values indicate higher priority. For example, a rule with
7947 # priority `0` has higher precedence than a rule with priority `1`.
7948 # DENY rules take precedence over ALLOW rules if they have equal priority.
7949 # Note that VPC networks have implied
7950 # rules with a priority of `65535`. To avoid conflicts with the implied
7951 # rules, use a priority number less than `65535`.
7952 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
7953 &quot;sourceRanges&quot;: [ # If source ranges are specified, the firewall rule applies only to traffic
7954 # that has a source IP address in these ranges. These ranges must be
7955 # expressed inCIDR format. One or both of sourceRanges
7956 # and sourceTags may be set.
7957 # If both fields are set, the rule applies to traffic that has a
7958 # source IP address within sourceRanges OR a source IP
7959 # from a resource with a matching tag listed in thesourceTags field. The connection does not need to match
7960 # both fields for the rule to
7961 # apply. Both IPv4 and IPv6 are supported.
7962 &quot;A String&quot;,
7963 ],
7964 &quot;sourceServiceAccounts&quot;: [ # If source service accounts are specified, the firewall rules apply only to
7965 # traffic originating from an instance with a service account in this list.
7966 # Source service accounts cannot be used to control traffic to an instance&#x27;s
7967 # external IP address because service accounts are associated with an
7968 # instance, not an IP address.sourceRanges can be set at the same time assourceServiceAccounts.
7969 # If both are set, the firewall applies to traffic that
7970 # has a source IP address within the sourceRanges OR a source
7971 # IP that belongs to an instance with service account listed insourceServiceAccount. The connection does not need to match
7972 # both fields for the firewall to apply.sourceServiceAccounts cannot be used at the same time assourceTags or targetTags.
7973 &quot;A String&quot;,
7974 ],
7975 &quot;sourceTags&quot;: [ # If source tags are specified, the firewall rule applies only to traffic
7976 # with source IPs that match the primary network interfaces of VM instances
7977 # that have the tag and are in the same VPC network.
7978 # Source tags cannot be used to control traffic to an instance&#x27;s external IP
7979 # address, it only applies to traffic between instances in the same virtual
7980 # network. Because tags are associated with instances, not IP addresses.
7981 # One or both of sourceRanges and sourceTags may be
7982 # set. If both fields are set, the firewall applies to traffic that has a
7983 # source IP address within sourceRanges OR a source IP from a
7984 # resource with a matching tag listed in the sourceTags
7985 # field. The connection does not need to match both fields for the
7986 # firewall to apply.
7987 &quot;A String&quot;,
7988 ],
7989 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating sets of instances located in the
7990 # network that may make network connections as specified inallowed[].targetServiceAccounts cannot be used at the same time astargetTags or sourceTags.
7991 # If neither targetServiceAccounts nor targetTags
7992 # are specified, the firewall rule applies to all instances on the specified
7993 # network.
7994 &quot;A String&quot;,
7995 ],
7996 &quot;targetTags&quot;: [ # A list of tags that controls which instances the firewall rule
7997 # applies to. If targetTags are specified, then the firewall
7998 # rule applies only to instances in the VPC network that have one of those
7999 # tags. If no targetTags are specified, the firewall rule
8000 # applies to all instances on the specified network.
8001 &quot;A String&quot;,
8002 ],
8003 },
8004 ],
8005 }</pre>
8006 </div>
8007
8008 <div class="method">
8009 <code class="details" id="getGuestAttributes">getGuestAttributes(project, zone, instance, queryPath=None, variableKey=None, x__xgafv=None)</code>
8010 <pre>Returns the specified guest attributes entry.
8011
8012 Args:
8013 project: string, Project ID for this request. (required)
8014 zone: string, The name of the zone for this request. (required)
8015 instance: string, Name of the instance scoping this request. (required)
8016 queryPath: string, Specifies the guest attributes path to be queried.
8017 variableKey: string, Specifies the key for the guest attributes entry.
8018 x__xgafv: string, V1 error format.
8019 Allowed values
8020 1 - v1 error format
8021 2 - v2 error format
8022
8023 Returns:
8024 An object of the form:
8025
8026 { # A guest attributes entry.
8027 &quot;kind&quot;: &quot;compute#guestAttributes&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#guestAttributes for guest attributes entry.
8028 &quot;queryPath&quot;: &quot;A String&quot;, # The path to be queried. This can be the default namespace (&#x27;&#x27;) or a
8029 # nested namespace (&#x27;\/&#x27;) or a specified key
8030 # (&#x27;\/\&#x27;).
8031 &quot;queryValue&quot;: { # Array of guest attribute namespace/key/value tuples. # Output only. [Output Only] The value of the requested queried path.
8032 &quot;items&quot;: [
8033 { # A guest attributes namespace/key/value entry.
8034 &quot;key&quot;: &quot;A String&quot;, # Key for the guest attribute entry.
8035 &quot;namespace&quot;: &quot;A String&quot;, # Namespace for the guest attribute entry.
8036 &quot;value&quot;: &quot;A String&quot;, # Value for the guest attribute entry.
8037 },
8038 ],
8039 },
8040 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
8041 &quot;variableKey&quot;: &quot;A String&quot;, # The key to search for.
8042 &quot;variableValue&quot;: &quot;A String&quot;, # Output only. [Output Only] The value found for the requested key.
8043 }</pre>
8044 </div>
8045
8046 <div class="method">
8047 <code class="details" id="getIamPolicy">getIamPolicy(project, zone, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</code>
8048 <pre>Gets the access control policy for a resource. May be empty if no such
8049 policy or resource exists.
8050
8051 Args:
8052 project: string, Project ID for this request. (required)
8053 zone: string, The name of the zone for this request. (required)
8054 resource: string, Name or id of the resource for this request. (required)
8055 optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
8056 x__xgafv: string, V1 error format.
8057 Allowed values
8058 1 - v1 error format
8059 2 - v2 error format
8060
8061 Returns:
8062 An object of the form:
8063
8064 { # An Identity and Access Management (IAM) policy, which specifies access
8065 # controls for Google Cloud resources.
8066 #
8067 #
8068 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
8069 # `members`, or principals, to a single `role`. Principals can be user
8070 # accounts, service accounts, Google groups, and domains (such as G Suite). A
8071 # `role` is a named list of permissions; each `role` can be an IAM predefined
8072 # role or a user-created custom role.
8073 #
8074 # For some types of Google Cloud resources, a `binding` can also specify a
8075 # `condition`, which is a logical expression that allows access to a resource
8076 # only if the expression evaluates to `true`. A condition can add constraints
8077 # based on attributes of the request, the resource, or both. To learn which
8078 # resources support conditions in their IAM policies, see the
8079 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
8080 #
8081 # **JSON example:**
8082 #
8083 # ```
8084 # {
8085 # &quot;bindings&quot;: [
8086 # {
8087 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
8088 # &quot;members&quot;: [
8089 # &quot;user:[email protected]&quot;,
8090 # &quot;group:[email protected]&quot;,
8091 # &quot;domain:google.com&quot;,
8092 # &quot;serviceAccount:[email protected]&quot;
8093 # ]
8094 # },
8095 # {
8096 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
8097 # &quot;members&quot;: [
8098 # &quot;user:[email protected]&quot;
8099 # ],
8100 # &quot;condition&quot;: {
8101 # &quot;title&quot;: &quot;expirable access&quot;,
8102 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
8103 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
8104 # }
8105 # }
8106 # ],
8107 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
8108 # &quot;version&quot;: 3
8109 # }
8110 # ```
8111 #
8112 # **YAML example:**
8113 #
8114 # ```
8115 # bindings:
8116 # - members:
8117 # - user:[email protected]
8118 # - group:[email protected]
8119 # - domain:google.com
8120 # - serviceAccount:[email protected]
8121 # role: roles/resourcemanager.organizationAdmin
8122 # - members:
8123 # - user:[email protected]
8124 # role: roles/resourcemanager.organizationViewer
8125 # condition:
8126 # title: expirable access
8127 # description: Does not grant access after Sep 2020
8128 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
8129 # etag: BwWWja0YfJA=
8130 # version: 3
8131 # ```
8132 #
8133 # For a description of IAM and its features, see the
8134 # [IAM documentation](https://cloud.google.com/iam/docs/).
8135 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
8136 { # Specifies the audit configuration for a service.
8137 # The configuration determines which permission types are logged, and what
8138 # identities, if any, are exempted from logging.
8139 # An AuditConfig must have one or more AuditLogConfigs.
8140 #
8141 # If there are AuditConfigs for both `allServices` and a specific service,
8142 # the union of the two AuditConfigs is used for that service: the log_types
8143 # specified in each AuditConfig are enabled, and the exempted_members in each
8144 # AuditLogConfig are exempted.
8145 #
8146 # Example Policy with multiple AuditConfigs:
8147 #
8148 # {
8149 # &quot;audit_configs&quot;: [
8150 # {
8151 # &quot;service&quot;: &quot;allServices&quot;,
8152 # &quot;audit_log_configs&quot;: [
8153 # {
8154 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
8155 # &quot;exempted_members&quot;: [
8156 # &quot;user:[email protected]&quot;
8157 # ]
8158 # },
8159 # {
8160 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
8161 # },
8162 # {
8163 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
8164 # }
8165 # ]
8166 # },
8167 # {
8168 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
8169 # &quot;audit_log_configs&quot;: [
8170 # {
8171 # &quot;log_type&quot;: &quot;DATA_READ&quot;
8172 # },
8173 # {
8174 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
8175 # &quot;exempted_members&quot;: [
8176 # &quot;user:[email protected]&quot;
8177 # ]
8178 # }
8179 # ]
8180 # }
8181 # ]
8182 # }
8183 #
8184 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
8185 # logging. It also exempts `[email protected]` from DATA_READ logging, and
8186 # `[email protected]` from DATA_WRITE logging.
8187 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
8188 { # Provides the configuration for logging a type of permissions.
8189 # Example:
8190 #
8191 # {
8192 # &quot;audit_log_configs&quot;: [
8193 # {
8194 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
8195 # &quot;exempted_members&quot;: [
8196 # &quot;user:[email protected]&quot;
8197 # ]
8198 # },
8199 # {
8200 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
8201 # }
8202 # ]
8203 # }
8204 #
8205 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
8206 # [email protected] from DATA_READ logging.
8207 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
8208 # permission.
8209 # Follows the same format of Binding.members.
8210 &quot;A String&quot;,
8211 ],
8212 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
8213 },
8214 ],
8215 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
8216 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
8217 # `allServices` is a special value that covers all services.
8218 },
8219 ],
8220 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
8221 # may specify a `condition` that determines how and when the `bindings` are
8222 # applied. Each of the `bindings` must contain at least one principal.
8223 #
8224 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
8225 # of these principals can be Google groups. Each occurrence of a principal
8226 # counts towards these limits. For example, if the `bindings` grant 50
8227 # different roles to `user:[email protected]`, and not to any other
8228 # principal, then you can add another 1,450 principals to the `bindings` in
8229 # the `Policy`.
8230 { # Associates `members`, or principals, with a `role`.
8231 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
8232 #
8233 # If the condition evaluates to `true`, then this binding applies to the
8234 # current request.
8235 #
8236 # If the condition evaluates to `false`, then this binding does not apply to
8237 # the current request. However, a different role binding might grant the same
8238 # role to one or more of the principals in this binding.
8239 #
8240 # To learn which resources support conditions in their IAM policies, see the
8241 # [IAM
8242 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
8243 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
8244 # are documented at https://github.com/google/cel-spec.
8245 #
8246 # Example (Comparison):
8247 #
8248 # title: &quot;Summary size limit&quot;
8249 # description: &quot;Determines if a summary is less than 100 chars&quot;
8250 # expression: &quot;document.summary.size() &lt; 100&quot;
8251 #
8252 # Example (Equality):
8253 #
8254 # title: &quot;Requestor is owner&quot;
8255 # description: &quot;Determines if requestor is the document owner&quot;
8256 # expression: &quot;document.owner == request.auth.claims.email&quot;
8257 #
8258 # Example (Logic):
8259 #
8260 # title: &quot;Public documents&quot;
8261 # description: &quot;Determine whether the document should be publicly visible&quot;
8262 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
8263 #
8264 # Example (Data Manipulation):
8265 #
8266 # title: &quot;Notification string&quot;
8267 # description: &quot;Create a notification string with a timestamp.&quot;
8268 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
8269 #
8270 # The exact variables and functions that may be referenced within an expression
8271 # are determined by the service that evaluates it. See the service
8272 # documentation for additional information.
8273 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
8274 # describes the expression, e.g. when hovered over it in a UI.
8275 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
8276 # syntax.
8277 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
8278 # reporting, e.g. a file name and a position in the file.
8279 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
8280 # its purpose. This can be used e.g. in UIs which allow to enter the
8281 # expression.
8282 },
8283 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
8284 # `members` can have the following values:
8285 #
8286 # * `allUsers`: A special identifier that represents anyone who is
8287 # on the internet; with or without a Google account.
8288 #
8289 # * `allAuthenticatedUsers`: A special identifier that represents anyone
8290 # who is authenticated with a Google account or a service account.
8291 # Does not include identities that come from external identity providers
8292 # (IdPs) through identity federation.
8293 #
8294 # * `user:{emailid}`: An email address that represents a specific Google
8295 # account. For example, `[email protected]` .
8296 #
8297 #
8298 # * `serviceAccount:{emailid}`: An email address that represents a Google
8299 # service account. For example,
8300 # `[email protected]`.
8301 #
8302 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
8303 # identifier for a
8304 # [Kubernetes service
8305 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
8306 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
8307 #
8308 # * `group:{emailid}`: An email address that represents a Google group.
8309 # For example, `[email protected]`.
8310 #
8311 #
8312 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
8313 # users of that domain. For example, `google.com` or `example.com`.
8314 #
8315 #
8316 #
8317 #
8318 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
8319 # A single identity in a workforce identity pool.
8320 #
8321 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
8322 # All workforce identities in a group.
8323 #
8324 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
8325 # All workforce identities with a specific attribute value.
8326 #
8327 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
8328 # All identities in a workforce identity pool.
8329 #
8330 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
8331 # A single identity in a workload identity pool.
8332 #
8333 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
8334 # A workload identity pool group.
8335 #
8336 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
8337 # All identities in a workload identity pool with a certain attribute.
8338 #
8339 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
8340 # All identities in a workload identity pool.
8341 #
8342 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
8343 # identifier) representing a user that has been recently deleted. For
8344 # example, `[email protected]?uid=123456789012345678901`. If the user is
8345 # recovered, this value reverts to `user:{emailid}` and the recovered user
8346 # retains the role in the binding.
8347 #
8348 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
8349 # unique identifier) representing a service account that has been recently
8350 # deleted. For example,
8351 # `[email protected]?uid=123456789012345678901`.
8352 # If the service account is undeleted, this value reverts to
8353 # `serviceAccount:{emailid}` and the undeleted service account retains the
8354 # role in the binding.
8355 #
8356 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
8357 # identifier) representing a Google group that has been recently
8358 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
8359 # the group is recovered, this value reverts to `group:{emailid}` and the
8360 # recovered group retains the role in the binding.
8361 #
8362 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
8363 # Deleted single identity in a workforce identity pool. For example,
8364 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
8365 &quot;A String&quot;,
8366 ],
8367 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
8368 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
8369 #
8370 # For an overview of the IAM roles and permissions, see the
8371 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
8372 # a list of the available pre-defined roles, see
8373 # [here](https://cloud.google.com/iam/docs/understanding-roles).
8374 },
8375 ],
8376 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
8377 # prevent simultaneous updates of a policy from overwriting each other.
8378 # It is strongly suggested that systems make use of the `etag` in the
8379 # read-modify-write cycle to perform policy updates in order to avoid race
8380 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
8381 # systems are expected to put that etag in the request to `setIamPolicy` to
8382 # ensure that their change will be applied to the same version of the policy.
8383 #
8384 # **Important:** If you use IAM Conditions, you must include the `etag` field
8385 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
8386 # you to overwrite a version `3` policy with a version `1` policy, and all of
8387 # the conditions in the version `3` policy are lost.
8388 &quot;version&quot;: 42, # Specifies the format of the policy.
8389 #
8390 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
8391 # are rejected.
8392 #
8393 # Any operation that affects conditional role bindings must specify version
8394 # `3`. This requirement applies to the following operations:
8395 #
8396 # * Getting a policy that includes a conditional role binding
8397 # * Adding a conditional role binding to a policy
8398 # * Changing a conditional role binding in a policy
8399 # * Removing any role binding, with or without a condition, from a policy
8400 # that includes conditions
8401 #
8402 # **Important:** If you use IAM Conditions, you must include the `etag` field
8403 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
8404 # you to overwrite a version `3` policy with a version `1` policy, and all of
8405 # the conditions in the version `3` policy are lost.
8406 #
8407 # If a policy does not include any conditions, operations on that policy may
8408 # specify any valid version or leave the field unset.
8409 #
8410 # To learn which resources support conditions in their IAM policies, see the
8411 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
8412 }</pre>
8413 </div>
8414
8415 <div class="method">
8416 <code class="details" id="getScreenshot">getScreenshot(project, zone, instance, x__xgafv=None)</code>
8417 <pre>Returns the screenshot from the specified instance.
8418
8419 Args:
8420 project: string, Project ID for this request. (required)
8421 zone: string, The name of the zone for this request. (required)
8422 instance: string, Name of the instance scoping this request. (required)
8423 x__xgafv: string, V1 error format.
8424 Allowed values
8425 1 - v1 error format
8426 2 - v2 error format
8427
8428 Returns:
8429 An object of the form:
8430
8431 { # An instance&#x27;s screenshot.
8432 &quot;contents&quot;: &quot;A String&quot;, # [Output Only] The Base64-encoded screenshot data.
8433 &quot;kind&quot;: &quot;compute#screenshot&quot;, # Output only. [Output Only] Type of the resource. Always compute#screenshot
8434 # for the screenshots.
8435 }</pre>
8436 </div>
8437
8438 <div class="method">
8439 <code class="details" id="getSerialPortOutput">getSerialPortOutput(project, zone, instance, port=None, start=None, x__xgafv=None)</code>
8440 <pre>Returns the last 1 MB of serial port output from the specified instance.
8441
8442 Args:
8443 project: string, Project ID for this request. (required)
8444 zone: string, The name of the zone for this request. (required)
8445 instance: string, Name of the instance for this request. (required)
8446 port: integer, Specifies which COM or serial port to retrieve data from.
8447 start: string, Specifies the starting byte position of the output to return. To start with
8448 the first byte of output to the specified port, omit this field or set it
8449 to `0`.
8450
8451 If the output for that byte position is available, this field matches the
8452 `start` parameter sent with the request. If the amount of serial console
8453 output exceeds the size of the buffer (1 MB), the oldest output is
8454 discarded and is no longer available. If the requested start position
8455 refers to discarded output, the start position is adjusted to the oldest
8456 output still available, and the adjusted start position is returned as the
8457 `start` property value.
8458
8459 You can also provide a negative start position, which translates to the
8460 most recent number of bytes written to the serial port. For example, -3 is
8461 interpreted as the most recent 3 bytes written to the serial console. Note
8462 that the negative start is bounded by the retained buffer size, and the
8463 returned serial console output will not exceed the max buffer size.
8464 x__xgafv: string, V1 error format.
8465 Allowed values
8466 1 - v1 error format
8467 2 - v2 error format
8468
8469 Returns:
8470 An object of the form:
8471
8472 { # An instance serial console output.
8473 &quot;contents&quot;: &quot;A String&quot;, # [Output Only] The contents of the console output.
8474 &quot;kind&quot;: &quot;compute#serialPortOutput&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#serialPortOutput for serial port output.
8475 &quot;next&quot;: &quot;A String&quot;, # [Output Only] The position of the next byte of content, regardless of
8476 # whether the content exists, following the output returned in the `contents`
8477 # property. Use this value in the next request as the start
8478 # parameter.
8479 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
8480 &quot;start&quot;: &quot;A String&quot;, # The starting byte position of the output that was returned.
8481 # This should match the start parameter sent with the request.
8482 # If the serial console output exceeds the size of the buffer (1 MB), older
8483 # output is overwritten by newer content. The output start value will
8484 # indicate the byte position of the output that was returned, which might be
8485 # different than the `start` value that was specified in the request.
8486 }</pre>
8487 </div>
8488
8489 <div class="method">
8490 <code class="details" id="getShieldedInstanceIdentity">getShieldedInstanceIdentity(project, zone, instance, x__xgafv=None)</code>
8491 <pre>Returns the Shielded Instance Identity of an instance
8492
8493 Args:
8494 project: string, Project ID for this request. (required)
8495 zone: string, The name of the zone for this request. (required)
8496 instance: string, Name or id of the instance scoping this request. (required)
8497 x__xgafv: string, V1 error format.
8498 Allowed values
8499 1 - v1 error format
8500 2 - v2 error format
8501
8502 Returns:
8503 An object of the form:
8504
8505 { # A Shielded Instance Identity.
8506 &quot;eccP256EncryptionKey&quot;: { # A Shielded Instance Identity Entry. # An Endorsement Key (EK) made by the ECC P256 algorithm
8507 # issued to the Shielded Instance&#x27;s vTPM.
8508 &quot;ekCert&quot;: &quot;A String&quot;, # A PEM-encoded X.509 certificate. This field can be empty.
8509 &quot;ekPub&quot;: &quot;A String&quot;, # A PEM-encoded public key.
8510 },
8511 &quot;eccP256SigningKey&quot;: { # A Shielded Instance Identity Entry. # An Attestation Key (AK) made by the ECC P256 algorithm
8512 # issued to the Shielded Instance&#x27;s vTPM.
8513 &quot;ekCert&quot;: &quot;A String&quot;, # A PEM-encoded X.509 certificate. This field can be empty.
8514 &quot;ekPub&quot;: &quot;A String&quot;, # A PEM-encoded public key.
8515 },
8516 &quot;encryptionKey&quot;: { # A Shielded Instance Identity Entry. # An Endorsement Key (EK) made by the RSA 2048 algorithm
8517 # issued to the Shielded Instance&#x27;s vTPM.
8518 &quot;ekCert&quot;: &quot;A String&quot;, # A PEM-encoded X.509 certificate. This field can be empty.
8519 &quot;ekPub&quot;: &quot;A String&quot;, # A PEM-encoded public key.
8520 },
8521 &quot;kind&quot;: &quot;compute#shieldedInstanceIdentity&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#shieldedInstanceIdentity for shielded Instance
8522 # identity entry.
8523 &quot;signingKey&quot;: { # A Shielded Instance Identity Entry. # An Attestation Key (AK) made by the RSA 2048 algorithm
8524 # issued to the Shielded Instance&#x27;s vTPM.
8525 &quot;ekCert&quot;: &quot;A String&quot;, # A PEM-encoded X.509 certificate. This field can be empty.
8526 &quot;ekPub&quot;: &quot;A String&quot;, # A PEM-encoded public key.
8527 },
8528 }</pre>
8529 </div>
8530
8531 <div class="method">
8532 <code class="details" id="insert">insert(project, zone, body=None, requestId=None, sourceInstanceTemplate=None, sourceMachineImage=None, x__xgafv=None)</code>
8533 <pre>Creates an instance resource in the specified project using the data
8534 included in the request.
8535
8536 Args:
8537 project: string, Project ID for this request. (required)
8538 zone: string, The name of the zone for this request. (required)
8539 body: object, The request body.
8540 The object takes the form of:
8541
8542 { # Represents an Instance resource.
8543 #
8544 # An instance is a virtual machine that is hosted on Google Cloud Platform.
8545 # For more information, readVirtual Machine Instances.
8546 &quot;advancedMachineFeatures&quot;: { # Specifies options for controlling advanced machine features. # Controls for advanced machine-related behavior features.
8547 # Options that would traditionally be configured in a BIOS belong
8548 # here. Features that require operating system support may have
8549 # corresponding entries in the GuestOsFeatures of anImage (e.g., whether or not the OS in theImage supports nested virtualization being enabled or
8550 # disabled).
8551 &quot;enableNestedVirtualization&quot;: True or False, # Whether to enable nested virtualization or not (default is false).
8552 &quot;enableUefiNetworking&quot;: True or False, # Whether to enable UEFI networking for instance creation.
8553 &quot;performanceMonitoringUnit&quot;: &quot;A String&quot;, # Type of Performance Monitoring Unit requested on instance.
8554 &quot;threadsPerCore&quot;: 42, # The number of threads per physical core. To disable simultaneous
8555 # multithreading (SMT) set this to 1. If unset, the maximum number
8556 # of threads supported per core by the underlying processor is
8557 # assumed.
8558 &quot;turboMode&quot;: &quot;A String&quot;, # Turbo frequency mode to use for the instance.
8559 # Supported modes include:
8560 # * ALL_CORE_MAX
8561 #
8562 # Using empty string or not setting this field will use the platform-specific
8563 # default turbo mode.
8564 &quot;visibleCoreCount&quot;: 42, # The number of physical cores to expose to an instance. Multiply by
8565 # the number of threads per core to compute the total number of virtual
8566 # CPUs to expose to the instance. If unset, the number of cores is
8567 # inferred from the instance&#x27;s nominal CPU count and the underlying
8568 # platform&#x27;s SMT width.
8569 },
8570 &quot;canIpForward&quot;: True or False, # Allows this instance to send and receive packets with non-matching
8571 # destination or source IPs. This is required if you plan to use this
8572 # instance to forward routes. For more information, seeEnabling IP Forwarding.
8573 &quot;confidentialInstanceConfig&quot;: { # A set of Confidential Instance options.
8574 &quot;confidentialInstanceType&quot;: &quot;A String&quot;, # Defines the type of technology used by the confidential instance.
8575 &quot;enableConfidentialCompute&quot;: True or False, # Defines whether the instance should have confidential compute enabled.
8576 },
8577 &quot;cpuPlatform&quot;: &quot;A String&quot;, # Output only. [Output Only] The CPU platform used by this instance.
8578 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339 text format.
8579 &quot;deletionProtection&quot;: True or False, # Whether the resource should be protected against deletion.
8580 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
8581 # create the resource.
8582 &quot;disks&quot;: [ # Array of disks associated with this instance. Persistent disks must be
8583 # created before you can assign them.
8584 { # An instance-attached disk resource.
8585 &quot;architecture&quot;: &quot;A String&quot;, # Output only. [Output Only] The architecture of the attached disk. Valid values are ARM64
8586 # or X86_64.
8587 &quot;autoDelete&quot;: True or False, # Specifies whether the disk will be auto-deleted when the instance is
8588 # deleted (but not when the disk is detached from the instance).
8589 &quot;boot&quot;: True or False, # Indicates that this is a boot disk. The virtual machine will use the first
8590 # partition of the disk for its root filesystem.
8591 &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
8592 # running within the instance. This name can be used to reference the device
8593 # for mounting, resizing, and so on, from within the instance.
8594 #
8595 # If not specified, the server chooses a default device name to apply to this
8596 # disk, in the form persistent-disk-x, where x is a number
8597 # assigned by Google Compute Engine. This field is only applicable for
8598 # persistent disks.
8599 &quot;diskEncryptionKey&quot;: { # Encrypts or decrypts a disk using acustomer-supplied
8600 # encryption key.
8601 #
8602 # If you are creating a new disk, this field encrypts the new disk using
8603 # an encryption key that you provide. If you are attaching an existing
8604 # disk that is already encrypted, this field decrypts the disk using
8605 # the customer-supplied encryption key.
8606 #
8607 # If you encrypt a disk using a customer-supplied key, you must provide the
8608 # same key again when you attempt to use this resource at a later time. For
8609 # example, you must provide the key when you create a snapshot or an image
8610 # from the disk or when you attach the disk to a virtual machine instance.
8611 #
8612 # If you do not provide an encryption key, then the disk will be encrypted
8613 # using an automatically generated key and you do not need to provide a key
8614 # to use the disk later.
8615 #
8616 # Note:
8617 #
8618 # Instance templates do not storecustomer-supplied
8619 # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
8620 #
8621 # You cannot create VMs that have disks with customer-supplied keys using
8622 # the bulk
8623 # insert method.
8624 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
8625 # For example:
8626 #
8627 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
8628 # key_region/cryptoKeys/key
8629 #
8630 # The fully-qualifed key name may be returned for resource GET requests. For
8631 # example:
8632 #
8633 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
8634 # key_region/cryptoKeys/key
8635 # /cryptoKeyVersions/1
8636 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
8637 # key. If absent, the Compute Engine default service account is used.
8638 # For example:
8639 #
8640 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
8641 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
8642 # encryption key, encoded in RFC
8643 # 4648 base64 to either encrypt or decrypt this resource. You can
8644 # provide either the rawKey or thersaEncryptedKey.
8645 # For example:
8646 #
8647 # &quot;rawKey&quot;:
8648 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
8649 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
8650 # customer-supplied encryption key to either encrypt or decrypt this
8651 # resource. You can provide either the rawKey or thersaEncryptedKey.
8652 # For example:
8653 #
8654 # &quot;rsaEncryptedKey&quot;:
8655 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
8656 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
8657 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
8658 #
8659 # The key must meet the following requirements before you can provide it to
8660 # Compute Engine:
8661 #
8662 # 1. The key is wrapped using a RSA public key certificate provided by
8663 # Google.
8664 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
8665 # encoding.
8666 #
8667 # Gets the RSA public key certificate provided by Google at:
8668 #
8669 #
8670 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
8671 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
8672 # 4648 base64 encoded SHA-256 hash of the customer-supplied
8673 # encryption key that protects this resource.
8674 },
8675 &quot;diskSizeGb&quot;: &quot;A String&quot;, # The size of the disk in GB.
8676 &quot;forceAttach&quot;: True or False, # [Input Only] Whether to force attach the regional disk even if it&#x27;s
8677 # currently attached to another instance. If you try to force attach a zonal
8678 # disk to an instance, you will receive an error.
8679 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
8680 # only for bootable images. Read
8681 # Enabling guest operating system features to see a list of available
8682 # options.
8683 { # Guest OS features.
8684 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
8685 # separate values. Set to one or more of the following values:
8686 #
8687 # - VIRTIO_SCSI_MULTIQUEUE
8688 # - WINDOWS
8689 # - MULTI_IP_SUBNET
8690 # - UEFI_COMPATIBLE
8691 # - GVNIC
8692 # - SEV_CAPABLE
8693 # - SUSPEND_RESUME_COMPATIBLE
8694 # - SEV_LIVE_MIGRATABLE_V2
8695 # - SEV_SNP_CAPABLE
8696 # - TDX_CAPABLE
8697 # - IDPF
8698 # - SNP_SVSM_CAPABLE
8699 # - CCA_CAPABLE
8700 #
8701 #
8702 # For more information, see
8703 # Enabling guest operating system features.
8704 },
8705 ],
8706 &quot;index&quot;: 42, # Output only. [Output Only] A zero-based index to this disk, where 0 is reserved for the
8707 # boot disk. If you have many disks attached to an instance, each
8708 # disk would have a unique index number.
8709 &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
8710 # alongside the new instance. Use initialization parameters to create boot
8711 # disks or local SSDs attached to the new instance.
8712 #
8713 # This property is mutually exclusive with the source property;
8714 # you can only define one or the other, but not both.
8715 # alongside the new instance. Use initialization parameters to create boot
8716 # disks or local SSDs attached to the new instance.
8717 #
8718 # This field is persisted and returned for instanceTemplate and not returned
8719 # in the context of instance.
8720 #
8721 # This property is mutually exclusive with the source property;
8722 # you can only define one or the other, but not both.
8723 &quot;architecture&quot;: &quot;A String&quot;, # The architecture of the attached disk. Valid values are
8724 # arm64 or x86_64.
8725 &quot;description&quot;: &quot;A String&quot;, # An optional description. Provide this property when creating the disk.
8726 &quot;diskName&quot;: &quot;A String&quot;, # Specifies the disk name. If not specified, the default is to use the name
8727 # of the instance. If a disk with the same name already exists in the given
8728 # region, the existing disk is attached to the new instance and the
8729 # new disk is not created.
8730 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB. The size must be at least
8731 # 10 GB. If you specify a sourceImage, which is required for
8732 # boot disks, the default size is the size of the sourceImage.
8733 # If you do not specify a sourceImage, the default disk size
8734 # is 500 GB.
8735 &quot;diskType&quot;: &quot;A String&quot;,
8736 &quot;enableConfidentialCompute&quot;: True or False, # Whether this disk is using confidential compute mode.
8737 &quot;labels&quot;: { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
8738 # persistent disks.
8739 &quot;a_key&quot;: &quot;A String&quot;,
8740 },
8741 &quot;licenses&quot;: [ # A list of publicly visible licenses. Reserved for Google&#x27;s use.
8742 &quot;A String&quot;,
8743 ],
8744 &quot;onUpdateAction&quot;: &quot;A String&quot;, # Specifies which action to take on instance update with this disk. Default
8745 # is to use the existing disk.
8746 &quot;provisionedIops&quot;: &quot;A String&quot;, # Indicates how many IOPS to provision for the disk. This sets the number
8747 # of I/O operations per second that the disk can handle. Values must be
8748 # between 10,000 and 120,000. For more details, see theExtreme persistent
8749 # disk documentation.
8750 &quot;provisionedThroughput&quot;: &quot;A String&quot;, # Indicates how much throughput to provision for the disk. This sets the
8751 # number of throughput mb per second that the disk can handle. Values must
8752 # greater than or equal to 1.
8753 &quot;replicaZones&quot;: [ # Required for each regional disk associated with the instance. Specify
8754 # the URLs of the zones where the disk should be replicated to.
8755 # You must provide exactly two replica zones, and one zone must be the same
8756 # as the instance zone.
8757 &quot;A String&quot;,
8758 ],
8759 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
8760 # have the same definition as resource
8761 # manager tags. Keys and values can be either in numeric format,
8762 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
8763 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
8764 # `{tag_value_short_name}`. The field is ignored (both PUT &amp; PATCH) when
8765 # empty.
8766 &quot;a_key&quot;: &quot;A String&quot;,
8767 },
8768 &quot;resourcePolicies&quot;: [ # Resource policies applied to this disk for automatic snapshot creations.
8769 # Specified using the full or partial URL. For instance template, specify
8770 # only the resource policy name.
8771 &quot;A String&quot;,
8772 ],
8773 &quot;sourceImage&quot;: &quot;A String&quot;, # The source image to create this disk. When creating a new instance boot
8774 # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
8775 # is required.
8776 #
8777 # To create a disk with one of the public operating system
8778 # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
8779 #
8780 # projects/debian-cloud/global/images/family/debian-9
8781 #
8782 #
8783 # Alternatively, use a specific version of a public operating system image:
8784 #
8785 # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
8786 #
8787 #
8788 # To create a disk with a custom image that you created, specify the
8789 # image name in the following format:
8790 #
8791 # global/images/my-custom-image
8792 #
8793 #
8794 # You can also specify a custom image by its image family, which returns
8795 # the latest version of the image in that family. Replace the image name
8796 # with family/family-name:
8797 #
8798 # global/images/family/my-image-family
8799 #
8800 #
8801 # If the source image is deleted later, this field will not be set.
8802 &quot;sourceImageEncryptionKey&quot;: { # Thecustomer-supplied
8803 # encryption key of the source image. Required if the source image is
8804 # protected by a customer-supplied encryption key.
8805 #
8806 # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
8807 # encryption keys, so you cannot create disks for instances in a managed instance group if the
8808 # source images are encrypted with your own keys.
8809 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
8810 # For example:
8811 #
8812 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
8813 # key_region/cryptoKeys/key
8814 #
8815 # The fully-qualifed key name may be returned for resource GET requests. For
8816 # example:
8817 #
8818 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
8819 # key_region/cryptoKeys/key
8820 # /cryptoKeyVersions/1
8821 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
8822 # key. If absent, the Compute Engine default service account is used.
8823 # For example:
8824 #
8825 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
8826 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
8827 # encryption key, encoded in RFC
8828 # 4648 base64 to either encrypt or decrypt this resource. You can
8829 # provide either the rawKey or thersaEncryptedKey.
8830 # For example:
8831 #
8832 # &quot;rawKey&quot;:
8833 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
8834 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
8835 # customer-supplied encryption key to either encrypt or decrypt this
8836 # resource. You can provide either the rawKey or thersaEncryptedKey.
8837 # For example:
8838 #
8839 # &quot;rsaEncryptedKey&quot;:
8840 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
8841 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
8842 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
8843 #
8844 # The key must meet the following requirements before you can provide it to
8845 # Compute Engine:
8846 #
8847 # 1. The key is wrapped using a RSA public key certificate provided by
8848 # Google.
8849 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
8850 # encoding.
8851 #
8852 # Gets the RSA public key certificate provided by Google at:
8853 #
8854 #
8855 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
8856 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
8857 # 4648 base64 encoded SHA-256 hash of the customer-supplied
8858 # encryption key that protects this resource.
8859 },
8860 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # The source snapshot to create this disk. When creating a new instance
8861 # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
8862 # is required.
8863 #
8864 # To create a disk with a snapshot that you created, specify the
8865 # snapshot name in the following format:
8866 #
8867 # global/snapshots/my-backup
8868 #
8869 #
8870 # If the source snapshot is deleted later, this field will not be set.
8871 #
8872 # Note: You cannot create VMs in bulk using a snapshot as the source. Use
8873 # an image instead when you create VMs using
8874 # the bulk
8875 # insert method.
8876 &quot;sourceSnapshotEncryptionKey&quot;: { # Thecustomer-supplied
8877 # encryption key of the source snapshot.
8878 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
8879 # For example:
8880 #
8881 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
8882 # key_region/cryptoKeys/key
8883 #
8884 # The fully-qualifed key name may be returned for resource GET requests. For
8885 # example:
8886 #
8887 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
8888 # key_region/cryptoKeys/key
8889 # /cryptoKeyVersions/1
8890 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
8891 # key. If absent, the Compute Engine default service account is used.
8892 # For example:
8893 #
8894 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
8895 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
8896 # encryption key, encoded in RFC
8897 # 4648 base64 to either encrypt or decrypt this resource. You can
8898 # provide either the rawKey or thersaEncryptedKey.
8899 # For example:
8900 #
8901 # &quot;rawKey&quot;:
8902 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
8903 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
8904 # customer-supplied encryption key to either encrypt or decrypt this
8905 # resource. You can provide either the rawKey or thersaEncryptedKey.
8906 # For example:
8907 #
8908 # &quot;rsaEncryptedKey&quot;:
8909 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
8910 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
8911 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
8912 #
8913 # The key must meet the following requirements before you can provide it to
8914 # Compute Engine:
8915 #
8916 # 1. The key is wrapped using a RSA public key certificate provided by
8917 # Google.
8918 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
8919 # encoding.
8920 #
8921 # Gets the RSA public key certificate provided by Google at:
8922 #
8923 #
8924 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
8925 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
8926 # 4648 base64 encoded SHA-256 hash of the customer-supplied
8927 # encryption key that protects this resource.
8928 },
8929 &quot;storagePool&quot;: &quot;A String&quot;, # The storage pool in which the new disk is created. You can provide
8930 # this as a partial or full URL to the resource. For example, the following
8931 # are valid values:
8932 #
8933 #
8934 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
8935 # - projects/project/zones/zone/storagePools/storagePool
8936 # - zones/zone/storagePools/storagePool
8937 },
8938 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is
8939 # either SCSI or NVME. For most machine types, the
8940 # default is SCSI. Local SSDs can use either NVME or SCSI.
8941 # In certain configurations, persistent disks can use NVMe. For more
8942 # information, seeAbout
8943 # persistent disks.
8944 &quot;kind&quot;: &quot;compute#attachedDisk&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
8945 &quot;licenses&quot;: [ # Output only. [Output Only] Any valid publicly visible licenses.
8946 &quot;A String&quot;,
8947 ],
8948 &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
8949 # in READ_WRITE mode.
8950 &quot;savedState&quot;: &quot;A String&quot;, # Output only. For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
8951 # field is set to PRESERVED if the LocalSSD data has been saved
8952 # to a persistent location by customer request. (see the
8953 # discard_local_ssd option on Stop/Suspend).
8954 # Read-only in the api.
8955 &quot;shieldedInstanceInitialState&quot;: { # Initial State for shielded instance, # Output only. [Output Only] shielded vm initial state stored on disk
8956 # these are public keys which are safe to store in public
8957 &quot;dbs&quot;: [ # The Key Database (db).
8958 {
8959 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
8960 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
8961 },
8962 ],
8963 &quot;dbxs&quot;: [ # The forbidden key database (dbx).
8964 {
8965 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
8966 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
8967 },
8968 ],
8969 &quot;keks&quot;: [ # The Key Exchange Key (KEK).
8970 {
8971 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
8972 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
8973 },
8974 ],
8975 &quot;pk&quot;: { # The Platform Key (PK).
8976 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
8977 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
8978 },
8979 },
8980 &quot;source&quot;: &quot;A String&quot;, # Specifies a valid partial or full URL to an existing Persistent Disk
8981 # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
8982 # is required.
8983 #
8984 # If desired, you can also attach existing non-root persistent disks using
8985 # this property. This field is only applicable for persistent disks.
8986 #
8987 # Note that for InstanceTemplate, specify the disk name for zonal disk,
8988 # and the URL for regional disk.
8989 &quot;type&quot;: &quot;A String&quot;, # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
8990 },
8991 ],
8992 &quot;displayDevice&quot;: { # A set of Display Device options # Enables display device for the instance.
8993 &quot;enableDisplay&quot;: True or False, # Defines whether the instance has Display enabled.
8994 },
8995 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this resource, which is essentially a hash of
8996 # the instance&#x27;s contents and used for optimistic locking. The
8997 # fingerprint is initially generated by Compute Engine and changes after
8998 # every request to modify or update the instance. You must always provide an
8999 # up-to-date fingerprint hash in order to update the instance.
9000 #
9001 # To see the latest fingerprint, make get() request to the
9002 # instance.
9003 &quot;guestAccelerators&quot;: [ # A list of the type and count of accelerator cards attached to the instance.
9004 { # A specification of the type and number of accelerator cards attached to the
9005 # instance.
9006 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
9007 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this
9008 # instance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100
9009 # If you are creating an instance template, specify only the
9010 # accelerator name.
9011 # See GPUs on Compute Engine
9012 # for a full list of accelerator types.
9013 },
9014 ],
9015 &quot;hostname&quot;: &quot;A String&quot;, # Specifies the hostname of the instance. The specified hostname must be
9016 # RFC1035 compliant. If hostname is not specified, the default hostname is
9017 # [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and
9018 # [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.
9019 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
9020 # defined by the server.
9021 &quot;instanceEncryptionKey&quot;: { # Encrypts suspended data for an instance with acustomer-managed
9022 # encryption key.
9023 #
9024 # If you are creating a new instance, this field will encrypt the local SSD
9025 # and in-memory contents of the instance during the suspend operation.
9026 #
9027 # If you do not provide an encryption key when creating the instance, then
9028 # the local SSD and in-memory contents will be encrypted using
9029 # an automatically generated key during the suspend operation.
9030 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
9031 # For example:
9032 #
9033 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
9034 # key_region/cryptoKeys/key
9035 #
9036 # The fully-qualifed key name may be returned for resource GET requests. For
9037 # example:
9038 #
9039 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
9040 # key_region/cryptoKeys/key
9041 # /cryptoKeyVersions/1
9042 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
9043 # key. If absent, the Compute Engine default service account is used.
9044 # For example:
9045 #
9046 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
9047 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
9048 # encryption key, encoded in RFC
9049 # 4648 base64 to either encrypt or decrypt this resource. You can
9050 # provide either the rawKey or thersaEncryptedKey.
9051 # For example:
9052 #
9053 # &quot;rawKey&quot;:
9054 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
9055 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
9056 # customer-supplied encryption key to either encrypt or decrypt this
9057 # resource. You can provide either the rawKey or thersaEncryptedKey.
9058 # For example:
9059 #
9060 # &quot;rsaEncryptedKey&quot;:
9061 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
9062 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
9063 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
9064 #
9065 # The key must meet the following requirements before you can provide it to
9066 # Compute Engine:
9067 #
9068 # 1. The key is wrapped using a RSA public key certificate provided by
9069 # Google.
9070 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
9071 # encoding.
9072 #
9073 # Gets the RSA public key certificate provided by Google at:
9074 #
9075 #
9076 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
9077 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
9078 # 4648 base64 encoded SHA-256 hash of the customer-supplied
9079 # encryption key that protects this resource.
9080 },
9081 &quot;keyRevocationActionType&quot;: &quot;A String&quot;, # KeyRevocationActionType of the instance. Supported options are &quot;STOP&quot; and
9082 # &quot;NONE&quot;. The default value is &quot;NONE&quot; if it is not specified.
9083 &quot;kind&quot;: &quot;compute#instance&quot;, # Output only. [Output Only] Type of the resource. Always compute#instance
9084 # for instances.
9085 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for this request, which is essentially a hash of
9086 # the label&#x27;s contents and used for optimistic locking. The
9087 # fingerprint is initially generated by Compute Engine and changes after
9088 # every request to modify or update labels. You must always provide an
9089 # up-to-date fingerprint hash in order to update or change labels.
9090 #
9091 # To see the latest fingerprint, make get() request to the
9092 # instance.
9093 &quot;labels&quot;: { # Labels to apply to this instance. These can be later modified by
9094 # the setLabels method.
9095 &quot;a_key&quot;: &quot;A String&quot;,
9096 },
9097 &quot;lastStartTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last start timestamp inRFC3339 text format.
9098 &quot;lastStopTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last stop timestamp inRFC3339 text format.
9099 &quot;lastSuspendedTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last suspended timestamp inRFC3339 text format.
9100 &quot;machineType&quot;: &quot;A String&quot;, # Full or partial URL of the machine type resource to use for this instance,
9101 # in the format:zones/zone/machineTypes/machine-type. This is provided by the client
9102 # when the instance is created. For example, the following is a valid partial
9103 # url to a predefined
9104 # machine type:
9105 #
9106 # zones/us-central1-f/machineTypes/n1-standard-1
9107 #
9108 #
9109 # To create acustom
9110 # machine type, provide a URL to a machine type in the following format,
9111 # where CPUS is 1 or an even number up to 32 (2,
9112 # 4, 6, ... 24, etc), and MEMORY is the total
9113 # memory for this instance. Memory must be a multiple of 256 MB and must
9114 # be supplied in MB (e.g. 5 GB of memory is 5120 MB):
9115 #
9116 # zones/zone/machineTypes/custom-CPUS-MEMORY
9117 #
9118 #
9119 # For example: zones/us-central1-f/machineTypes/custom-4-5120
9120 # For a full list of restrictions, read theSpecifications
9121 # for custom machine types.
9122 &quot;metadata&quot;: { # A metadata key/value entry. # The metadata key/value pairs assigned
9123 # to this instance. This includes metadata keys that were explicitly defined
9124 # for the instance.
9125 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
9126 # the metadata&#x27;s contents and used for optimistic locking. The
9127 # fingerprint is initially generated by Compute Engine and changes after
9128 # every request to modify or update metadata. You must always provide an
9129 # up-to-date fingerprint hash in order to update or change metadata,
9130 # otherwise the request will fail with error412 conditionNotMet.
9131 #
9132 # To see the latest fingerprint, make a get() request to
9133 # retrieve the resource.
9134 &quot;items&quot;: [ # Array of key/value pairs. The total size of all keys and values must be
9135 # less than 512 KB.
9136 { # Metadata
9137 &quot;key&quot;: &quot;A String&quot;, # Key for the metadata entry. Keys must conform to the following
9138 # regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length.
9139 # This is reflected as part of a URL in the metadata server. Additionally, to
9140 # avoid ambiguity, keys must not conflict with any other metadata keys
9141 # for the project.
9142 &quot;value&quot;: &quot;A String&quot;, # Value for the metadata entry. These are free-form strings, and only
9143 # have meaning as interpreted by the image running in the instance. The
9144 # only restriction placed on values is that their size must be less than
9145 # or equal to 262144 bytes (256 KiB).
9146 },
9147 ],
9148 &quot;kind&quot;: &quot;compute#metadata&quot;, # Output only. [Output Only] Type of the resource. Always compute#metadata
9149 # for metadata.
9150 },
9151 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Specifies aminimum CPU
9152 # platform for the VM instance. Applicable values are the friendly names
9153 # of CPU platforms, such as minCpuPlatform: &quot;Intel
9154 # Haswell&quot; or minCpuPlatform: &quot;Intel Sandy
9155 # Bridge&quot;.
9156 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating
9157 # the resource. The resource name must be 1-63 characters long, and comply
9158 # withRFC1035.
9159 # Specifically, the name must be 1-63 characters long and match the regular
9160 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
9161 # character must be a lowercase letter, and all following characters must be
9162 # a dash, lowercase letter, or digit, except the last character, which cannot
9163 # be a dash.
9164 &quot;networkInterfaces&quot;: [ # An array of network configurations for this instance. These specify how
9165 # interfaces are configured to interact with other network services, such as
9166 # connecting to the internet. Multiple interfaces are supported
9167 # per instance.
9168 { # A network interface resource attached to an instance.
9169 &quot;accessConfigs&quot;: [ # An array of configurations for this interface. Currently, only one access
9170 # config, ONE_TO_ONE_NAT, is supported. If there are noaccessConfigs specified, then this instance will have
9171 # no external internet access.
9172 { # An access configuration attached to an instance&#x27;s network interface.
9173 # Only one access config per instance is supported.
9174 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
9175 # The first IPv6 address of the external IPv6 range associated
9176 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
9177 # use a static external IP address, it must be unused and in the same region
9178 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
9179 # assign an external IPv6 address from the instance&#x27;s subnetwork.
9180 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
9181 # external IPv6 range.
9182 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
9183 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
9184 # (IPv4), the default and recommended name is External NAT, but
9185 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
9186 # recommend name is External IPv6.
9187 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
9188 # address associated with this instance. Specify an unused static
9189 # external IP address available to the project or leave this field undefined
9190 # to use an IP from a shared ephemeral IP address pool. If you specify a
9191 # static external IP address, it must live in the same region as the zone of
9192 # the instance.
9193 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
9194 # configuration and can only take the following values: PREMIUM,STANDARD.
9195 #
9196 # If an AccessConfig is specified without a valid external IP address, an
9197 # ephemeral IP will be created with this networkTier.
9198 #
9199 # If an AccessConfig with a valid external IP address is specified, it must
9200 # match that of the networkTier associated with the Address resource owning
9201 # that IP.
9202 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
9203 #
9204 # 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
9205 # first IP in associated external IPv6 range.
9206 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
9207 # config.
9208 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
9209 # external IP address of the instance to a DNS domain name.
9210 #
9211 # This field is not used in ipv6AccessConfig. A default PTR
9212 # record will be created if the VM has external IPv6 range associated.
9213 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
9214 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
9215 },
9216 ],
9217 &quot;aliasIpRanges&quot;: [ # An array of alias IP ranges for this network interface.
9218 # You can only specify this field for network interfaces in VPC networks.
9219 { # An alias IP range attached to an instance&#x27;s network interface.
9220 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
9221 # must belong to the specified subnetwork and cannot contain IP addresses
9222 # reserved by system or used by other network interfaces. This range may be
9223 # 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).
9224 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
9225 # alias range. If not specified, the primary range of the subnetwork is used.
9226 },
9227 ],
9228 &quot;aliasIpv6Ranges&quot;: [ # An array of alias IPv6 ranges for this network interface.
9229 # You can only specify this field for network interfaces in VPC networks.
9230 { # An alias IP range attached to an instance&#x27;s network interface.
9231 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
9232 # must belong to the specified subnetwork and cannot contain IP addresses
9233 # reserved by system or used by other network interfaces. This range may be
9234 # 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).
9235 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
9236 # alias range. If not specified, the primary range of the subnetwork is used.
9237 },
9238 ],
9239 &quot;enableVpcScopedDns&quot;: True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
9240 # with network_attachment.
9241 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint hash of contents stored in this network interface.
9242 # This field will be ignored when inserting an Instance or
9243 # adding a NetworkInterface. An up-to-date
9244 # 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.
9245 &quot;igmpQuery&quot;: &quot;A String&quot;, # Indicate whether igmp query is enabled on the network interface
9246 # or not. If enabled, also indicates the version of IGMP supported.
9247 &quot;internalIpv6PrefixLength&quot;: 42, # The prefix length of the primary internal IPv6 range.
9248 &quot;ipv6AccessConfigs&quot;: [ # An array of IPv6 access configurations for this interface. Currently, only
9249 # one IPv6 access config, DIRECT_IPV6, is supported. If there
9250 # is no ipv6AccessConfig specified, then this instance will
9251 # have no external IPv6 Internet access.
9252 { # An access configuration attached to an instance&#x27;s network interface.
9253 # Only one access config per instance is supported.
9254 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
9255 # The first IPv6 address of the external IPv6 range associated
9256 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
9257 # use a static external IP address, it must be unused and in the same region
9258 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
9259 # assign an external IPv6 address from the instance&#x27;s subnetwork.
9260 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
9261 # external IPv6 range.
9262 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
9263 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
9264 # (IPv4), the default and recommended name is External NAT, but
9265 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
9266 # recommend name is External IPv6.
9267 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
9268 # address associated with this instance. Specify an unused static
9269 # external IP address available to the project or leave this field undefined
9270 # to use an IP from a shared ephemeral IP address pool. If you specify a
9271 # static external IP address, it must live in the same region as the zone of
9272 # the instance.
9273 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
9274 # configuration and can only take the following values: PREMIUM,STANDARD.
9275 #
9276 # If an AccessConfig is specified without a valid external IP address, an
9277 # ephemeral IP will be created with this networkTier.
9278 #
9279 # If an AccessConfig with a valid external IP address is specified, it must
9280 # match that of the networkTier associated with the Address resource owning
9281 # that IP.
9282 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
9283 #
9284 # 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
9285 # first IP in associated external IPv6 range.
9286 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
9287 # config.
9288 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
9289 # external IP address of the instance to a DNS domain name.
9290 #
9291 # This field is not used in ipv6AccessConfig. A default PTR
9292 # record will be created if the VM has external IPv6 range associated.
9293 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
9294 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
9295 },
9296 ],
9297 &quot;ipv6AccessType&quot;: &quot;A String&quot;, # Output only. [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be
9298 # accessed from the Internet. This field is always inherited from its
9299 # subnetwork.
9300 #
9301 # Valid only if stackType is IPV4_IPV6.
9302 &quot;ipv6Address&quot;: &quot;A String&quot;, # An IPv6 internal network address for this network interface. To
9303 # use a static internal IP address, it must be unused and in the same region
9304 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
9305 # assign an internal IPv6 address from the instance&#x27;s subnetwork.
9306 &quot;kind&quot;: &quot;compute#networkInterface&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#networkInterface for network interfaces.
9307 &quot;name&quot;: &quot;A String&quot;, # [Output Only] The name of the network interface, which is generated by the
9308 # server. For a VM, the network interface uses the nicN naming
9309 # format. Where N is a value between 0 and7. The default interface value is nic0.
9310 &quot;network&quot;: &quot;A String&quot;, # URL of the VPC network resource for this instance. When creating an
9311 # instance, if neither the network nor the subnetwork is specified, the
9312 # default network global/networks/default is used. If the
9313 # selected project doesn&#x27;t have the default network, you must specify a
9314 # network or subnet. If the network is not specified but the subnetwork is
9315 # specified, the network is inferred.
9316 #
9317 # If you specify this property, you can specify the network as
9318 # a full or partial URL. For example, the following are all valid URLs:
9319 #
9320 #
9321 # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
9322 # - projects/project/global/networks/network
9323 # - global/networks/default
9324 &quot;networkAttachment&quot;: &quot;A String&quot;, # The URL of the network attachment that this interface should connect
9325 # to in the following format:
9326 # projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.
9327 &quot;networkIP&quot;: &quot;A String&quot;, # An IPv4 internal IP address to assign to the instance for this network
9328 # interface. If not specified by the user, an unused internal IP is
9329 # assigned by the system.
9330 &quot;nicType&quot;: &quot;A String&quot;, # The type of vNIC to be used on this interface. This may be gVNIC or
9331 # VirtioNet.
9332 &quot;parentNicName&quot;: &quot;A String&quot;, # Name of the parent network interface of a dynamic network interface.
9333 &quot;queueCount&quot;: 42, # The networking queue count that&#x27;s specified by users for the network
9334 # interface. Both Rx and Tx queues will be set to this number. It&#x27;ll be empty
9335 # if not specified by the users.
9336 &quot;serviceClassId&quot;: &quot;A String&quot;, # Optional. Producer Service&#x27;s Service class Id for the region of this network
9337 # interface. Can only be used with network_attachment. It is not possible to
9338 # use on its own however, network_attachment can be used without
9339 # service_class_id.
9340 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for this network interface. To assign only IPv4 addresses,
9341 # use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, useIPV4_IPV6. If not specified, IPV4_ONLY is used.
9342 #
9343 # This field can be both set at instance creation and update network
9344 # interface operations.
9345 &quot;subnetwork&quot;: &quot;A String&quot;, # The URL of the Subnetwork resource for this instance. If the network
9346 # resource is inlegacy
9347 # mode, do not specify this field. If the network is in auto subnet
9348 # mode, specifying the subnetwork is optional. If the network is in custom
9349 # subnet mode, specifying the subnetwork is required. If you specify this
9350 # field, you can specify the subnetwork as a full or partial URL. For
9351 # example, the following are all valid URLs:
9352 #
9353 #
9354 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
9355 # - regions/region/subnetworks/subnetwork
9356 &quot;vlan&quot;: 42, # VLAN tag of a dynamic network interface, must be an integer in the range
9357 # from 2 to 255 inclusively.
9358 },
9359 ],
9360 &quot;networkPerformanceConfig&quot;: {
9361 &quot;totalEgressBandwidthTier&quot;: &quot;A String&quot;,
9362 },
9363 &quot;params&quot;: { # Additional instance params. # Input only. [Input Only] Additional params passed with the request, but not persisted
9364 # as part of resource payload.
9365 &quot;requestValidForDuration&quot;: { # A Duration represents a fixed-length span of time represented # Relative deadline for waiting for capacity. Relevant only for
9366 # Instances.Insert API.
9367 # as a count of seconds and fractions of seconds at nanosecond
9368 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
9369 # or &quot;month&quot;. Range is approximately 10,000 years.
9370 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
9371 # Durations less than one second are represented with a 0
9372 # `seconds` field and a positive `nanos` field. Must be from 0
9373 # to 999,999,999 inclusive.
9374 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
9375 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
9376 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
9377 },
9378 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the instance. Tag keys and values
9379 # have the same definition as resource
9380 # manager tags. Keys and values can be either in numeric format,
9381 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
9382 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
9383 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
9384 # PATCH) when empty.
9385 &quot;a_key&quot;: &quot;A String&quot;,
9386 },
9387 },
9388 &quot;privateIpv6GoogleAccess&quot;: &quot;A String&quot;, # The private IPv6 google access type for the VM.
9389 # If not specified, use INHERIT_FROM_SUBNETWORK as default.
9390 &quot;reservationAffinity&quot;: { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.
9391 &quot;consumeReservationType&quot;: &quot;A String&quot;, # Specifies the type of reservation from which this instance can consume
9392 # resources: ANY_RESERVATION (default),SPECIFIC_RESERVATION, or NO_RESERVATION. See
9393 # Consuming reserved instances for examples.
9394 &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
9395 # the name of your reservation as its value.
9396 &quot;values&quot;: [ # Corresponds to the label values of a reservation resource. This can be
9397 # either a name to a reservation in the same project or
9398 # &quot;projects/different-project/reservations/some-reservation-name&quot; to target a
9399 # shared reservation in the same zone but in a different project.
9400 &quot;A String&quot;,
9401 ],
9402 },
9403 &quot;resourcePolicies&quot;: [ # Resource policies applied to this instance.
9404 &quot;A String&quot;,
9405 ],
9406 &quot;resourceStatus&quot;: { # Contains output only fields. # Output only. [Output Only] Specifies values set for instance attributes as
9407 # compared to the values requested by user in the corresponding input only
9408 # field.
9409 # Use this sub-message for actual values set on Instance attributes as compared
9410 # to the value requested by the user (intent) in their instance CRUD calls.
9411 &quot;effectiveInstanceMetadata&quot;: { # Effective values of predefined metadata keys for an instance. # Output only. [Output Only] Effective metadata is a field that consolidates project,
9412 # zonal instance settings, and instance-level predefined metadata keys to
9413 # provide the overridden value for those metadata keys at the instance level.
9414 &quot;blockProjectSshKeysMetadataValue&quot;: True or False, # Effective block-project-ssh-keys value at Instance level.
9415 &quot;enableGuestAttributesMetadataValue&quot;: True or False, # Effective enable-guest-attributes value at Instance level.
9416 &quot;enableOsInventoryMetadataValue&quot;: True or False, # Effective enable-os-inventory value at Instance level.
9417 &quot;enableOsconfigMetadataValue&quot;: True or False, # Effective enable-osconfig value at Instance level.
9418 &quot;enableOsloginMetadataValue&quot;: True or False, # Effective enable-oslogin value at Instance level.
9419 &quot;gceContainerDeclarationMetadataValue&quot;: True or False, # Effective gce-container-declaration value at Instance level.
9420 &quot;serialPortEnableMetadataValue&quot;: True or False, # Effective serial-port-enable value at Instance level.
9421 &quot;serialPortLoggingEnableMetadataValue&quot;: True or False, # Effective serial-port-logging-enable value at Instance level.
9422 &quot;vmDnsSettingMetadataValue&quot;: &quot;A String&quot;, # Effective VM DNS setting at Instance level.
9423 },
9424 &quot;physicalHost&quot;: &quot;A String&quot;, # Output only. [Output Only] The precise location of your instance within the zone&#x27;s data
9425 # center, including the block, sub-block, and host. The field is formatted as
9426 # follows: blockId/subBlockId/hostId.
9427 &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
9428 # Engine cluster, as well as the ID of the block, sub-block, and host on
9429 # which the running instance is located.
9430 # running.
9431 &quot;additionalAttributes&quot;: { # Additional location information of the running instance. # Output only. [Output Only] Additional location information of the running instance.
9432 &quot;acceleratorTopologyIds&quot;: { # Output only. The IDs of the accelerator topologies the instance belongs to. For
9433 # example
9434 # The key will be topologies like &quot;4x4&quot;, &quot;2x2x2&quot; and the value will be
9435 # the location ID of the topologies.
9436 &quot;a_key&quot;: &quot;A String&quot;,
9437 },
9438 },
9439 &quot;block&quot;: &quot;A String&quot;, # [Output Only] The ID of the block in which the running instance is
9440 # located. Instances within the same block experience low network latency.
9441 &quot;cluster&quot;: &quot;A String&quot;, # [Output Only] The global name of the Compute Engine cluster where the
9442 # running instance is located.
9443 &quot;host&quot;: &quot;A String&quot;, # [Output Only] The ID of the host on which the running instance is located.
9444 # Instances on the same host experience the lowest possible network
9445 # latency.
9446 &quot;subblock&quot;: &quot;A String&quot;, # [Output Only] The ID of the sub-block in which the running instance is
9447 # located. Instances in the same sub-block experience lower network latency
9448 # than instances in the same block.
9449 },
9450 &quot;reservationConsumptionInfo&quot;: { # Reservation consumption information that the instance is consuming from. # Output only. [Output Only] Reservation information that the instance is consuming from.
9451 &quot;consumedReservation&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the reservation that this
9452 # instance is consuming from.
9453 },
9454 &quot;scheduling&quot;: {
9455 &quot;availabilityDomain&quot;: 42, # Specifies the availability domain to place the instance in. The value
9456 # must be a number between 1 and the number of availability domains
9457 # specified in the spread placement policy attached to the instance.
9458 },
9459 &quot;upcomingMaintenance&quot;: { # Upcoming Maintenance notification information.
9460 &quot;canReschedule&quot;: True or False, # Indicates if the maintenance can be customer triggered.
9461 &quot;latestWindowStartTime&quot;: &quot;A String&quot;, # The latest time for the planned maintenance window to start.
9462 # This timestamp value is in RFC3339 text format.
9463 &quot;maintenanceOnShutdown&quot;: True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown.
9464 &quot;maintenanceReasons&quot;: [ # The reasons for the maintenance. Only valid for vms.
9465 &quot;A String&quot;,
9466 ],
9467 &quot;maintenanceStatus&quot;: &quot;A String&quot;,
9468 &quot;type&quot;: &quot;A String&quot;, # Defines the type of maintenance.
9469 &quot;windowEndTime&quot;: &quot;A String&quot;, # The time by which the maintenance disruption will be completed.
9470 # This timestamp value is in RFC3339 text format.
9471 &quot;windowStartTime&quot;: &quot;A String&quot;, # The current start time of the maintenance window.
9472 # This timestamp value is in RFC3339 text format.
9473 },
9474 },
9475 &quot;satisfiesPzi&quot;: True or False, # Output only. [Output Only] Reserved for future use.
9476 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
9477 &quot;scheduling&quot;: { # Sets the scheduling options for an Instance. # Sets the scheduling options for this instance.
9478 &quot;automaticRestart&quot;: True or False, # Specifies whether the instance should be automatically restarted if it is
9479 # terminated by Compute Engine (not terminated by a user). You can only set
9480 # the automatic restart option for standard instances.Preemptible instances
9481 # cannot be automatically restarted.
9482 #
9483 # By default, this is set to true so an instance is
9484 # automatically restarted if it is terminated by Compute Engine.
9485 &quot;availabilityDomain&quot;: 42, # Specifies the availability domain to place the instance in. The value
9486 # must be a number between 1 and the number of availability domains
9487 # specified in the spread placement policy attached to the instance.
9488 &quot;hostErrorTimeoutSeconds&quot;: 42, # Specify the time in seconds for host error detection, the value must be
9489 # within the range of [90, 330] with the increment of 30, if unset, the
9490 # default behavior of host error recovery will be used.
9491 &quot;instanceTerminationAction&quot;: &quot;A String&quot;, # Specifies the termination action for the instance.
9492 &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
9493 # recovery of the Local Ssd state is attempted. Its value should be in
9494 # between 0 and 168 hours with hour granularity and the default value being 1
9495 # hour.
9496 # as a count of seconds and fractions of seconds at nanosecond
9497 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
9498 # or &quot;month&quot;. Range is approximately 10,000 years.
9499 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
9500 # Durations less than one second are represented with a 0
9501 # `seconds` field and a positive `nanos` field. Must be from 0
9502 # to 999,999,999 inclusive.
9503 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
9504 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
9505 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
9506 },
9507 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the instance close to other
9508 # resources.
9509 # This field is for use by internal tools that use the public API.
9510 &quot;maxRunDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the max run duration for the given instance. If specified,
9511 # the instance termination action will be performed at the end of the run
9512 # duration.
9513 # as a count of seconds and fractions of seconds at nanosecond
9514 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
9515 # or &quot;month&quot;. Range is approximately 10,000 years.
9516 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
9517 # Durations less than one second are represented with a 0
9518 # `seconds` field and a positive `nanos` field. Must be from 0
9519 # to 999,999,999 inclusive.
9520 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
9521 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
9522 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
9523 },
9524 &quot;minNodeCpus&quot;: 42, # The minimum number of virtual CPUs this instance will consume when running
9525 # on a sole-tenant node.
9526 &quot;nodeAffinities&quot;: [ # A set of node affinity and anti-affinity configurations. Refer toConfiguring node
9527 # affinity for more information.
9528 # Overrides reservationAffinity.
9529 { # Node Affinity: the configuration of desired nodes onto which this Instance
9530 # could be scheduled.
9531 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of Node resource.
9532 &quot;operator&quot;: &quot;A String&quot;, # Defines the operation of node selection. Valid operators areIN for affinity and NOT_IN for anti-affinity.
9533 &quot;values&quot;: [ # Corresponds to the label values of Node resource.
9534 &quot;A String&quot;,
9535 ],
9536 },
9537 ],
9538 &quot;onHostMaintenance&quot;: &quot;A String&quot;, # Defines the maintenance behavior for this instance. For standard instances,
9539 # the default behavior is MIGRATE. Forpreemptible instances,
9540 # the default and only possible behavior is TERMINATE. For more
9541 # information, see
9542 # Set
9543 # VM host maintenance policy.
9544 &quot;onInstanceStopAction&quot;: { # Defines the behaviour for instances with the instance_termination_actionSTOP.
9545 &quot;discardLocalSsd&quot;: True or False, # If true, the contents of any attached Local SSD disks will be discarded
9546 # else, the Local SSD data will be preserved when the instance is stopped
9547 # at the end of the run duration/termination time.
9548 },
9549 &quot;preemptible&quot;: True or False, # Defines whether the instance is preemptible. This can only be set during
9550 # instance creation or while the instance isstopped and
9551 # therefore, in a `TERMINATED` state. SeeInstance Life
9552 # Cycle for more information on the possible instance states.
9553 &quot;provisioningModel&quot;: &quot;A String&quot;, # Specifies the provisioning model of the instance.
9554 &quot;skipGuestOsShutdown&quot;: True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
9555 # Off and ACPI G3 Mechanical
9556 # Off for Standard VMs and 30 seconds for Spot VMs.
9557 &quot;terminationTime&quot;: &quot;A String&quot;, # Specifies the timestamp, when the instance will be terminated, inRFC3339 text format. If specified, the instance
9558 # termination action will be performed at the termination time.
9559 },
9560 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
9561 &quot;serviceAccounts&quot;: [ # A list of service accounts, with their specified scopes, authorized for
9562 # this instance. Only one service account per VM instance is supported.
9563 #
9564 # Service accounts generate access tokens that can be accessed
9565 # through the metadata server and used to authenticate applications on the
9566 # instance. SeeService Accounts
9567 # for more information.
9568 { # A service account.
9569 &quot;email&quot;: &quot;A String&quot;, # Email address of the service account.
9570 &quot;scopes&quot;: [ # The list of scopes to be made available for this service account.
9571 &quot;A String&quot;,
9572 ],
9573 },
9574 ],
9575 &quot;shieldedInstanceConfig&quot;: { # A set of Shielded Instance options.
9576 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.Enabled by
9577 # default.
9578 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.Disabled by
9579 # default.
9580 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.Enabled by
9581 # default.
9582 },
9583 &quot;shieldedInstanceIntegrityPolicy&quot;: { # The policy describes the baseline against which
9584 # Instance boot integrity is measured.
9585 &quot;updateAutoLearnPolicy&quot;: True or False, # Updates the integrity policy baseline using the
9586 # measurements from the VM instance&#x27;s most recent boot.
9587 },
9588 &quot;sourceMachineImage&quot;: &quot;A String&quot;, # Source machine image
9589 &quot;sourceMachineImageEncryptionKey&quot;: { # Source machine image encryption key when creating an instance from a
9590 # machine image.
9591 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
9592 # For example:
9593 #
9594 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
9595 # key_region/cryptoKeys/key
9596 #
9597 # The fully-qualifed key name may be returned for resource GET requests. For
9598 # example:
9599 #
9600 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
9601 # key_region/cryptoKeys/key
9602 # /cryptoKeyVersions/1
9603 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
9604 # key. If absent, the Compute Engine default service account is used.
9605 # For example:
9606 #
9607 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
9608 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
9609 # encryption key, encoded in RFC
9610 # 4648 base64 to either encrypt or decrypt this resource. You can
9611 # provide either the rawKey or thersaEncryptedKey.
9612 # For example:
9613 #
9614 # &quot;rawKey&quot;:
9615 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
9616 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
9617 # customer-supplied encryption key to either encrypt or decrypt this
9618 # resource. You can provide either the rawKey or thersaEncryptedKey.
9619 # For example:
9620 #
9621 # &quot;rsaEncryptedKey&quot;:
9622 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
9623 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
9624 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
9625 #
9626 # The key must meet the following requirements before you can provide it to
9627 # Compute Engine:
9628 #
9629 # 1. The key is wrapped using a RSA public key certificate provided by
9630 # Google.
9631 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
9632 # encoding.
9633 #
9634 # Gets the RSA public key certificate provided by Google at:
9635 #
9636 #
9637 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
9638 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
9639 # 4648 base64 encoded SHA-256 hash of the customer-supplied
9640 # encryption key that protects this resource.
9641 },
9642 &quot;startRestricted&quot;: True or False, # Output only. [Output Only] Whether a VM has been restricted for start because Compute
9643 # Engine has detected suspicious activity.
9644 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the instance. One of the
9645 # following values: PROVISIONING, STAGING,RUNNING, STOPPING, SUSPENDING,SUSPENDED, REPAIRING, andTERMINATED. For more information about the status of the
9646 # instance, see
9647 # Instance life cycle.
9648 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. [Output Only] An optional, human-readable explanation of the status.
9649 &quot;tags&quot;: { # A set of instance tags. # Tags to apply to this instance. Tags are used to identify valid
9650 # sources or targets for network firewalls and are specified by the client
9651 # during instance creation. The tags can be later modified by the setTags
9652 # method. Each tag within the list must comply withRFC1035.
9653 # Multiple tags can be specified via the &#x27;tags.items&#x27; field.
9654 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
9655 # the tags&#x27; contents and used for optimistic locking. The
9656 # fingerprint is initially generated by Compute Engine and changes after
9657 # every request to modify or update tags. You must always provide an
9658 # up-to-date fingerprint hash in order to update or change tags.
9659 #
9660 # To see the latest fingerprint, make get() request to the
9661 # instance.
9662 &quot;items&quot;: [ # An array of tags. Each tag must be 1-63 characters long, and comply
9663 # with RFC1035.
9664 &quot;A String&quot;,
9665 ],
9666 },
9667 &quot;workloadIdentityConfig&quot;: {
9668 &quot;identity&quot;: &quot;A String&quot;,
9669 &quot;identityCertificateEnabled&quot;: True or False,
9670 },
9671 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the zone where the instance resides.
9672 # You must specify this field as part of the HTTP request URL. It is
9673 # not settable as a field in the request body.
9674 }
9675
9676 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
9677 that if you must retry your request, the server will know to ignore the
9678 request if it has already been completed.
9679
9680 For example, consider a situation where you make an initial request and
9681 the request times out. If you make the request again with the same
9682 request ID, the server can check if original operation with the same
9683 request ID was received, and if so, will ignore the second request. This
9684 prevents clients from accidentally creating duplicate commitments.
9685
9686 The request ID must be
9687 a valid UUID with the exception that zero UUID is not supported
9688 (00000000-0000-0000-0000-000000000000).
9689 sourceInstanceTemplate: string, Specifies instance template to create the instance.
9690
9691 This field is optional. It can be a full or partial URL. For example, the
9692 following are all valid URLs to an instance template:
9693
9694
9695 - https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate
9696 - projects/project/global/instanceTemplates/instanceTemplate
9697 - global/instanceTemplates/instanceTemplate
9698 sourceMachineImage: string, Specifies the machine image to use to create the instance.
9699
9700 This field is optional. It can be a full or partial URL. For example, the
9701 following are all valid URLs to a machine image:
9702
9703
9704 - https://www.googleapis.com/compute/v1/projects/project/global/global/machineImages/machineImage
9705 - projects/project/global/global/machineImages/machineImage
9706 - global/machineImages/machineImage
9707 x__xgafv: string, V1 error format.
9708 Allowed values
9709 1 - v1 error format
9710 2 - v2 error format
9711
9712 Returns:
9713 An object of the form:
9714
9715 { # Represents an Operation resource.
9716 #
9717 # Google Compute Engine has three Operation resources:
9718 #
9719 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
9720 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
9721 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
9722 #
9723 # You can use an operation resource to manage asynchronous API requests.
9724 # For more information, readHandling
9725 # API responses.
9726 #
9727 # Operations can be global, regional or zonal.
9728 #
9729 # - For global operations, use the `globalOperations`
9730 # resource.
9731 # - For regional operations, use the
9732 # `regionOperations` resource.
9733 # - For zonal operations, use
9734 # the `zoneOperations` resource.
9735 #
9736 #
9737 #
9738 # For more information, read
9739 # Global, Regional, and Zonal Resources.
9740 #
9741 # Note that completed Operation resources have a limited
9742 # retention period.
9743 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
9744 # Not present otherwise.
9745 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
9746 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
9747 # set when the operation is created.
9748 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
9749 # text format.
9750 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
9751 # this field will be populated.
9752 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
9753 # operation.
9754 {
9755 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
9756 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
9757 # details. There is a set of defined message types to use for providing
9758 # details.The syntax depends on the error code. For example,
9759 # QuotaExceededInfo will have details when the error code is
9760 # QUOTA_EXCEEDED.
9761 {
9762 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
9763 #
9764 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
9765 # is not enabled:
9766 #
9767 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
9768 # &quot;domain&quot;: &quot;googleapis.com&quot;
9769 # &quot;metadata&quot;: {
9770 # &quot;resource&quot;: &quot;projects/123&quot;,
9771 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
9772 # }
9773 # }
9774 #
9775 # This response indicates that the pubsub.googleapis.com API is not enabled.
9776 #
9777 # Example of an error that is returned when attempting to create a Spanner
9778 # instance in a region that is out of stock:
9779 #
9780 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
9781 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
9782 # &quot;metadata&quot;: {
9783 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
9784 # }
9785 # }
9786 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
9787 # is typically the registered service name of the tool or product that
9788 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
9789 # generated by some common infrastructure, the error domain must be a
9790 # globally unique value that identifies the infrastructure. For Google API
9791 # infrastructure, the error domain is &quot;googleapis.com&quot;.
9792 &quot;metadatas&quot;: { # Additional structured details about this error.
9793 #
9794 # Keys must match a regular expression of `a-z+` but should
9795 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
9796 # length. When identifying the current value of an exceeded limit, the units
9797 # should be contained in the key, not the value. For example, rather than
9798 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
9799 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
9800 # instances that can be created in a single (batch) request.
9801 &quot;a_key&quot;: &quot;A String&quot;,
9802 },
9803 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
9804 # proximate cause of the error. Error reasons are unique within a particular
9805 # domain of errors. This should be at most 63 characters and match a
9806 # regular expression of `A-Z+[A-Z0-9]`, which represents
9807 # UPPER_SNAKE_CASE.
9808 },
9809 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
9810 #
9811 # For example, if a quota check failed with an error indicating the calling
9812 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
9813 # directly to the right place in the developer console to flip the bit.
9814 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
9815 { # Describes a URL link.
9816 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
9817 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
9818 },
9819 ],
9820 },
9821 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
9822 # which can be attached to an RPC error.
9823 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
9824 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
9825 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
9826 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
9827 },
9828 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
9829 &quot;dimensions&quot;: { # The map holding related quota dimensions.
9830 &quot;a_key&quot;: &quot;A String&quot;,
9831 },
9832 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
9833 # type or metric.
9834 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
9835 # or metric.
9836 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
9837 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
9838 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
9839 },
9840 },
9841 ],
9842 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
9843 # This property is optional.
9844 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
9845 },
9846 ],
9847 },
9848 &quot;getVersionOperationMetadata&quot;: {
9849 &quot;inlineSbomInfo&quot;: {
9850 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
9851 # appropriate identifiers.
9852 &quot;a_key&quot;: &quot;A String&quot;,
9853 },
9854 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
9855 # identifiers.
9856 &quot;a_key&quot;: &quot;A String&quot;,
9857 },
9858 },
9859 },
9860 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
9861 # message that was returned, such as `NOT FOUND`.
9862 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
9863 # status code that was returned. For example, a `404` means the
9864 # resource was not found.
9865 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
9866 # defined by the server.
9867 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
9868 # This value is inRFC3339
9869 # text format.
9870 &quot;instancesBulkInsertOperationMetadata&quot;: {
9871 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
9872 # Example key: zones/us-central1-a
9873 &quot;a_key&quot;: {
9874 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
9875 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
9876 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
9877 # error.
9878 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
9879 # if the flow is rolling forward or rolling back.
9880 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
9881 },
9882 },
9883 },
9884 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
9885 # Operation resources.
9886 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
9887 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
9888 # group of operations results from a `bulkInsert` API request.
9889 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
9890 # `update`, or `delete`, and so on.
9891 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
9892 # There is no requirement that this be linear or support any granularity of
9893 # operations. This should not be used to guess when the operation will be
9894 # complete. This number should monotonically increase as the operation
9895 # progresses.
9896 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
9897 # applicable when performing regional operations.
9898 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
9899 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
9900 # this field will contain information on all underlying zonal actions and
9901 # their state.
9902 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
9903 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
9904 # Example key: zones/us-central1-a
9905 &quot;a_key&quot;: {
9906 &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
9907 # populated.
9908 # different programming environments, including REST APIs and RPC APIs. It is
9909 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
9910 # three pieces of data: error code, error message, and error details.
9911 #
9912 # You can find out more about this error model and how to work with it in the
9913 # [API Design Guide](https://cloud.google.com/apis/design/errors).
9914 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
9915 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
9916 # message types for APIs to use.
9917 {
9918 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
9919 },
9920 ],
9921 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
9922 # user-facing error message should be localized and sent in the
9923 # google.rpc.Status.details field, or localized by the client.
9924 },
9925 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
9926 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
9927 },
9928 },
9929 },
9930 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
9931 # This value is inRFC3339
9932 # text format.
9933 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
9934 # following:
9935 # `PENDING`, `RUNNING`, or `DONE`.
9936 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
9937 # operation.
9938 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
9939 # of the target resource.
9940 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
9941 # operations related to creating a snapshot, this points to the disk
9942 # that the snapshot was created from.
9943 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
9944 # `[email protected]` or
9945 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
9946 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
9947 # operation, this field will be populated.
9948 {
9949 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
9950 # Engine returns NO_RESULTS_ON_PAGE if there
9951 # are no results in the response.
9952 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
9953 # value format. For example:
9954 #
9955 # &quot;data&quot;: [
9956 # {
9957 # &quot;key&quot;: &quot;scope&quot;,
9958 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
9959 # }
9960 {
9961 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
9962 # returned. For example, for warnings where there are no results in a list
9963 # request for a particular zone, this key might be scope and
9964 # the key value might be the zone name. Other examples might be a key
9965 # indicating a deprecated resource and a suggested replacement, or a
9966 # warning about invalid network settings (for example, if an instance
9967 # attempts to perform IP forwarding but is not enabled for IP forwarding).
9968 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
9969 },
9970 ],
9971 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
9972 },
9973 ],
9974 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
9975 # applicable when performing per-zone operations.
9976 }</pre>
9977 </div>
9978
9979 <div class="method">
9980 <code class="details" id="list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
9981 <pre>Retrieves the list of instances contained within
9982 the specified zone.
9983
9984 Args:
9985 project: string, Project ID for this request. (required)
9986 zone: string, The name of the zone for this request. (required)
9987 filter: string, A filter expression that filters resources listed in the response. Most
9988 Compute resources support two types of filter expressions:
9989 expressions that support regular expressions and expressions that follow
9990 API improvement proposal AIP-160.
9991 These two types of filter expressions cannot be mixed in one request.
9992
9993 If you want to use AIP-160, your expression must specify the field name, an
9994 operator, and the value that you want to use for filtering. The value
9995 must be a string, a number, or a boolean. The operator
9996 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
9997
9998 For example, if you are filtering Compute Engine instances, you can
9999 exclude instances named `example-instance` by specifying
10000 `name != example-instance`.
10001
10002 The `:*` comparison can be used to test whether a key has been defined.
10003 For example, to find all objects with `owner` label use:
10004 ```
10005 labels.owner:*
10006 ```
10007
10008 You can also filter nested fields. For example, you could specify
10009 `scheduling.automaticRestart = false` to include instances only
10010 if they are not scheduled for automatic restarts. You can use filtering
10011 on nested fields to filter based onresource labels.
10012
10013 To filter on multiple expressions, provide each separate expression within
10014 parentheses. For example:
10015 ```
10016 (scheduling.automaticRestart = true)
10017 (cpuPlatform = &quot;Intel Skylake&quot;)
10018 ```
10019 By default, each expression is an `AND` expression. However, you
10020 can include `AND` and `OR` expressions explicitly.
10021 For example:
10022 ```
10023 (cpuPlatform = &quot;Intel Skylake&quot;) OR
10024 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
10025 (scheduling.automaticRestart = true)
10026 ```
10027
10028 If you want to use a regular expression, use the `eq` (equal) or `ne`
10029 (not equal) operator against a single un-parenthesized expression with or
10030 without quotes or against multiple parenthesized expressions. Examples:
10031
10032 `fieldname eq unquoted literal`
10033 `fieldname eq &#x27;single quoted literal&#x27;`
10034 `fieldname eq &quot;double quoted literal&quot;`
10035 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
10036
10037 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
10038 The literal value must match the entire field.
10039
10040 For example, to filter for instances that do not end with name &quot;instance&quot;,
10041 you would use `name ne .*instance`.
10042
10043 You cannot combine constraints on multiple fields using regular
10044 expressions.
10045 maxResults: integer, The maximum number of results per page that should be returned.
10046 If the number of available results is larger than `maxResults`,
10047 Compute Engine returns a `nextPageToken` that can be used to get
10048 the next page of results in subsequent list requests. Acceptable values are
10049 `0` to `500`, inclusive. (Default: `500`)
10050 orderBy: string, Sorts list results by a certain order. By default, results
10051 are returned in alphanumerical order based on the resource name.
10052
10053 You can also sort results in descending order based on the creation
10054 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
10055 results based on the `creationTimestamp` field in
10056 reverse chronological order (newest result first). Use this to sort
10057 resources like operations so that the newest operation is returned first.
10058
10059 Currently, only sorting by `name` or
10060 `creationTimestamp desc` is supported.
10061 pageToken: string, Specifies a page token to use. Set `pageToken` to the
10062 `nextPageToken` returned by a previous list request to get
10063 the next page of results.
10064 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
10065 of failure. The default value is false.
10066
10067 For example, when partial success behavior is enabled, aggregatedList for a
10068 single zone scope either returns all resources in the zone or no resources,
10069 with an error code.
10070 x__xgafv: string, V1 error format.
10071 Allowed values
10072 1 - v1 error format
10073 2 - v2 error format
10074
10075 Returns:
10076 An object of the form:
10077
10078 { # Contains a list of instances.
10079 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
10080 &quot;items&quot;: [ # A list of Instance resources.
10081 { # Represents an Instance resource.
10082 #
10083 # An instance is a virtual machine that is hosted on Google Cloud Platform.
10084 # For more information, readVirtual Machine Instances.
10085 &quot;advancedMachineFeatures&quot;: { # Specifies options for controlling advanced machine features. # Controls for advanced machine-related behavior features.
10086 # Options that would traditionally be configured in a BIOS belong
10087 # here. Features that require operating system support may have
10088 # corresponding entries in the GuestOsFeatures of anImage (e.g., whether or not the OS in theImage supports nested virtualization being enabled or
10089 # disabled).
10090 &quot;enableNestedVirtualization&quot;: True or False, # Whether to enable nested virtualization or not (default is false).
10091 &quot;enableUefiNetworking&quot;: True or False, # Whether to enable UEFI networking for instance creation.
10092 &quot;performanceMonitoringUnit&quot;: &quot;A String&quot;, # Type of Performance Monitoring Unit requested on instance.
10093 &quot;threadsPerCore&quot;: 42, # The number of threads per physical core. To disable simultaneous
10094 # multithreading (SMT) set this to 1. If unset, the maximum number
10095 # of threads supported per core by the underlying processor is
10096 # assumed.
10097 &quot;turboMode&quot;: &quot;A String&quot;, # Turbo frequency mode to use for the instance.
10098 # Supported modes include:
10099 # * ALL_CORE_MAX
10100 #
10101 # Using empty string or not setting this field will use the platform-specific
10102 # default turbo mode.
10103 &quot;visibleCoreCount&quot;: 42, # The number of physical cores to expose to an instance. Multiply by
10104 # the number of threads per core to compute the total number of virtual
10105 # CPUs to expose to the instance. If unset, the number of cores is
10106 # inferred from the instance&#x27;s nominal CPU count and the underlying
10107 # platform&#x27;s SMT width.
10108 },
10109 &quot;canIpForward&quot;: True or False, # Allows this instance to send and receive packets with non-matching
10110 # destination or source IPs. This is required if you plan to use this
10111 # instance to forward routes. For more information, seeEnabling IP Forwarding.
10112 &quot;confidentialInstanceConfig&quot;: { # A set of Confidential Instance options.
10113 &quot;confidentialInstanceType&quot;: &quot;A String&quot;, # Defines the type of technology used by the confidential instance.
10114 &quot;enableConfidentialCompute&quot;: True or False, # Defines whether the instance should have confidential compute enabled.
10115 },
10116 &quot;cpuPlatform&quot;: &quot;A String&quot;, # Output only. [Output Only] The CPU platform used by this instance.
10117 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339 text format.
10118 &quot;deletionProtection&quot;: True or False, # Whether the resource should be protected against deletion.
10119 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
10120 # create the resource.
10121 &quot;disks&quot;: [ # Array of disks associated with this instance. Persistent disks must be
10122 # created before you can assign them.
10123 { # An instance-attached disk resource.
10124 &quot;architecture&quot;: &quot;A String&quot;, # Output only. [Output Only] The architecture of the attached disk. Valid values are ARM64
10125 # or X86_64.
10126 &quot;autoDelete&quot;: True or False, # Specifies whether the disk will be auto-deleted when the instance is
10127 # deleted (but not when the disk is detached from the instance).
10128 &quot;boot&quot;: True or False, # Indicates that this is a boot disk. The virtual machine will use the first
10129 # partition of the disk for its root filesystem.
10130 &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
10131 # running within the instance. This name can be used to reference the device
10132 # for mounting, resizing, and so on, from within the instance.
10133 #
10134 # If not specified, the server chooses a default device name to apply to this
10135 # disk, in the form persistent-disk-x, where x is a number
10136 # assigned by Google Compute Engine. This field is only applicable for
10137 # persistent disks.
10138 &quot;diskEncryptionKey&quot;: { # Encrypts or decrypts a disk using acustomer-supplied
10139 # encryption key.
10140 #
10141 # If you are creating a new disk, this field encrypts the new disk using
10142 # an encryption key that you provide. If you are attaching an existing
10143 # disk that is already encrypted, this field decrypts the disk using
10144 # the customer-supplied encryption key.
10145 #
10146 # If you encrypt a disk using a customer-supplied key, you must provide the
10147 # same key again when you attempt to use this resource at a later time. For
10148 # example, you must provide the key when you create a snapshot or an image
10149 # from the disk or when you attach the disk to a virtual machine instance.
10150 #
10151 # If you do not provide an encryption key, then the disk will be encrypted
10152 # using an automatically generated key and you do not need to provide a key
10153 # to use the disk later.
10154 #
10155 # Note:
10156 #
10157 # Instance templates do not storecustomer-supplied
10158 # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
10159 #
10160 # You cannot create VMs that have disks with customer-supplied keys using
10161 # the bulk
10162 # insert method.
10163 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
10164 # For example:
10165 #
10166 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
10167 # key_region/cryptoKeys/key
10168 #
10169 # The fully-qualifed key name may be returned for resource GET requests. For
10170 # example:
10171 #
10172 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
10173 # key_region/cryptoKeys/key
10174 # /cryptoKeyVersions/1
10175 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
10176 # key. If absent, the Compute Engine default service account is used.
10177 # For example:
10178 #
10179 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
10180 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
10181 # encryption key, encoded in RFC
10182 # 4648 base64 to either encrypt or decrypt this resource. You can
10183 # provide either the rawKey or thersaEncryptedKey.
10184 # For example:
10185 #
10186 # &quot;rawKey&quot;:
10187 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
10188 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
10189 # customer-supplied encryption key to either encrypt or decrypt this
10190 # resource. You can provide either the rawKey or thersaEncryptedKey.
10191 # For example:
10192 #
10193 # &quot;rsaEncryptedKey&quot;:
10194 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
10195 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
10196 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
10197 #
10198 # The key must meet the following requirements before you can provide it to
10199 # Compute Engine:
10200 #
10201 # 1. The key is wrapped using a RSA public key certificate provided by
10202 # Google.
10203 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
10204 # encoding.
10205 #
10206 # Gets the RSA public key certificate provided by Google at:
10207 #
10208 #
10209 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
10210 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
10211 # 4648 base64 encoded SHA-256 hash of the customer-supplied
10212 # encryption key that protects this resource.
10213 },
10214 &quot;diskSizeGb&quot;: &quot;A String&quot;, # The size of the disk in GB.
10215 &quot;forceAttach&quot;: True or False, # [Input Only] Whether to force attach the regional disk even if it&#x27;s
10216 # currently attached to another instance. If you try to force attach a zonal
10217 # disk to an instance, you will receive an error.
10218 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
10219 # only for bootable images. Read
10220 # Enabling guest operating system features to see a list of available
10221 # options.
10222 { # Guest OS features.
10223 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
10224 # separate values. Set to one or more of the following values:
10225 #
10226 # - VIRTIO_SCSI_MULTIQUEUE
10227 # - WINDOWS
10228 # - MULTI_IP_SUBNET
10229 # - UEFI_COMPATIBLE
10230 # - GVNIC
10231 # - SEV_CAPABLE
10232 # - SUSPEND_RESUME_COMPATIBLE
10233 # - SEV_LIVE_MIGRATABLE_V2
10234 # - SEV_SNP_CAPABLE
10235 # - TDX_CAPABLE
10236 # - IDPF
10237 # - SNP_SVSM_CAPABLE
10238 # - CCA_CAPABLE
10239 #
10240 #
10241 # For more information, see
10242 # Enabling guest operating system features.
10243 },
10244 ],
10245 &quot;index&quot;: 42, # Output only. [Output Only] A zero-based index to this disk, where 0 is reserved for the
10246 # boot disk. If you have many disks attached to an instance, each
10247 # disk would have a unique index number.
10248 &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
10249 # alongside the new instance. Use initialization parameters to create boot
10250 # disks or local SSDs attached to the new instance.
10251 #
10252 # This property is mutually exclusive with the source property;
10253 # you can only define one or the other, but not both.
10254 # alongside the new instance. Use initialization parameters to create boot
10255 # disks or local SSDs attached to the new instance.
10256 #
10257 # This field is persisted and returned for instanceTemplate and not returned
10258 # in the context of instance.
10259 #
10260 # This property is mutually exclusive with the source property;
10261 # you can only define one or the other, but not both.
10262 &quot;architecture&quot;: &quot;A String&quot;, # The architecture of the attached disk. Valid values are
10263 # arm64 or x86_64.
10264 &quot;description&quot;: &quot;A String&quot;, # An optional description. Provide this property when creating the disk.
10265 &quot;diskName&quot;: &quot;A String&quot;, # Specifies the disk name. If not specified, the default is to use the name
10266 # of the instance. If a disk with the same name already exists in the given
10267 # region, the existing disk is attached to the new instance and the
10268 # new disk is not created.
10269 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB. The size must be at least
10270 # 10 GB. If you specify a sourceImage, which is required for
10271 # boot disks, the default size is the size of the sourceImage.
10272 # If you do not specify a sourceImage, the default disk size
10273 # is 500 GB.
10274 &quot;diskType&quot;: &quot;A String&quot;,
10275 &quot;enableConfidentialCompute&quot;: True or False, # Whether this disk is using confidential compute mode.
10276 &quot;labels&quot;: { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
10277 # persistent disks.
10278 &quot;a_key&quot;: &quot;A String&quot;,
10279 },
10280 &quot;licenses&quot;: [ # A list of publicly visible licenses. Reserved for Google&#x27;s use.
10281 &quot;A String&quot;,
10282 ],
10283 &quot;onUpdateAction&quot;: &quot;A String&quot;, # Specifies which action to take on instance update with this disk. Default
10284 # is to use the existing disk.
10285 &quot;provisionedIops&quot;: &quot;A String&quot;, # Indicates how many IOPS to provision for the disk. This sets the number
10286 # of I/O operations per second that the disk can handle. Values must be
10287 # between 10,000 and 120,000. For more details, see theExtreme persistent
10288 # disk documentation.
10289 &quot;provisionedThroughput&quot;: &quot;A String&quot;, # Indicates how much throughput to provision for the disk. This sets the
10290 # number of throughput mb per second that the disk can handle. Values must
10291 # greater than or equal to 1.
10292 &quot;replicaZones&quot;: [ # Required for each regional disk associated with the instance. Specify
10293 # the URLs of the zones where the disk should be replicated to.
10294 # You must provide exactly two replica zones, and one zone must be the same
10295 # as the instance zone.
10296 &quot;A String&quot;,
10297 ],
10298 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
10299 # have the same definition as resource
10300 # manager tags. Keys and values can be either in numeric format,
10301 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
10302 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
10303 # `{tag_value_short_name}`. The field is ignored (both PUT &amp; PATCH) when
10304 # empty.
10305 &quot;a_key&quot;: &quot;A String&quot;,
10306 },
10307 &quot;resourcePolicies&quot;: [ # Resource policies applied to this disk for automatic snapshot creations.
10308 # Specified using the full or partial URL. For instance template, specify
10309 # only the resource policy name.
10310 &quot;A String&quot;,
10311 ],
10312 &quot;sourceImage&quot;: &quot;A String&quot;, # The source image to create this disk. When creating a new instance boot
10313 # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
10314 # is required.
10315 #
10316 # To create a disk with one of the public operating system
10317 # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
10318 #
10319 # projects/debian-cloud/global/images/family/debian-9
10320 #
10321 #
10322 # Alternatively, use a specific version of a public operating system image:
10323 #
10324 # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
10325 #
10326 #
10327 # To create a disk with a custom image that you created, specify the
10328 # image name in the following format:
10329 #
10330 # global/images/my-custom-image
10331 #
10332 #
10333 # You can also specify a custom image by its image family, which returns
10334 # the latest version of the image in that family. Replace the image name
10335 # with family/family-name:
10336 #
10337 # global/images/family/my-image-family
10338 #
10339 #
10340 # If the source image is deleted later, this field will not be set.
10341 &quot;sourceImageEncryptionKey&quot;: { # Thecustomer-supplied
10342 # encryption key of the source image. Required if the source image is
10343 # protected by a customer-supplied encryption key.
10344 #
10345 # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
10346 # encryption keys, so you cannot create disks for instances in a managed instance group if the
10347 # source images are encrypted with your own keys.
10348 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
10349 # For example:
10350 #
10351 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
10352 # key_region/cryptoKeys/key
10353 #
10354 # The fully-qualifed key name may be returned for resource GET requests. For
10355 # example:
10356 #
10357 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
10358 # key_region/cryptoKeys/key
10359 # /cryptoKeyVersions/1
10360 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
10361 # key. If absent, the Compute Engine default service account is used.
10362 # For example:
10363 #
10364 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
10365 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
10366 # encryption key, encoded in RFC
10367 # 4648 base64 to either encrypt or decrypt this resource. You can
10368 # provide either the rawKey or thersaEncryptedKey.
10369 # For example:
10370 #
10371 # &quot;rawKey&quot;:
10372 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
10373 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
10374 # customer-supplied encryption key to either encrypt or decrypt this
10375 # resource. You can provide either the rawKey or thersaEncryptedKey.
10376 # For example:
10377 #
10378 # &quot;rsaEncryptedKey&quot;:
10379 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
10380 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
10381 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
10382 #
10383 # The key must meet the following requirements before you can provide it to
10384 # Compute Engine:
10385 #
10386 # 1. The key is wrapped using a RSA public key certificate provided by
10387 # Google.
10388 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
10389 # encoding.
10390 #
10391 # Gets the RSA public key certificate provided by Google at:
10392 #
10393 #
10394 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
10395 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
10396 # 4648 base64 encoded SHA-256 hash of the customer-supplied
10397 # encryption key that protects this resource.
10398 },
10399 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # The source snapshot to create this disk. When creating a new instance
10400 # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
10401 # is required.
10402 #
10403 # To create a disk with a snapshot that you created, specify the
10404 # snapshot name in the following format:
10405 #
10406 # global/snapshots/my-backup
10407 #
10408 #
10409 # If the source snapshot is deleted later, this field will not be set.
10410 #
10411 # Note: You cannot create VMs in bulk using a snapshot as the source. Use
10412 # an image instead when you create VMs using
10413 # the bulk
10414 # insert method.
10415 &quot;sourceSnapshotEncryptionKey&quot;: { # Thecustomer-supplied
10416 # encryption key of the source snapshot.
10417 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
10418 # For example:
10419 #
10420 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
10421 # key_region/cryptoKeys/key
10422 #
10423 # The fully-qualifed key name may be returned for resource GET requests. For
10424 # example:
10425 #
10426 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
10427 # key_region/cryptoKeys/key
10428 # /cryptoKeyVersions/1
10429 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
10430 # key. If absent, the Compute Engine default service account is used.
10431 # For example:
10432 #
10433 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
10434 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
10435 # encryption key, encoded in RFC
10436 # 4648 base64 to either encrypt or decrypt this resource. You can
10437 # provide either the rawKey or thersaEncryptedKey.
10438 # For example:
10439 #
10440 # &quot;rawKey&quot;:
10441 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
10442 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
10443 # customer-supplied encryption key to either encrypt or decrypt this
10444 # resource. You can provide either the rawKey or thersaEncryptedKey.
10445 # For example:
10446 #
10447 # &quot;rsaEncryptedKey&quot;:
10448 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
10449 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
10450 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
10451 #
10452 # The key must meet the following requirements before you can provide it to
10453 # Compute Engine:
10454 #
10455 # 1. The key is wrapped using a RSA public key certificate provided by
10456 # Google.
10457 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
10458 # encoding.
10459 #
10460 # Gets the RSA public key certificate provided by Google at:
10461 #
10462 #
10463 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
10464 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
10465 # 4648 base64 encoded SHA-256 hash of the customer-supplied
10466 # encryption key that protects this resource.
10467 },
10468 &quot;storagePool&quot;: &quot;A String&quot;, # The storage pool in which the new disk is created. You can provide
10469 # this as a partial or full URL to the resource. For example, the following
10470 # are valid values:
10471 #
10472 #
10473 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
10474 # - projects/project/zones/zone/storagePools/storagePool
10475 # - zones/zone/storagePools/storagePool
10476 },
10477 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is
10478 # either SCSI or NVME. For most machine types, the
10479 # default is SCSI. Local SSDs can use either NVME or SCSI.
10480 # In certain configurations, persistent disks can use NVMe. For more
10481 # information, seeAbout
10482 # persistent disks.
10483 &quot;kind&quot;: &quot;compute#attachedDisk&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
10484 &quot;licenses&quot;: [ # Output only. [Output Only] Any valid publicly visible licenses.
10485 &quot;A String&quot;,
10486 ],
10487 &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
10488 # in READ_WRITE mode.
10489 &quot;savedState&quot;: &quot;A String&quot;, # Output only. For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
10490 # field is set to PRESERVED if the LocalSSD data has been saved
10491 # to a persistent location by customer request. (see the
10492 # discard_local_ssd option on Stop/Suspend).
10493 # Read-only in the api.
10494 &quot;shieldedInstanceInitialState&quot;: { # Initial State for shielded instance, # Output only. [Output Only] shielded vm initial state stored on disk
10495 # these are public keys which are safe to store in public
10496 &quot;dbs&quot;: [ # The Key Database (db).
10497 {
10498 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
10499 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
10500 },
10501 ],
10502 &quot;dbxs&quot;: [ # The forbidden key database (dbx).
10503 {
10504 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
10505 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
10506 },
10507 ],
10508 &quot;keks&quot;: [ # The Key Exchange Key (KEK).
10509 {
10510 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
10511 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
10512 },
10513 ],
10514 &quot;pk&quot;: { # The Platform Key (PK).
10515 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
10516 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
10517 },
10518 },
10519 &quot;source&quot;: &quot;A String&quot;, # Specifies a valid partial or full URL to an existing Persistent Disk
10520 # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
10521 # is required.
10522 #
10523 # If desired, you can also attach existing non-root persistent disks using
10524 # this property. This field is only applicable for persistent disks.
10525 #
10526 # Note that for InstanceTemplate, specify the disk name for zonal disk,
10527 # and the URL for regional disk.
10528 &quot;type&quot;: &quot;A String&quot;, # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
10529 },
10530 ],
10531 &quot;displayDevice&quot;: { # A set of Display Device options # Enables display device for the instance.
10532 &quot;enableDisplay&quot;: True or False, # Defines whether the instance has Display enabled.
10533 },
10534 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this resource, which is essentially a hash of
10535 # the instance&#x27;s contents and used for optimistic locking. The
10536 # fingerprint is initially generated by Compute Engine and changes after
10537 # every request to modify or update the instance. You must always provide an
10538 # up-to-date fingerprint hash in order to update the instance.
10539 #
10540 # To see the latest fingerprint, make get() request to the
10541 # instance.
10542 &quot;guestAccelerators&quot;: [ # A list of the type and count of accelerator cards attached to the instance.
10543 { # A specification of the type and number of accelerator cards attached to the
10544 # instance.
10545 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
10546 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this
10547 # instance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100
10548 # If you are creating an instance template, specify only the
10549 # accelerator name.
10550 # See GPUs on Compute Engine
10551 # for a full list of accelerator types.
10552 },
10553 ],
10554 &quot;hostname&quot;: &quot;A String&quot;, # Specifies the hostname of the instance. The specified hostname must be
10555 # RFC1035 compliant. If hostname is not specified, the default hostname is
10556 # [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and
10557 # [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.
10558 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
10559 # defined by the server.
10560 &quot;instanceEncryptionKey&quot;: { # Encrypts suspended data for an instance with acustomer-managed
10561 # encryption key.
10562 #
10563 # If you are creating a new instance, this field will encrypt the local SSD
10564 # and in-memory contents of the instance during the suspend operation.
10565 #
10566 # If you do not provide an encryption key when creating the instance, then
10567 # the local SSD and in-memory contents will be encrypted using
10568 # an automatically generated key during the suspend operation.
10569 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
10570 # For example:
10571 #
10572 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
10573 # key_region/cryptoKeys/key
10574 #
10575 # The fully-qualifed key name may be returned for resource GET requests. For
10576 # example:
10577 #
10578 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
10579 # key_region/cryptoKeys/key
10580 # /cryptoKeyVersions/1
10581 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
10582 # key. If absent, the Compute Engine default service account is used.
10583 # For example:
10584 #
10585 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
10586 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
10587 # encryption key, encoded in RFC
10588 # 4648 base64 to either encrypt or decrypt this resource. You can
10589 # provide either the rawKey or thersaEncryptedKey.
10590 # For example:
10591 #
10592 # &quot;rawKey&quot;:
10593 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
10594 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
10595 # customer-supplied encryption key to either encrypt or decrypt this
10596 # resource. You can provide either the rawKey or thersaEncryptedKey.
10597 # For example:
10598 #
10599 # &quot;rsaEncryptedKey&quot;:
10600 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
10601 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
10602 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
10603 #
10604 # The key must meet the following requirements before you can provide it to
10605 # Compute Engine:
10606 #
10607 # 1. The key is wrapped using a RSA public key certificate provided by
10608 # Google.
10609 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
10610 # encoding.
10611 #
10612 # Gets the RSA public key certificate provided by Google at:
10613 #
10614 #
10615 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
10616 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
10617 # 4648 base64 encoded SHA-256 hash of the customer-supplied
10618 # encryption key that protects this resource.
10619 },
10620 &quot;keyRevocationActionType&quot;: &quot;A String&quot;, # KeyRevocationActionType of the instance. Supported options are &quot;STOP&quot; and
10621 # &quot;NONE&quot;. The default value is &quot;NONE&quot; if it is not specified.
10622 &quot;kind&quot;: &quot;compute#instance&quot;, # Output only. [Output Only] Type of the resource. Always compute#instance
10623 # for instances.
10624 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for this request, which is essentially a hash of
10625 # the label&#x27;s contents and used for optimistic locking. The
10626 # fingerprint is initially generated by Compute Engine and changes after
10627 # every request to modify or update labels. You must always provide an
10628 # up-to-date fingerprint hash in order to update or change labels.
10629 #
10630 # To see the latest fingerprint, make get() request to the
10631 # instance.
10632 &quot;labels&quot;: { # Labels to apply to this instance. These can be later modified by
10633 # the setLabels method.
10634 &quot;a_key&quot;: &quot;A String&quot;,
10635 },
10636 &quot;lastStartTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last start timestamp inRFC3339 text format.
10637 &quot;lastStopTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last stop timestamp inRFC3339 text format.
10638 &quot;lastSuspendedTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last suspended timestamp inRFC3339 text format.
10639 &quot;machineType&quot;: &quot;A String&quot;, # Full or partial URL of the machine type resource to use for this instance,
10640 # in the format:zones/zone/machineTypes/machine-type. This is provided by the client
10641 # when the instance is created. For example, the following is a valid partial
10642 # url to a predefined
10643 # machine type:
10644 #
10645 # zones/us-central1-f/machineTypes/n1-standard-1
10646 #
10647 #
10648 # To create acustom
10649 # machine type, provide a URL to a machine type in the following format,
10650 # where CPUS is 1 or an even number up to 32 (2,
10651 # 4, 6, ... 24, etc), and MEMORY is the total
10652 # memory for this instance. Memory must be a multiple of 256 MB and must
10653 # be supplied in MB (e.g. 5 GB of memory is 5120 MB):
10654 #
10655 # zones/zone/machineTypes/custom-CPUS-MEMORY
10656 #
10657 #
10658 # For example: zones/us-central1-f/machineTypes/custom-4-5120
10659 # For a full list of restrictions, read theSpecifications
10660 # for custom machine types.
10661 &quot;metadata&quot;: { # A metadata key/value entry. # The metadata key/value pairs assigned
10662 # to this instance. This includes metadata keys that were explicitly defined
10663 # for the instance.
10664 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
10665 # the metadata&#x27;s contents and used for optimistic locking. The
10666 # fingerprint is initially generated by Compute Engine and changes after
10667 # every request to modify or update metadata. You must always provide an
10668 # up-to-date fingerprint hash in order to update or change metadata,
10669 # otherwise the request will fail with error412 conditionNotMet.
10670 #
10671 # To see the latest fingerprint, make a get() request to
10672 # retrieve the resource.
10673 &quot;items&quot;: [ # Array of key/value pairs. The total size of all keys and values must be
10674 # less than 512 KB.
10675 { # Metadata
10676 &quot;key&quot;: &quot;A String&quot;, # Key for the metadata entry. Keys must conform to the following
10677 # regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length.
10678 # This is reflected as part of a URL in the metadata server. Additionally, to
10679 # avoid ambiguity, keys must not conflict with any other metadata keys
10680 # for the project.
10681 &quot;value&quot;: &quot;A String&quot;, # Value for the metadata entry. These are free-form strings, and only
10682 # have meaning as interpreted by the image running in the instance. The
10683 # only restriction placed on values is that their size must be less than
10684 # or equal to 262144 bytes (256 KiB).
10685 },
10686 ],
10687 &quot;kind&quot;: &quot;compute#metadata&quot;, # Output only. [Output Only] Type of the resource. Always compute#metadata
10688 # for metadata.
10689 },
10690 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Specifies aminimum CPU
10691 # platform for the VM instance. Applicable values are the friendly names
10692 # of CPU platforms, such as minCpuPlatform: &quot;Intel
10693 # Haswell&quot; or minCpuPlatform: &quot;Intel Sandy
10694 # Bridge&quot;.
10695 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating
10696 # the resource. The resource name must be 1-63 characters long, and comply
10697 # withRFC1035.
10698 # Specifically, the name must be 1-63 characters long and match the regular
10699 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
10700 # character must be a lowercase letter, and all following characters must be
10701 # a dash, lowercase letter, or digit, except the last character, which cannot
10702 # be a dash.
10703 &quot;networkInterfaces&quot;: [ # An array of network configurations for this instance. These specify how
10704 # interfaces are configured to interact with other network services, such as
10705 # connecting to the internet. Multiple interfaces are supported
10706 # per instance.
10707 { # A network interface resource attached to an instance.
10708 &quot;accessConfigs&quot;: [ # An array of configurations for this interface. Currently, only one access
10709 # config, ONE_TO_ONE_NAT, is supported. If there are noaccessConfigs specified, then this instance will have
10710 # no external internet access.
10711 { # An access configuration attached to an instance&#x27;s network interface.
10712 # Only one access config per instance is supported.
10713 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
10714 # The first IPv6 address of the external IPv6 range associated
10715 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
10716 # use a static external IP address, it must be unused and in the same region
10717 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
10718 # assign an external IPv6 address from the instance&#x27;s subnetwork.
10719 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
10720 # external IPv6 range.
10721 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
10722 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
10723 # (IPv4), the default and recommended name is External NAT, but
10724 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
10725 # recommend name is External IPv6.
10726 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
10727 # address associated with this instance. Specify an unused static
10728 # external IP address available to the project or leave this field undefined
10729 # to use an IP from a shared ephemeral IP address pool. If you specify a
10730 # static external IP address, it must live in the same region as the zone of
10731 # the instance.
10732 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
10733 # configuration and can only take the following values: PREMIUM,STANDARD.
10734 #
10735 # If an AccessConfig is specified without a valid external IP address, an
10736 # ephemeral IP will be created with this networkTier.
10737 #
10738 # If an AccessConfig with a valid external IP address is specified, it must
10739 # match that of the networkTier associated with the Address resource owning
10740 # that IP.
10741 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
10742 #
10743 # 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
10744 # first IP in associated external IPv6 range.
10745 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
10746 # config.
10747 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
10748 # external IP address of the instance to a DNS domain name.
10749 #
10750 # This field is not used in ipv6AccessConfig. A default PTR
10751 # record will be created if the VM has external IPv6 range associated.
10752 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
10753 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
10754 },
10755 ],
10756 &quot;aliasIpRanges&quot;: [ # An array of alias IP ranges for this network interface.
10757 # You can only specify this field for network interfaces in VPC networks.
10758 { # An alias IP range attached to an instance&#x27;s network interface.
10759 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
10760 # must belong to the specified subnetwork and cannot contain IP addresses
10761 # reserved by system or used by other network interfaces. This range may be
10762 # 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).
10763 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
10764 # alias range. If not specified, the primary range of the subnetwork is used.
10765 },
10766 ],
10767 &quot;aliasIpv6Ranges&quot;: [ # An array of alias IPv6 ranges for this network interface.
10768 # You can only specify this field for network interfaces in VPC networks.
10769 { # An alias IP range attached to an instance&#x27;s network interface.
10770 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
10771 # must belong to the specified subnetwork and cannot contain IP addresses
10772 # reserved by system or used by other network interfaces. This range may be
10773 # 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).
10774 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
10775 # alias range. If not specified, the primary range of the subnetwork is used.
10776 },
10777 ],
10778 &quot;enableVpcScopedDns&quot;: True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
10779 # with network_attachment.
10780 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint hash of contents stored in this network interface.
10781 # This field will be ignored when inserting an Instance or
10782 # adding a NetworkInterface. An up-to-date
10783 # 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.
10784 &quot;igmpQuery&quot;: &quot;A String&quot;, # Indicate whether igmp query is enabled on the network interface
10785 # or not. If enabled, also indicates the version of IGMP supported.
10786 &quot;internalIpv6PrefixLength&quot;: 42, # The prefix length of the primary internal IPv6 range.
10787 &quot;ipv6AccessConfigs&quot;: [ # An array of IPv6 access configurations for this interface. Currently, only
10788 # one IPv6 access config, DIRECT_IPV6, is supported. If there
10789 # is no ipv6AccessConfig specified, then this instance will
10790 # have no external IPv6 Internet access.
10791 { # An access configuration attached to an instance&#x27;s network interface.
10792 # Only one access config per instance is supported.
10793 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
10794 # The first IPv6 address of the external IPv6 range associated
10795 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
10796 # use a static external IP address, it must be unused and in the same region
10797 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
10798 # assign an external IPv6 address from the instance&#x27;s subnetwork.
10799 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
10800 # external IPv6 range.
10801 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
10802 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
10803 # (IPv4), the default and recommended name is External NAT, but
10804 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
10805 # recommend name is External IPv6.
10806 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
10807 # address associated with this instance. Specify an unused static
10808 # external IP address available to the project or leave this field undefined
10809 # to use an IP from a shared ephemeral IP address pool. If you specify a
10810 # static external IP address, it must live in the same region as the zone of
10811 # the instance.
10812 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
10813 # configuration and can only take the following values: PREMIUM,STANDARD.
10814 #
10815 # If an AccessConfig is specified without a valid external IP address, an
10816 # ephemeral IP will be created with this networkTier.
10817 #
10818 # If an AccessConfig with a valid external IP address is specified, it must
10819 # match that of the networkTier associated with the Address resource owning
10820 # that IP.
10821 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
10822 #
10823 # 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
10824 # first IP in associated external IPv6 range.
10825 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
10826 # config.
10827 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
10828 # external IP address of the instance to a DNS domain name.
10829 #
10830 # This field is not used in ipv6AccessConfig. A default PTR
10831 # record will be created if the VM has external IPv6 range associated.
10832 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
10833 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
10834 },
10835 ],
10836 &quot;ipv6AccessType&quot;: &quot;A String&quot;, # Output only. [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be
10837 # accessed from the Internet. This field is always inherited from its
10838 # subnetwork.
10839 #
10840 # Valid only if stackType is IPV4_IPV6.
10841 &quot;ipv6Address&quot;: &quot;A String&quot;, # An IPv6 internal network address for this network interface. To
10842 # use a static internal IP address, it must be unused and in the same region
10843 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
10844 # assign an internal IPv6 address from the instance&#x27;s subnetwork.
10845 &quot;kind&quot;: &quot;compute#networkInterface&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#networkInterface for network interfaces.
10846 &quot;name&quot;: &quot;A String&quot;, # [Output Only] The name of the network interface, which is generated by the
10847 # server. For a VM, the network interface uses the nicN naming
10848 # format. Where N is a value between 0 and7. The default interface value is nic0.
10849 &quot;network&quot;: &quot;A String&quot;, # URL of the VPC network resource for this instance. When creating an
10850 # instance, if neither the network nor the subnetwork is specified, the
10851 # default network global/networks/default is used. If the
10852 # selected project doesn&#x27;t have the default network, you must specify a
10853 # network or subnet. If the network is not specified but the subnetwork is
10854 # specified, the network is inferred.
10855 #
10856 # If you specify this property, you can specify the network as
10857 # a full or partial URL. For example, the following are all valid URLs:
10858 #
10859 #
10860 # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
10861 # - projects/project/global/networks/network
10862 # - global/networks/default
10863 &quot;networkAttachment&quot;: &quot;A String&quot;, # The URL of the network attachment that this interface should connect
10864 # to in the following format:
10865 # projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.
10866 &quot;networkIP&quot;: &quot;A String&quot;, # An IPv4 internal IP address to assign to the instance for this network
10867 # interface. If not specified by the user, an unused internal IP is
10868 # assigned by the system.
10869 &quot;nicType&quot;: &quot;A String&quot;, # The type of vNIC to be used on this interface. This may be gVNIC or
10870 # VirtioNet.
10871 &quot;parentNicName&quot;: &quot;A String&quot;, # Name of the parent network interface of a dynamic network interface.
10872 &quot;queueCount&quot;: 42, # The networking queue count that&#x27;s specified by users for the network
10873 # interface. Both Rx and Tx queues will be set to this number. It&#x27;ll be empty
10874 # if not specified by the users.
10875 &quot;serviceClassId&quot;: &quot;A String&quot;, # Optional. Producer Service&#x27;s Service class Id for the region of this network
10876 # interface. Can only be used with network_attachment. It is not possible to
10877 # use on its own however, network_attachment can be used without
10878 # service_class_id.
10879 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for this network interface. To assign only IPv4 addresses,
10880 # use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, useIPV4_IPV6. If not specified, IPV4_ONLY is used.
10881 #
10882 # This field can be both set at instance creation and update network
10883 # interface operations.
10884 &quot;subnetwork&quot;: &quot;A String&quot;, # The URL of the Subnetwork resource for this instance. If the network
10885 # resource is inlegacy
10886 # mode, do not specify this field. If the network is in auto subnet
10887 # mode, specifying the subnetwork is optional. If the network is in custom
10888 # subnet mode, specifying the subnetwork is required. If you specify this
10889 # field, you can specify the subnetwork as a full or partial URL. For
10890 # example, the following are all valid URLs:
10891 #
10892 #
10893 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
10894 # - regions/region/subnetworks/subnetwork
10895 &quot;vlan&quot;: 42, # VLAN tag of a dynamic network interface, must be an integer in the range
10896 # from 2 to 255 inclusively.
10897 },
10898 ],
10899 &quot;networkPerformanceConfig&quot;: {
10900 &quot;totalEgressBandwidthTier&quot;: &quot;A String&quot;,
10901 },
10902 &quot;params&quot;: { # Additional instance params. # Input only. [Input Only] Additional params passed with the request, but not persisted
10903 # as part of resource payload.
10904 &quot;requestValidForDuration&quot;: { # A Duration represents a fixed-length span of time represented # Relative deadline for waiting for capacity. Relevant only for
10905 # Instances.Insert API.
10906 # as a count of seconds and fractions of seconds at nanosecond
10907 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
10908 # or &quot;month&quot;. Range is approximately 10,000 years.
10909 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
10910 # Durations less than one second are represented with a 0
10911 # `seconds` field and a positive `nanos` field. Must be from 0
10912 # to 999,999,999 inclusive.
10913 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
10914 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
10915 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
10916 },
10917 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the instance. Tag keys and values
10918 # have the same definition as resource
10919 # manager tags. Keys and values can be either in numeric format,
10920 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
10921 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
10922 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
10923 # PATCH) when empty.
10924 &quot;a_key&quot;: &quot;A String&quot;,
10925 },
10926 },
10927 &quot;privateIpv6GoogleAccess&quot;: &quot;A String&quot;, # The private IPv6 google access type for the VM.
10928 # If not specified, use INHERIT_FROM_SUBNETWORK as default.
10929 &quot;reservationAffinity&quot;: { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.
10930 &quot;consumeReservationType&quot;: &quot;A String&quot;, # Specifies the type of reservation from which this instance can consume
10931 # resources: ANY_RESERVATION (default),SPECIFIC_RESERVATION, or NO_RESERVATION. See
10932 # Consuming reserved instances for examples.
10933 &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
10934 # the name of your reservation as its value.
10935 &quot;values&quot;: [ # Corresponds to the label values of a reservation resource. This can be
10936 # either a name to a reservation in the same project or
10937 # &quot;projects/different-project/reservations/some-reservation-name&quot; to target a
10938 # shared reservation in the same zone but in a different project.
10939 &quot;A String&quot;,
10940 ],
10941 },
10942 &quot;resourcePolicies&quot;: [ # Resource policies applied to this instance.
10943 &quot;A String&quot;,
10944 ],
10945 &quot;resourceStatus&quot;: { # Contains output only fields. # Output only. [Output Only] Specifies values set for instance attributes as
10946 # compared to the values requested by user in the corresponding input only
10947 # field.
10948 # Use this sub-message for actual values set on Instance attributes as compared
10949 # to the value requested by the user (intent) in their instance CRUD calls.
10950 &quot;effectiveInstanceMetadata&quot;: { # Effective values of predefined metadata keys for an instance. # Output only. [Output Only] Effective metadata is a field that consolidates project,
10951 # zonal instance settings, and instance-level predefined metadata keys to
10952 # provide the overridden value for those metadata keys at the instance level.
10953 &quot;blockProjectSshKeysMetadataValue&quot;: True or False, # Effective block-project-ssh-keys value at Instance level.
10954 &quot;enableGuestAttributesMetadataValue&quot;: True or False, # Effective enable-guest-attributes value at Instance level.
10955 &quot;enableOsInventoryMetadataValue&quot;: True or False, # Effective enable-os-inventory value at Instance level.
10956 &quot;enableOsconfigMetadataValue&quot;: True or False, # Effective enable-osconfig value at Instance level.
10957 &quot;enableOsloginMetadataValue&quot;: True or False, # Effective enable-oslogin value at Instance level.
10958 &quot;gceContainerDeclarationMetadataValue&quot;: True or False, # Effective gce-container-declaration value at Instance level.
10959 &quot;serialPortEnableMetadataValue&quot;: True or False, # Effective serial-port-enable value at Instance level.
10960 &quot;serialPortLoggingEnableMetadataValue&quot;: True or False, # Effective serial-port-logging-enable value at Instance level.
10961 &quot;vmDnsSettingMetadataValue&quot;: &quot;A String&quot;, # Effective VM DNS setting at Instance level.
10962 },
10963 &quot;physicalHost&quot;: &quot;A String&quot;, # Output only. [Output Only] The precise location of your instance within the zone&#x27;s data
10964 # center, including the block, sub-block, and host. The field is formatted as
10965 # follows: blockId/subBlockId/hostId.
10966 &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
10967 # Engine cluster, as well as the ID of the block, sub-block, and host on
10968 # which the running instance is located.
10969 # running.
10970 &quot;additionalAttributes&quot;: { # Additional location information of the running instance. # Output only. [Output Only] Additional location information of the running instance.
10971 &quot;acceleratorTopologyIds&quot;: { # Output only. The IDs of the accelerator topologies the instance belongs to. For
10972 # example
10973 # The key will be topologies like &quot;4x4&quot;, &quot;2x2x2&quot; and the value will be
10974 # the location ID of the topologies.
10975 &quot;a_key&quot;: &quot;A String&quot;,
10976 },
10977 },
10978 &quot;block&quot;: &quot;A String&quot;, # [Output Only] The ID of the block in which the running instance is
10979 # located. Instances within the same block experience low network latency.
10980 &quot;cluster&quot;: &quot;A String&quot;, # [Output Only] The global name of the Compute Engine cluster where the
10981 # running instance is located.
10982 &quot;host&quot;: &quot;A String&quot;, # [Output Only] The ID of the host on which the running instance is located.
10983 # Instances on the same host experience the lowest possible network
10984 # latency.
10985 &quot;subblock&quot;: &quot;A String&quot;, # [Output Only] The ID of the sub-block in which the running instance is
10986 # located. Instances in the same sub-block experience lower network latency
10987 # than instances in the same block.
10988 },
10989 &quot;reservationConsumptionInfo&quot;: { # Reservation consumption information that the instance is consuming from. # Output only. [Output Only] Reservation information that the instance is consuming from.
10990 &quot;consumedReservation&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the reservation that this
10991 # instance is consuming from.
10992 },
10993 &quot;scheduling&quot;: {
10994 &quot;availabilityDomain&quot;: 42, # Specifies the availability domain to place the instance in. The value
10995 # must be a number between 1 and the number of availability domains
10996 # specified in the spread placement policy attached to the instance.
10997 },
10998 &quot;upcomingMaintenance&quot;: { # Upcoming Maintenance notification information.
10999 &quot;canReschedule&quot;: True or False, # Indicates if the maintenance can be customer triggered.
11000 &quot;latestWindowStartTime&quot;: &quot;A String&quot;, # The latest time for the planned maintenance window to start.
11001 # This timestamp value is in RFC3339 text format.
11002 &quot;maintenanceOnShutdown&quot;: True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown.
11003 &quot;maintenanceReasons&quot;: [ # The reasons for the maintenance. Only valid for vms.
11004 &quot;A String&quot;,
11005 ],
11006 &quot;maintenanceStatus&quot;: &quot;A String&quot;,
11007 &quot;type&quot;: &quot;A String&quot;, # Defines the type of maintenance.
11008 &quot;windowEndTime&quot;: &quot;A String&quot;, # The time by which the maintenance disruption will be completed.
11009 # This timestamp value is in RFC3339 text format.
11010 &quot;windowStartTime&quot;: &quot;A String&quot;, # The current start time of the maintenance window.
11011 # This timestamp value is in RFC3339 text format.
11012 },
11013 },
11014 &quot;satisfiesPzi&quot;: True or False, # Output only. [Output Only] Reserved for future use.
11015 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
11016 &quot;scheduling&quot;: { # Sets the scheduling options for an Instance. # Sets the scheduling options for this instance.
11017 &quot;automaticRestart&quot;: True or False, # Specifies whether the instance should be automatically restarted if it is
11018 # terminated by Compute Engine (not terminated by a user). You can only set
11019 # the automatic restart option for standard instances.Preemptible instances
11020 # cannot be automatically restarted.
11021 #
11022 # By default, this is set to true so an instance is
11023 # automatically restarted if it is terminated by Compute Engine.
11024 &quot;availabilityDomain&quot;: 42, # Specifies the availability domain to place the instance in. The value
11025 # must be a number between 1 and the number of availability domains
11026 # specified in the spread placement policy attached to the instance.
11027 &quot;hostErrorTimeoutSeconds&quot;: 42, # Specify the time in seconds for host error detection, the value must be
11028 # within the range of [90, 330] with the increment of 30, if unset, the
11029 # default behavior of host error recovery will be used.
11030 &quot;instanceTerminationAction&quot;: &quot;A String&quot;, # Specifies the termination action for the instance.
11031 &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
11032 # recovery of the Local Ssd state is attempted. Its value should be in
11033 # between 0 and 168 hours with hour granularity and the default value being 1
11034 # hour.
11035 # as a count of seconds and fractions of seconds at nanosecond
11036 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
11037 # or &quot;month&quot;. Range is approximately 10,000 years.
11038 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
11039 # Durations less than one second are represented with a 0
11040 # `seconds` field and a positive `nanos` field. Must be from 0
11041 # to 999,999,999 inclusive.
11042 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
11043 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
11044 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
11045 },
11046 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the instance close to other
11047 # resources.
11048 # This field is for use by internal tools that use the public API.
11049 &quot;maxRunDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the max run duration for the given instance. If specified,
11050 # the instance termination action will be performed at the end of the run
11051 # duration.
11052 # as a count of seconds and fractions of seconds at nanosecond
11053 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
11054 # or &quot;month&quot;. Range is approximately 10,000 years.
11055 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
11056 # Durations less than one second are represented with a 0
11057 # `seconds` field and a positive `nanos` field. Must be from 0
11058 # to 999,999,999 inclusive.
11059 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
11060 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
11061 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
11062 },
11063 &quot;minNodeCpus&quot;: 42, # The minimum number of virtual CPUs this instance will consume when running
11064 # on a sole-tenant node.
11065 &quot;nodeAffinities&quot;: [ # A set of node affinity and anti-affinity configurations. Refer toConfiguring node
11066 # affinity for more information.
11067 # Overrides reservationAffinity.
11068 { # Node Affinity: the configuration of desired nodes onto which this Instance
11069 # could be scheduled.
11070 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of Node resource.
11071 &quot;operator&quot;: &quot;A String&quot;, # Defines the operation of node selection. Valid operators areIN for affinity and NOT_IN for anti-affinity.
11072 &quot;values&quot;: [ # Corresponds to the label values of Node resource.
11073 &quot;A String&quot;,
11074 ],
11075 },
11076 ],
11077 &quot;onHostMaintenance&quot;: &quot;A String&quot;, # Defines the maintenance behavior for this instance. For standard instances,
11078 # the default behavior is MIGRATE. Forpreemptible instances,
11079 # the default and only possible behavior is TERMINATE. For more
11080 # information, see
11081 # Set
11082 # VM host maintenance policy.
11083 &quot;onInstanceStopAction&quot;: { # Defines the behaviour for instances with the instance_termination_actionSTOP.
11084 &quot;discardLocalSsd&quot;: True or False, # If true, the contents of any attached Local SSD disks will be discarded
11085 # else, the Local SSD data will be preserved when the instance is stopped
11086 # at the end of the run duration/termination time.
11087 },
11088 &quot;preemptible&quot;: True or False, # Defines whether the instance is preemptible. This can only be set during
11089 # instance creation or while the instance isstopped and
11090 # therefore, in a `TERMINATED` state. SeeInstance Life
11091 # Cycle for more information on the possible instance states.
11092 &quot;provisioningModel&quot;: &quot;A String&quot;, # Specifies the provisioning model of the instance.
11093 &quot;skipGuestOsShutdown&quot;: True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
11094 # Off and ACPI G3 Mechanical
11095 # Off for Standard VMs and 30 seconds for Spot VMs.
11096 &quot;terminationTime&quot;: &quot;A String&quot;, # Specifies the timestamp, when the instance will be terminated, inRFC3339 text format. If specified, the instance
11097 # termination action will be performed at the termination time.
11098 },
11099 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
11100 &quot;serviceAccounts&quot;: [ # A list of service accounts, with their specified scopes, authorized for
11101 # this instance. Only one service account per VM instance is supported.
11102 #
11103 # Service accounts generate access tokens that can be accessed
11104 # through the metadata server and used to authenticate applications on the
11105 # instance. SeeService Accounts
11106 # for more information.
11107 { # A service account.
11108 &quot;email&quot;: &quot;A String&quot;, # Email address of the service account.
11109 &quot;scopes&quot;: [ # The list of scopes to be made available for this service account.
11110 &quot;A String&quot;,
11111 ],
11112 },
11113 ],
11114 &quot;shieldedInstanceConfig&quot;: { # A set of Shielded Instance options.
11115 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.Enabled by
11116 # default.
11117 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.Disabled by
11118 # default.
11119 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.Enabled by
11120 # default.
11121 },
11122 &quot;shieldedInstanceIntegrityPolicy&quot;: { # The policy describes the baseline against which
11123 # Instance boot integrity is measured.
11124 &quot;updateAutoLearnPolicy&quot;: True or False, # Updates the integrity policy baseline using the
11125 # measurements from the VM instance&#x27;s most recent boot.
11126 },
11127 &quot;sourceMachineImage&quot;: &quot;A String&quot;, # Source machine image
11128 &quot;sourceMachineImageEncryptionKey&quot;: { # Source machine image encryption key when creating an instance from a
11129 # machine image.
11130 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
11131 # For example:
11132 #
11133 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
11134 # key_region/cryptoKeys/key
11135 #
11136 # The fully-qualifed key name may be returned for resource GET requests. For
11137 # example:
11138 #
11139 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
11140 # key_region/cryptoKeys/key
11141 # /cryptoKeyVersions/1
11142 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
11143 # key. If absent, the Compute Engine default service account is used.
11144 # For example:
11145 #
11146 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
11147 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
11148 # encryption key, encoded in RFC
11149 # 4648 base64 to either encrypt or decrypt this resource. You can
11150 # provide either the rawKey or thersaEncryptedKey.
11151 # For example:
11152 #
11153 # &quot;rawKey&quot;:
11154 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
11155 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
11156 # customer-supplied encryption key to either encrypt or decrypt this
11157 # resource. You can provide either the rawKey or thersaEncryptedKey.
11158 # For example:
11159 #
11160 # &quot;rsaEncryptedKey&quot;:
11161 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
11162 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
11163 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
11164 #
11165 # The key must meet the following requirements before you can provide it to
11166 # Compute Engine:
11167 #
11168 # 1. The key is wrapped using a RSA public key certificate provided by
11169 # Google.
11170 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
11171 # encoding.
11172 #
11173 # Gets the RSA public key certificate provided by Google at:
11174 #
11175 #
11176 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
11177 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
11178 # 4648 base64 encoded SHA-256 hash of the customer-supplied
11179 # encryption key that protects this resource.
11180 },
11181 &quot;startRestricted&quot;: True or False, # Output only. [Output Only] Whether a VM has been restricted for start because Compute
11182 # Engine has detected suspicious activity.
11183 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the instance. One of the
11184 # following values: PROVISIONING, STAGING,RUNNING, STOPPING, SUSPENDING,SUSPENDED, REPAIRING, andTERMINATED. For more information about the status of the
11185 # instance, see
11186 # Instance life cycle.
11187 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. [Output Only] An optional, human-readable explanation of the status.
11188 &quot;tags&quot;: { # A set of instance tags. # Tags to apply to this instance. Tags are used to identify valid
11189 # sources or targets for network firewalls and are specified by the client
11190 # during instance creation. The tags can be later modified by the setTags
11191 # method. Each tag within the list must comply withRFC1035.
11192 # Multiple tags can be specified via the &#x27;tags.items&#x27; field.
11193 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
11194 # the tags&#x27; contents and used for optimistic locking. The
11195 # fingerprint is initially generated by Compute Engine and changes after
11196 # every request to modify or update tags. You must always provide an
11197 # up-to-date fingerprint hash in order to update or change tags.
11198 #
11199 # To see the latest fingerprint, make get() request to the
11200 # instance.
11201 &quot;items&quot;: [ # An array of tags. Each tag must be 1-63 characters long, and comply
11202 # with RFC1035.
11203 &quot;A String&quot;,
11204 ],
11205 },
11206 &quot;workloadIdentityConfig&quot;: {
11207 &quot;identity&quot;: &quot;A String&quot;,
11208 &quot;identityCertificateEnabled&quot;: True or False,
11209 },
11210 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the zone where the instance resides.
11211 # You must specify this field as part of the HTTP request URL. It is
11212 # not settable as a field in the request body.
11213 },
11214 ],
11215 &quot;kind&quot;: &quot;compute#instanceList&quot;, # Output only. [Output Only] Type of resource. Always compute#instanceList
11216 # for lists of Instance resources.
11217 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
11218 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
11219 # the query parameter pageToken in the next list request.
11220 # Subsequent list requests will have their own nextPageToken to
11221 # continue paging through the results.
11222 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
11223 &quot;warning&quot;: { # [Output Only] Informational warning message.
11224 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
11225 # Engine returns NO_RESULTS_ON_PAGE if there
11226 # are no results in the response.
11227 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
11228 # value format. For example:
11229 #
11230 # &quot;data&quot;: [
11231 # {
11232 # &quot;key&quot;: &quot;scope&quot;,
11233 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
11234 # }
11235 {
11236 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
11237 # returned. For example, for warnings where there are no results in a list
11238 # request for a particular zone, this key might be scope and
11239 # the key value might be the zone name. Other examples might be a key
11240 # indicating a deprecated resource and a suggested replacement, or a
11241 # warning about invalid network settings (for example, if an instance
11242 # attempts to perform IP forwarding but is not enabled for IP forwarding).
11243 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
11244 },
11245 ],
11246 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
11247 },
11248 }</pre>
11249 </div>
11250
11251 <div class="method">
11252 <code class="details" id="listReferrers">listReferrers(project, zone, instance, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
11253 <pre>Retrieves a list of resources that refer to the VM instance specified in
11254 the request. For example, if the VM instance is part of a managed or
11255 unmanaged instance group, the referrers list includes the instance group.
11256 For more information, readViewing
11257 referrers to VM instances.
11258
11259 Args:
11260 project: string, Project ID for this request. (required)
11261 zone: string, The name of the zone for this request. (required)
11262 instance: string, Name of the target instance scoping this request, or &#x27;-&#x27; if the
11263 request should span over all instances in the container. (required)
11264 filter: string, A filter expression that filters resources listed in the response. Most
11265 Compute resources support two types of filter expressions:
11266 expressions that support regular expressions and expressions that follow
11267 API improvement proposal AIP-160.
11268 These two types of filter expressions cannot be mixed in one request.
11269
11270 If you want to use AIP-160, your expression must specify the field name, an
11271 operator, and the value that you want to use for filtering. The value
11272 must be a string, a number, or a boolean. The operator
11273 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
11274
11275 For example, if you are filtering Compute Engine instances, you can
11276 exclude instances named `example-instance` by specifying
11277 `name != example-instance`.
11278
11279 The `:*` comparison can be used to test whether a key has been defined.
11280 For example, to find all objects with `owner` label use:
11281 ```
11282 labels.owner:*
11283 ```
11284
11285 You can also filter nested fields. For example, you could specify
11286 `scheduling.automaticRestart = false` to include instances only
11287 if they are not scheduled for automatic restarts. You can use filtering
11288 on nested fields to filter based onresource labels.
11289
11290 To filter on multiple expressions, provide each separate expression within
11291 parentheses. For example:
11292 ```
11293 (scheduling.automaticRestart = true)
11294 (cpuPlatform = &quot;Intel Skylake&quot;)
11295 ```
11296 By default, each expression is an `AND` expression. However, you
11297 can include `AND` and `OR` expressions explicitly.
11298 For example:
11299 ```
11300 (cpuPlatform = &quot;Intel Skylake&quot;) OR
11301 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
11302 (scheduling.automaticRestart = true)
11303 ```
11304
11305 If you want to use a regular expression, use the `eq` (equal) or `ne`
11306 (not equal) operator against a single un-parenthesized expression with or
11307 without quotes or against multiple parenthesized expressions. Examples:
11308
11309 `fieldname eq unquoted literal`
11310 `fieldname eq &#x27;single quoted literal&#x27;`
11311 `fieldname eq &quot;double quoted literal&quot;`
11312 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
11313
11314 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
11315 The literal value must match the entire field.
11316
11317 For example, to filter for instances that do not end with name &quot;instance&quot;,
11318 you would use `name ne .*instance`.
11319
11320 You cannot combine constraints on multiple fields using regular
11321 expressions.
11322 maxResults: integer, The maximum number of results per page that should be returned.
11323 If the number of available results is larger than `maxResults`,
11324 Compute Engine returns a `nextPageToken` that can be used to get
11325 the next page of results in subsequent list requests. Acceptable values are
11326 `0` to `500`, inclusive. (Default: `500`)
11327 orderBy: string, Sorts list results by a certain order. By default, results
11328 are returned in alphanumerical order based on the resource name.
11329
11330 You can also sort results in descending order based on the creation
11331 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
11332 results based on the `creationTimestamp` field in
11333 reverse chronological order (newest result first). Use this to sort
11334 resources like operations so that the newest operation is returned first.
11335
11336 Currently, only sorting by `name` or
11337 `creationTimestamp desc` is supported.
11338 pageToken: string, Specifies a page token to use. Set `pageToken` to the
11339 `nextPageToken` returned by a previous list request to get
11340 the next page of results.
11341 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
11342 of failure. The default value is false.
11343
11344 For example, when partial success behavior is enabled, aggregatedList for a
11345 single zone scope either returns all resources in the zone or no resources,
11346 with an error code.
11347 x__xgafv: string, V1 error format.
11348 Allowed values
11349 1 - v1 error format
11350 2 - v2 error format
11351
11352 Returns:
11353 An object of the form:
11354
11355 { # Contains a list of instance referrers.
11356 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
11357 &quot;items&quot;: [ # A list of Reference resources.
11358 { # Represents a reference to a resource.
11359 &quot;kind&quot;: &quot;compute#reference&quot;, # Output only. [Output Only] Type of the resource. Always compute#reference
11360 # for references.
11361 &quot;referenceType&quot;: &quot;A String&quot;, # A description of the reference type with no implied semantics. Possible
11362 # values include:
11363 #
11364 #
11365 # 1. MEMBER_OF
11366 &quot;referrer&quot;: &quot;A String&quot;, # URL of the resource which refers to the target.
11367 &quot;target&quot;: &quot;A String&quot;, # URL of the resource to which this reference points.
11368 },
11369 ],
11370 &quot;kind&quot;: &quot;compute#instanceListReferrers&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#instanceListReferrers for lists of Instance referrers.
11371 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
11372 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
11373 # the query parameter pageToken in the next list request.
11374 # Subsequent list requests will have their own nextPageToken to
11375 # continue paging through the results.
11376 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
11377 &quot;warning&quot;: { # [Output Only] Informational warning message.
11378 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
11379 # Engine returns NO_RESULTS_ON_PAGE if there
11380 # are no results in the response.
11381 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
11382 # value format. For example:
11383 #
11384 # &quot;data&quot;: [
11385 # {
11386 # &quot;key&quot;: &quot;scope&quot;,
11387 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
11388 # }
11389 {
11390 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
11391 # returned. For example, for warnings where there are no results in a list
11392 # request for a particular zone, this key might be scope and
11393 # the key value might be the zone name. Other examples might be a key
11394 # indicating a deprecated resource and a suggested replacement, or a
11395 # warning about invalid network settings (for example, if an instance
11396 # attempts to perform IP forwarding but is not enabled for IP forwarding).
11397 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
11398 },
11399 ],
11400 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
11401 },
11402 }</pre>
11403 </div>
11404
11405 <div class="method">
11406 <code class="details" id="listReferrers_next">listReferrers_next()</code>
11407 <pre>Retrieves the next page of results.
11408
11409 Args:
11410 previous_request: The request for the previous page. (required)
11411 previous_response: The response from the request for the previous page. (required)
11412
11413 Returns:
11414 A request object that you can call &#x27;execute()&#x27; on to request the next
11415 page. Returns None if there are no more items in the collection.
11416 </pre>
11417 </div>
11418
11419 <div class="method">
11420 <code class="details" id="list_next">list_next()</code>
11421 <pre>Retrieves the next page of results.
11422
11423 Args:
11424 previous_request: The request for the previous page. (required)
11425 previous_response: The response from the request for the previous page. (required)
11426
11427 Returns:
11428 A request object that you can call &#x27;execute()&#x27; on to request the next
11429 page. Returns None if there are no more items in the collection.
11430 </pre>
11431 </div>
11432
11433 <div class="method">
11434 <code class="details" id="performMaintenance">performMaintenance(project, zone, instance, requestId=None, x__xgafv=None)</code>
11435 <pre>Perform a manual maintenance on the instance.
11436
11437 Args:
11438 project: string, Project ID for this request. (required)
11439 zone: string, The name of the zone for this request. (required)
11440 instance: string, Name of the instance scoping this request. (required)
11441 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
11442 that if you must retry your request, the server will know to ignore the
11443 request if it has already been completed.
11444
11445 For example, consider a situation where you make an initial request and
11446 the request times out. If you make the request again with the same
11447 request ID, the server can check if original operation with the same
11448 request ID was received, and if so, will ignore the second request. This
11449 prevents clients from accidentally creating duplicate commitments.
11450
11451 The request ID must be
11452 a valid UUID with the exception that zero UUID is not supported
11453 (00000000-0000-0000-0000-000000000000).
11454 x__xgafv: string, V1 error format.
11455 Allowed values
11456 1 - v1 error format
11457 2 - v2 error format
11458
11459 Returns:
11460 An object of the form:
11461
11462 { # Represents an Operation resource.
11463 #
11464 # Google Compute Engine has three Operation resources:
11465 #
11466 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
11467 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
11468 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
11469 #
11470 # You can use an operation resource to manage asynchronous API requests.
11471 # For more information, readHandling
11472 # API responses.
11473 #
11474 # Operations can be global, regional or zonal.
11475 #
11476 # - For global operations, use the `globalOperations`
11477 # resource.
11478 # - For regional operations, use the
11479 # `regionOperations` resource.
11480 # - For zonal operations, use
11481 # the `zoneOperations` resource.
11482 #
11483 #
11484 #
11485 # For more information, read
11486 # Global, Regional, and Zonal Resources.
11487 #
11488 # Note that completed Operation resources have a limited
11489 # retention period.
11490 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
11491 # Not present otherwise.
11492 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
11493 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
11494 # set when the operation is created.
11495 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
11496 # text format.
11497 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
11498 # this field will be populated.
11499 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
11500 # operation.
11501 {
11502 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
11503 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
11504 # details. There is a set of defined message types to use for providing
11505 # details.The syntax depends on the error code. For example,
11506 # QuotaExceededInfo will have details when the error code is
11507 # QUOTA_EXCEEDED.
11508 {
11509 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
11510 #
11511 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
11512 # is not enabled:
11513 #
11514 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
11515 # &quot;domain&quot;: &quot;googleapis.com&quot;
11516 # &quot;metadata&quot;: {
11517 # &quot;resource&quot;: &quot;projects/123&quot;,
11518 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
11519 # }
11520 # }
11521 #
11522 # This response indicates that the pubsub.googleapis.com API is not enabled.
11523 #
11524 # Example of an error that is returned when attempting to create a Spanner
11525 # instance in a region that is out of stock:
11526 #
11527 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
11528 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
11529 # &quot;metadata&quot;: {
11530 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
11531 # }
11532 # }
11533 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
11534 # is typically the registered service name of the tool or product that
11535 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
11536 # generated by some common infrastructure, the error domain must be a
11537 # globally unique value that identifies the infrastructure. For Google API
11538 # infrastructure, the error domain is &quot;googleapis.com&quot;.
11539 &quot;metadatas&quot;: { # Additional structured details about this error.
11540 #
11541 # Keys must match a regular expression of `a-z+` but should
11542 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
11543 # length. When identifying the current value of an exceeded limit, the units
11544 # should be contained in the key, not the value. For example, rather than
11545 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
11546 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
11547 # instances that can be created in a single (batch) request.
11548 &quot;a_key&quot;: &quot;A String&quot;,
11549 },
11550 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
11551 # proximate cause of the error. Error reasons are unique within a particular
11552 # domain of errors. This should be at most 63 characters and match a
11553 # regular expression of `A-Z+[A-Z0-9]`, which represents
11554 # UPPER_SNAKE_CASE.
11555 },
11556 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
11557 #
11558 # For example, if a quota check failed with an error indicating the calling
11559 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
11560 # directly to the right place in the developer console to flip the bit.
11561 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
11562 { # Describes a URL link.
11563 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
11564 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
11565 },
11566 ],
11567 },
11568 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
11569 # which can be attached to an RPC error.
11570 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
11571 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
11572 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
11573 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
11574 },
11575 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
11576 &quot;dimensions&quot;: { # The map holding related quota dimensions.
11577 &quot;a_key&quot;: &quot;A String&quot;,
11578 },
11579 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
11580 # type or metric.
11581 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
11582 # or metric.
11583 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
11584 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
11585 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
11586 },
11587 },
11588 ],
11589 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
11590 # This property is optional.
11591 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
11592 },
11593 ],
11594 },
11595 &quot;getVersionOperationMetadata&quot;: {
11596 &quot;inlineSbomInfo&quot;: {
11597 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
11598 # appropriate identifiers.
11599 &quot;a_key&quot;: &quot;A String&quot;,
11600 },
11601 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
11602 # identifiers.
11603 &quot;a_key&quot;: &quot;A String&quot;,
11604 },
11605 },
11606 },
11607 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
11608 # message that was returned, such as `NOT FOUND`.
11609 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
11610 # status code that was returned. For example, a `404` means the
11611 # resource was not found.
11612 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
11613 # defined by the server.
11614 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
11615 # This value is inRFC3339
11616 # text format.
11617 &quot;instancesBulkInsertOperationMetadata&quot;: {
11618 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
11619 # Example key: zones/us-central1-a
11620 &quot;a_key&quot;: {
11621 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
11622 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
11623 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
11624 # error.
11625 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
11626 # if the flow is rolling forward or rolling back.
11627 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
11628 },
11629 },
11630 },
11631 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
11632 # Operation resources.
11633 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
11634 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
11635 # group of operations results from a `bulkInsert` API request.
11636 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
11637 # `update`, or `delete`, and so on.
11638 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
11639 # There is no requirement that this be linear or support any granularity of
11640 # operations. This should not be used to guess when the operation will be
11641 # complete. This number should monotonically increase as the operation
11642 # progresses.
11643 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
11644 # applicable when performing regional operations.
11645 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
11646 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
11647 # this field will contain information on all underlying zonal actions and
11648 # their state.
11649 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
11650 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
11651 # Example key: zones/us-central1-a
11652 &quot;a_key&quot;: {
11653 &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
11654 # populated.
11655 # different programming environments, including REST APIs and RPC APIs. It is
11656 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
11657 # three pieces of data: error code, error message, and error details.
11658 #
11659 # You can find out more about this error model and how to work with it in the
11660 # [API Design Guide](https://cloud.google.com/apis/design/errors).
11661 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
11662 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
11663 # message types for APIs to use.
11664 {
11665 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
11666 },
11667 ],
11668 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
11669 # user-facing error message should be localized and sent in the
11670 # google.rpc.Status.details field, or localized by the client.
11671 },
11672 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
11673 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
11674 },
11675 },
11676 },
11677 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
11678 # This value is inRFC3339
11679 # text format.
11680 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
11681 # following:
11682 # `PENDING`, `RUNNING`, or `DONE`.
11683 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
11684 # operation.
11685 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
11686 # of the target resource.
11687 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
11688 # operations related to creating a snapshot, this points to the disk
11689 # that the snapshot was created from.
11690 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
11691 # `[email protected]` or
11692 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
11693 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
11694 # operation, this field will be populated.
11695 {
11696 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
11697 # Engine returns NO_RESULTS_ON_PAGE if there
11698 # are no results in the response.
11699 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
11700 # value format. For example:
11701 #
11702 # &quot;data&quot;: [
11703 # {
11704 # &quot;key&quot;: &quot;scope&quot;,
11705 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
11706 # }
11707 {
11708 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
11709 # returned. For example, for warnings where there are no results in a list
11710 # request for a particular zone, this key might be scope and
11711 # the key value might be the zone name. Other examples might be a key
11712 # indicating a deprecated resource and a suggested replacement, or a
11713 # warning about invalid network settings (for example, if an instance
11714 # attempts to perform IP forwarding but is not enabled for IP forwarding).
11715 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
11716 },
11717 ],
11718 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
11719 },
11720 ],
11721 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
11722 # applicable when performing per-zone operations.
11723 }</pre>
11724 </div>
11725
11726 <div class="method">
11727 <code class="details" id="removeResourcePolicies">removeResourcePolicies(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
11728 <pre>Removes resource policies from an instance.
11729
11730 Args:
11731 project: string, Project ID for this request. (required)
11732 zone: string, The name of the zone for this request. (required)
11733 instance: string, The instance name for this request. (required)
11734 body: object, The request body.
11735 The object takes the form of:
11736
11737 {
11738 &quot;resourcePolicies&quot;: [ # Resource policies to be removed from this instance.
11739 &quot;A String&quot;,
11740 ],
11741 }
11742
11743 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
11744 that if you must retry your request, the server will know to ignore the
11745 request if it has already been completed.
11746
11747 For example, consider a situation where you make an initial request and
11748 the request times out. If you make the request again with the same
11749 request ID, the server can check if original operation with the same
11750 request ID was received, and if so, will ignore the second request. This
11751 prevents clients from accidentally creating duplicate commitments.
11752
11753 The request ID must be
11754 a valid UUID with the exception that zero UUID is not supported
11755 (00000000-0000-0000-0000-000000000000).
11756 x__xgafv: string, V1 error format.
11757 Allowed values
11758 1 - v1 error format
11759 2 - v2 error format
11760
11761 Returns:
11762 An object of the form:
11763
11764 { # Represents an Operation resource.
11765 #
11766 # Google Compute Engine has three Operation resources:
11767 #
11768 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
11769 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
11770 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
11771 #
11772 # You can use an operation resource to manage asynchronous API requests.
11773 # For more information, readHandling
11774 # API responses.
11775 #
11776 # Operations can be global, regional or zonal.
11777 #
11778 # - For global operations, use the `globalOperations`
11779 # resource.
11780 # - For regional operations, use the
11781 # `regionOperations` resource.
11782 # - For zonal operations, use
11783 # the `zoneOperations` resource.
11784 #
11785 #
11786 #
11787 # For more information, read
11788 # Global, Regional, and Zonal Resources.
11789 #
11790 # Note that completed Operation resources have a limited
11791 # retention period.
11792 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
11793 # Not present otherwise.
11794 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
11795 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
11796 # set when the operation is created.
11797 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
11798 # text format.
11799 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
11800 # this field will be populated.
11801 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
11802 # operation.
11803 {
11804 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
11805 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
11806 # details. There is a set of defined message types to use for providing
11807 # details.The syntax depends on the error code. For example,
11808 # QuotaExceededInfo will have details when the error code is
11809 # QUOTA_EXCEEDED.
11810 {
11811 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
11812 #
11813 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
11814 # is not enabled:
11815 #
11816 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
11817 # &quot;domain&quot;: &quot;googleapis.com&quot;
11818 # &quot;metadata&quot;: {
11819 # &quot;resource&quot;: &quot;projects/123&quot;,
11820 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
11821 # }
11822 # }
11823 #
11824 # This response indicates that the pubsub.googleapis.com API is not enabled.
11825 #
11826 # Example of an error that is returned when attempting to create a Spanner
11827 # instance in a region that is out of stock:
11828 #
11829 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
11830 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
11831 # &quot;metadata&quot;: {
11832 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
11833 # }
11834 # }
11835 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
11836 # is typically the registered service name of the tool or product that
11837 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
11838 # generated by some common infrastructure, the error domain must be a
11839 # globally unique value that identifies the infrastructure. For Google API
11840 # infrastructure, the error domain is &quot;googleapis.com&quot;.
11841 &quot;metadatas&quot;: { # Additional structured details about this error.
11842 #
11843 # Keys must match a regular expression of `a-z+` but should
11844 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
11845 # length. When identifying the current value of an exceeded limit, the units
11846 # should be contained in the key, not the value. For example, rather than
11847 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
11848 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
11849 # instances that can be created in a single (batch) request.
11850 &quot;a_key&quot;: &quot;A String&quot;,
11851 },
11852 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
11853 # proximate cause of the error. Error reasons are unique within a particular
11854 # domain of errors. This should be at most 63 characters and match a
11855 # regular expression of `A-Z+[A-Z0-9]`, which represents
11856 # UPPER_SNAKE_CASE.
11857 },
11858 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
11859 #
11860 # For example, if a quota check failed with an error indicating the calling
11861 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
11862 # directly to the right place in the developer console to flip the bit.
11863 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
11864 { # Describes a URL link.
11865 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
11866 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
11867 },
11868 ],
11869 },
11870 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
11871 # which can be attached to an RPC error.
11872 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
11873 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
11874 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
11875 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
11876 },
11877 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
11878 &quot;dimensions&quot;: { # The map holding related quota dimensions.
11879 &quot;a_key&quot;: &quot;A String&quot;,
11880 },
11881 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
11882 # type or metric.
11883 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
11884 # or metric.
11885 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
11886 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
11887 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
11888 },
11889 },
11890 ],
11891 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
11892 # This property is optional.
11893 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
11894 },
11895 ],
11896 },
11897 &quot;getVersionOperationMetadata&quot;: {
11898 &quot;inlineSbomInfo&quot;: {
11899 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
11900 # appropriate identifiers.
11901 &quot;a_key&quot;: &quot;A String&quot;,
11902 },
11903 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
11904 # identifiers.
11905 &quot;a_key&quot;: &quot;A String&quot;,
11906 },
11907 },
11908 },
11909 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
11910 # message that was returned, such as `NOT FOUND`.
11911 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
11912 # status code that was returned. For example, a `404` means the
11913 # resource was not found.
11914 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
11915 # defined by the server.
11916 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
11917 # This value is inRFC3339
11918 # text format.
11919 &quot;instancesBulkInsertOperationMetadata&quot;: {
11920 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
11921 # Example key: zones/us-central1-a
11922 &quot;a_key&quot;: {
11923 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
11924 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
11925 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
11926 # error.
11927 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
11928 # if the flow is rolling forward or rolling back.
11929 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
11930 },
11931 },
11932 },
11933 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
11934 # Operation resources.
11935 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
11936 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
11937 # group of operations results from a `bulkInsert` API request.
11938 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
11939 # `update`, or `delete`, and so on.
11940 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
11941 # There is no requirement that this be linear or support any granularity of
11942 # operations. This should not be used to guess when the operation will be
11943 # complete. This number should monotonically increase as the operation
11944 # progresses.
11945 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
11946 # applicable when performing regional operations.
11947 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
11948 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
11949 # this field will contain information on all underlying zonal actions and
11950 # their state.
11951 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
11952 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
11953 # Example key: zones/us-central1-a
11954 &quot;a_key&quot;: {
11955 &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
11956 # populated.
11957 # different programming environments, including REST APIs and RPC APIs. It is
11958 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
11959 # three pieces of data: error code, error message, and error details.
11960 #
11961 # You can find out more about this error model and how to work with it in the
11962 # [API Design Guide](https://cloud.google.com/apis/design/errors).
11963 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
11964 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
11965 # message types for APIs to use.
11966 {
11967 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
11968 },
11969 ],
11970 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
11971 # user-facing error message should be localized and sent in the
11972 # google.rpc.Status.details field, or localized by the client.
11973 },
11974 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
11975 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
11976 },
11977 },
11978 },
11979 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
11980 # This value is inRFC3339
11981 # text format.
11982 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
11983 # following:
11984 # `PENDING`, `RUNNING`, or `DONE`.
11985 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
11986 # operation.
11987 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
11988 # of the target resource.
11989 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
11990 # operations related to creating a snapshot, this points to the disk
11991 # that the snapshot was created from.
11992 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
11993 # `[email protected]` or
11994 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
11995 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
11996 # operation, this field will be populated.
11997 {
11998 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
11999 # Engine returns NO_RESULTS_ON_PAGE if there
12000 # are no results in the response.
12001 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
12002 # value format. For example:
12003 #
12004 # &quot;data&quot;: [
12005 # {
12006 # &quot;key&quot;: &quot;scope&quot;,
12007 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
12008 # }
12009 {
12010 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
12011 # returned. For example, for warnings where there are no results in a list
12012 # request for a particular zone, this key might be scope and
12013 # the key value might be the zone name. Other examples might be a key
12014 # indicating a deprecated resource and a suggested replacement, or a
12015 # warning about invalid network settings (for example, if an instance
12016 # attempts to perform IP forwarding but is not enabled for IP forwarding).
12017 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
12018 },
12019 ],
12020 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
12021 },
12022 ],
12023 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
12024 # applicable when performing per-zone operations.
12025 }</pre>
12026 </div>
12027
12028 <div class="method">
12029 <code class="details" id="reportHostAsFaulty">reportHostAsFaulty(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
12030 <pre>Mark the host as faulty and try to restart the instance on a new host.
12031
12032 Args:
12033 project: string, Project ID for this request. (required)
12034 zone: string, The name of the zone for this request. (required)
12035 instance: string, Name of the instance scoping this request. (required)
12036 body: object, The request body.
12037 The object takes the form of:
12038
12039 {
12040 &quot;disruptionSchedule&quot;: &quot;A String&quot;, # The disruption schedule for the VM. Required field, only allows IMMEDIATE.
12041 &quot;faultReasons&quot;: [
12042 {
12043 &quot;behavior&quot;: &quot;A String&quot;,
12044 &quot;description&quot;: &quot;A String&quot;,
12045 },
12046 ],
12047 }
12048
12049 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
12050 that if you must retry your request, the server will know to ignore the
12051 request if it has already been completed.
12052
12053 For example, consider a situation where you make an initial request and
12054 the request times out. If you make the request again with the same
12055 request ID, the server can check if original operation with the same
12056 request ID was received, and if so, will ignore the second request. This
12057 prevents clients from accidentally creating duplicate commitments.
12058
12059 The request ID must be
12060 a valid UUID with the exception that zero UUID is not supported
12061 (00000000-0000-0000-0000-000000000000).
12062 x__xgafv: string, V1 error format.
12063 Allowed values
12064 1 - v1 error format
12065 2 - v2 error format
12066
12067 Returns:
12068 An object of the form:
12069
12070 { # Represents an Operation resource.
12071 #
12072 # Google Compute Engine has three Operation resources:
12073 #
12074 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
12075 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
12076 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
12077 #
12078 # You can use an operation resource to manage asynchronous API requests.
12079 # For more information, readHandling
12080 # API responses.
12081 #
12082 # Operations can be global, regional or zonal.
12083 #
12084 # - For global operations, use the `globalOperations`
12085 # resource.
12086 # - For regional operations, use the
12087 # `regionOperations` resource.
12088 # - For zonal operations, use
12089 # the `zoneOperations` resource.
12090 #
12091 #
12092 #
12093 # For more information, read
12094 # Global, Regional, and Zonal Resources.
12095 #
12096 # Note that completed Operation resources have a limited
12097 # retention period.
12098 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
12099 # Not present otherwise.
12100 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
12101 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
12102 # set when the operation is created.
12103 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
12104 # text format.
12105 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
12106 # this field will be populated.
12107 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
12108 # operation.
12109 {
12110 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
12111 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
12112 # details. There is a set of defined message types to use for providing
12113 # details.The syntax depends on the error code. For example,
12114 # QuotaExceededInfo will have details when the error code is
12115 # QUOTA_EXCEEDED.
12116 {
12117 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
12118 #
12119 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
12120 # is not enabled:
12121 #
12122 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
12123 # &quot;domain&quot;: &quot;googleapis.com&quot;
12124 # &quot;metadata&quot;: {
12125 # &quot;resource&quot;: &quot;projects/123&quot;,
12126 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
12127 # }
12128 # }
12129 #
12130 # This response indicates that the pubsub.googleapis.com API is not enabled.
12131 #
12132 # Example of an error that is returned when attempting to create a Spanner
12133 # instance in a region that is out of stock:
12134 #
12135 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
12136 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
12137 # &quot;metadata&quot;: {
12138 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
12139 # }
12140 # }
12141 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
12142 # is typically the registered service name of the tool or product that
12143 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
12144 # generated by some common infrastructure, the error domain must be a
12145 # globally unique value that identifies the infrastructure. For Google API
12146 # infrastructure, the error domain is &quot;googleapis.com&quot;.
12147 &quot;metadatas&quot;: { # Additional structured details about this error.
12148 #
12149 # Keys must match a regular expression of `a-z+` but should
12150 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
12151 # length. When identifying the current value of an exceeded limit, the units
12152 # should be contained in the key, not the value. For example, rather than
12153 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
12154 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
12155 # instances that can be created in a single (batch) request.
12156 &quot;a_key&quot;: &quot;A String&quot;,
12157 },
12158 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
12159 # proximate cause of the error. Error reasons are unique within a particular
12160 # domain of errors. This should be at most 63 characters and match a
12161 # regular expression of `A-Z+[A-Z0-9]`, which represents
12162 # UPPER_SNAKE_CASE.
12163 },
12164 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
12165 #
12166 # For example, if a quota check failed with an error indicating the calling
12167 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
12168 # directly to the right place in the developer console to flip the bit.
12169 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
12170 { # Describes a URL link.
12171 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
12172 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
12173 },
12174 ],
12175 },
12176 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
12177 # which can be attached to an RPC error.
12178 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
12179 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
12180 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
12181 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
12182 },
12183 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
12184 &quot;dimensions&quot;: { # The map holding related quota dimensions.
12185 &quot;a_key&quot;: &quot;A String&quot;,
12186 },
12187 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
12188 # type or metric.
12189 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
12190 # or metric.
12191 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
12192 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
12193 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
12194 },
12195 },
12196 ],
12197 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
12198 # This property is optional.
12199 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
12200 },
12201 ],
12202 },
12203 &quot;getVersionOperationMetadata&quot;: {
12204 &quot;inlineSbomInfo&quot;: {
12205 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
12206 # appropriate identifiers.
12207 &quot;a_key&quot;: &quot;A String&quot;,
12208 },
12209 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
12210 # identifiers.
12211 &quot;a_key&quot;: &quot;A String&quot;,
12212 },
12213 },
12214 },
12215 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
12216 # message that was returned, such as `NOT FOUND`.
12217 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
12218 # status code that was returned. For example, a `404` means the
12219 # resource was not found.
12220 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
12221 # defined by the server.
12222 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
12223 # This value is inRFC3339
12224 # text format.
12225 &quot;instancesBulkInsertOperationMetadata&quot;: {
12226 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
12227 # Example key: zones/us-central1-a
12228 &quot;a_key&quot;: {
12229 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
12230 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
12231 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
12232 # error.
12233 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
12234 # if the flow is rolling forward or rolling back.
12235 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
12236 },
12237 },
12238 },
12239 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
12240 # Operation resources.
12241 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
12242 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
12243 # group of operations results from a `bulkInsert` API request.
12244 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
12245 # `update`, or `delete`, and so on.
12246 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
12247 # There is no requirement that this be linear or support any granularity of
12248 # operations. This should not be used to guess when the operation will be
12249 # complete. This number should monotonically increase as the operation
12250 # progresses.
12251 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
12252 # applicable when performing regional operations.
12253 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
12254 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
12255 # this field will contain information on all underlying zonal actions and
12256 # their state.
12257 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
12258 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
12259 # Example key: zones/us-central1-a
12260 &quot;a_key&quot;: {
12261 &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
12262 # populated.
12263 # different programming environments, including REST APIs and RPC APIs. It is
12264 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
12265 # three pieces of data: error code, error message, and error details.
12266 #
12267 # You can find out more about this error model and how to work with it in the
12268 # [API Design Guide](https://cloud.google.com/apis/design/errors).
12269 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
12270 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
12271 # message types for APIs to use.
12272 {
12273 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
12274 },
12275 ],
12276 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
12277 # user-facing error message should be localized and sent in the
12278 # google.rpc.Status.details field, or localized by the client.
12279 },
12280 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
12281 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
12282 },
12283 },
12284 },
12285 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
12286 # This value is inRFC3339
12287 # text format.
12288 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
12289 # following:
12290 # `PENDING`, `RUNNING`, or `DONE`.
12291 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
12292 # operation.
12293 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
12294 # of the target resource.
12295 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
12296 # operations related to creating a snapshot, this points to the disk
12297 # that the snapshot was created from.
12298 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
12299 # `[email protected]` or
12300 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
12301 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
12302 # operation, this field will be populated.
12303 {
12304 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
12305 # Engine returns NO_RESULTS_ON_PAGE if there
12306 # are no results in the response.
12307 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
12308 # value format. For example:
12309 #
12310 # &quot;data&quot;: [
12311 # {
12312 # &quot;key&quot;: &quot;scope&quot;,
12313 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
12314 # }
12315 {
12316 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
12317 # returned. For example, for warnings where there are no results in a list
12318 # request for a particular zone, this key might be scope and
12319 # the key value might be the zone name. Other examples might be a key
12320 # indicating a deprecated resource and a suggested replacement, or a
12321 # warning about invalid network settings (for example, if an instance
12322 # attempts to perform IP forwarding but is not enabled for IP forwarding).
12323 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
12324 },
12325 ],
12326 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
12327 },
12328 ],
12329 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
12330 # applicable when performing per-zone operations.
12331 }</pre>
12332 </div>
12333
12334 <div class="method">
12335 <code class="details" id="reset">reset(project, zone, instance, requestId=None, x__xgafv=None)</code>
12336 <pre>Performs a reset on the instance. This is a hard reset. The VM
12337 does not do a graceful shutdown. For more information, seeResetting
12338 an instance.
12339
12340 Args:
12341 project: string, Project ID for this request. (required)
12342 zone: string, The name of the zone for this request. (required)
12343 instance: string, Name of the instance scoping this request. (required)
12344 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
12345 that if you must retry your request, the server will know to ignore the
12346 request if it has already been completed.
12347
12348 For example, consider a situation where you make an initial request and
12349 the request times out. If you make the request again with the same
12350 request ID, the server can check if original operation with the same
12351 request ID was received, and if so, will ignore the second request. This
12352 prevents clients from accidentally creating duplicate commitments.
12353
12354 The request ID must be
12355 a valid UUID with the exception that zero UUID is not supported
12356 (00000000-0000-0000-0000-000000000000).
12357 x__xgafv: string, V1 error format.
12358 Allowed values
12359 1 - v1 error format
12360 2 - v2 error format
12361
12362 Returns:
12363 An object of the form:
12364
12365 { # Represents an Operation resource.
12366 #
12367 # Google Compute Engine has three Operation resources:
12368 #
12369 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
12370 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
12371 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
12372 #
12373 # You can use an operation resource to manage asynchronous API requests.
12374 # For more information, readHandling
12375 # API responses.
12376 #
12377 # Operations can be global, regional or zonal.
12378 #
12379 # - For global operations, use the `globalOperations`
12380 # resource.
12381 # - For regional operations, use the
12382 # `regionOperations` resource.
12383 # - For zonal operations, use
12384 # the `zoneOperations` resource.
12385 #
12386 #
12387 #
12388 # For more information, read
12389 # Global, Regional, and Zonal Resources.
12390 #
12391 # Note that completed Operation resources have a limited
12392 # retention period.
12393 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
12394 # Not present otherwise.
12395 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
12396 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
12397 # set when the operation is created.
12398 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
12399 # text format.
12400 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
12401 # this field will be populated.
12402 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
12403 # operation.
12404 {
12405 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
12406 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
12407 # details. There is a set of defined message types to use for providing
12408 # details.The syntax depends on the error code. For example,
12409 # QuotaExceededInfo will have details when the error code is
12410 # QUOTA_EXCEEDED.
12411 {
12412 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
12413 #
12414 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
12415 # is not enabled:
12416 #
12417 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
12418 # &quot;domain&quot;: &quot;googleapis.com&quot;
12419 # &quot;metadata&quot;: {
12420 # &quot;resource&quot;: &quot;projects/123&quot;,
12421 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
12422 # }
12423 # }
12424 #
12425 # This response indicates that the pubsub.googleapis.com API is not enabled.
12426 #
12427 # Example of an error that is returned when attempting to create a Spanner
12428 # instance in a region that is out of stock:
12429 #
12430 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
12431 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
12432 # &quot;metadata&quot;: {
12433 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
12434 # }
12435 # }
12436 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
12437 # is typically the registered service name of the tool or product that
12438 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
12439 # generated by some common infrastructure, the error domain must be a
12440 # globally unique value that identifies the infrastructure. For Google API
12441 # infrastructure, the error domain is &quot;googleapis.com&quot;.
12442 &quot;metadatas&quot;: { # Additional structured details about this error.
12443 #
12444 # Keys must match a regular expression of `a-z+` but should
12445 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
12446 # length. When identifying the current value of an exceeded limit, the units
12447 # should be contained in the key, not the value. For example, rather than
12448 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
12449 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
12450 # instances that can be created in a single (batch) request.
12451 &quot;a_key&quot;: &quot;A String&quot;,
12452 },
12453 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
12454 # proximate cause of the error. Error reasons are unique within a particular
12455 # domain of errors. This should be at most 63 characters and match a
12456 # regular expression of `A-Z+[A-Z0-9]`, which represents
12457 # UPPER_SNAKE_CASE.
12458 },
12459 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
12460 #
12461 # For example, if a quota check failed with an error indicating the calling
12462 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
12463 # directly to the right place in the developer console to flip the bit.
12464 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
12465 { # Describes a URL link.
12466 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
12467 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
12468 },
12469 ],
12470 },
12471 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
12472 # which can be attached to an RPC error.
12473 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
12474 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
12475 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
12476 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
12477 },
12478 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
12479 &quot;dimensions&quot;: { # The map holding related quota dimensions.
12480 &quot;a_key&quot;: &quot;A String&quot;,
12481 },
12482 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
12483 # type or metric.
12484 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
12485 # or metric.
12486 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
12487 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
12488 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
12489 },
12490 },
12491 ],
12492 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
12493 # This property is optional.
12494 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
12495 },
12496 ],
12497 },
12498 &quot;getVersionOperationMetadata&quot;: {
12499 &quot;inlineSbomInfo&quot;: {
12500 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
12501 # appropriate identifiers.
12502 &quot;a_key&quot;: &quot;A String&quot;,
12503 },
12504 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
12505 # identifiers.
12506 &quot;a_key&quot;: &quot;A String&quot;,
12507 },
12508 },
12509 },
12510 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
12511 # message that was returned, such as `NOT FOUND`.
12512 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
12513 # status code that was returned. For example, a `404` means the
12514 # resource was not found.
12515 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
12516 # defined by the server.
12517 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
12518 # This value is inRFC3339
12519 # text format.
12520 &quot;instancesBulkInsertOperationMetadata&quot;: {
12521 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
12522 # Example key: zones/us-central1-a
12523 &quot;a_key&quot;: {
12524 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
12525 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
12526 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
12527 # error.
12528 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
12529 # if the flow is rolling forward or rolling back.
12530 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
12531 },
12532 },
12533 },
12534 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
12535 # Operation resources.
12536 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
12537 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
12538 # group of operations results from a `bulkInsert` API request.
12539 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
12540 # `update`, or `delete`, and so on.
12541 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
12542 # There is no requirement that this be linear or support any granularity of
12543 # operations. This should not be used to guess when the operation will be
12544 # complete. This number should monotonically increase as the operation
12545 # progresses.
12546 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
12547 # applicable when performing regional operations.
12548 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
12549 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
12550 # this field will contain information on all underlying zonal actions and
12551 # their state.
12552 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
12553 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
12554 # Example key: zones/us-central1-a
12555 &quot;a_key&quot;: {
12556 &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
12557 # populated.
12558 # different programming environments, including REST APIs and RPC APIs. It is
12559 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
12560 # three pieces of data: error code, error message, and error details.
12561 #
12562 # You can find out more about this error model and how to work with it in the
12563 # [API Design Guide](https://cloud.google.com/apis/design/errors).
12564 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
12565 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
12566 # message types for APIs to use.
12567 {
12568 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
12569 },
12570 ],
12571 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
12572 # user-facing error message should be localized and sent in the
12573 # google.rpc.Status.details field, or localized by the client.
12574 },
12575 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
12576 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
12577 },
12578 },
12579 },
12580 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
12581 # This value is inRFC3339
12582 # text format.
12583 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
12584 # following:
12585 # `PENDING`, `RUNNING`, or `DONE`.
12586 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
12587 # operation.
12588 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
12589 # of the target resource.
12590 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
12591 # operations related to creating a snapshot, this points to the disk
12592 # that the snapshot was created from.
12593 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
12594 # `[email protected]` or
12595 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
12596 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
12597 # operation, this field will be populated.
12598 {
12599 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
12600 # Engine returns NO_RESULTS_ON_PAGE if there
12601 # are no results in the response.
12602 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
12603 # value format. For example:
12604 #
12605 # &quot;data&quot;: [
12606 # {
12607 # &quot;key&quot;: &quot;scope&quot;,
12608 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
12609 # }
12610 {
12611 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
12612 # returned. For example, for warnings where there are no results in a list
12613 # request for a particular zone, this key might be scope and
12614 # the key value might be the zone name. Other examples might be a key
12615 # indicating a deprecated resource and a suggested replacement, or a
12616 # warning about invalid network settings (for example, if an instance
12617 # attempts to perform IP forwarding but is not enabled for IP forwarding).
12618 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
12619 },
12620 ],
12621 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
12622 },
12623 ],
12624 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
12625 # applicable when performing per-zone operations.
12626 }</pre>
12627 </div>
12628
12629 <div class="method">
12630 <code class="details" id="resume">resume(project, zone, instance, requestId=None, x__xgafv=None)</code>
12631 <pre>Resumes an instance that was suspended using theinstances().suspend
12632 method.
12633
12634 Args:
12635 project: string, Project ID for this request. (required)
12636 zone: string, The name of the zone for this request. (required)
12637 instance: string, Name of the instance resource to resume. (required)
12638 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
12639 that if you must retry your request, the server will know to ignore the
12640 request if it has already been completed.
12641
12642 For example, consider a situation where you make an initial request and
12643 the request times out. If you make the request again with the same
12644 request ID, the server can check if original operation with the same
12645 request ID was received, and if so, will ignore the second request. This
12646 prevents clients from accidentally creating duplicate commitments.
12647
12648 The request ID must be
12649 a valid UUID with the exception that zero UUID is not supported
12650 (00000000-0000-0000-0000-000000000000).
12651 x__xgafv: string, V1 error format.
12652 Allowed values
12653 1 - v1 error format
12654 2 - v2 error format
12655
12656 Returns:
12657 An object of the form:
12658
12659 { # Represents an Operation resource.
12660 #
12661 # Google Compute Engine has three Operation resources:
12662 #
12663 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
12664 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
12665 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
12666 #
12667 # You can use an operation resource to manage asynchronous API requests.
12668 # For more information, readHandling
12669 # API responses.
12670 #
12671 # Operations can be global, regional or zonal.
12672 #
12673 # - For global operations, use the `globalOperations`
12674 # resource.
12675 # - For regional operations, use the
12676 # `regionOperations` resource.
12677 # - For zonal operations, use
12678 # the `zoneOperations` resource.
12679 #
12680 #
12681 #
12682 # For more information, read
12683 # Global, Regional, and Zonal Resources.
12684 #
12685 # Note that completed Operation resources have a limited
12686 # retention period.
12687 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
12688 # Not present otherwise.
12689 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
12690 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
12691 # set when the operation is created.
12692 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
12693 # text format.
12694 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
12695 # this field will be populated.
12696 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
12697 # operation.
12698 {
12699 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
12700 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
12701 # details. There is a set of defined message types to use for providing
12702 # details.The syntax depends on the error code. For example,
12703 # QuotaExceededInfo will have details when the error code is
12704 # QUOTA_EXCEEDED.
12705 {
12706 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
12707 #
12708 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
12709 # is not enabled:
12710 #
12711 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
12712 # &quot;domain&quot;: &quot;googleapis.com&quot;
12713 # &quot;metadata&quot;: {
12714 # &quot;resource&quot;: &quot;projects/123&quot;,
12715 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
12716 # }
12717 # }
12718 #
12719 # This response indicates that the pubsub.googleapis.com API is not enabled.
12720 #
12721 # Example of an error that is returned when attempting to create a Spanner
12722 # instance in a region that is out of stock:
12723 #
12724 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
12725 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
12726 # &quot;metadata&quot;: {
12727 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
12728 # }
12729 # }
12730 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
12731 # is typically the registered service name of the tool or product that
12732 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
12733 # generated by some common infrastructure, the error domain must be a
12734 # globally unique value that identifies the infrastructure. For Google API
12735 # infrastructure, the error domain is &quot;googleapis.com&quot;.
12736 &quot;metadatas&quot;: { # Additional structured details about this error.
12737 #
12738 # Keys must match a regular expression of `a-z+` but should
12739 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
12740 # length. When identifying the current value of an exceeded limit, the units
12741 # should be contained in the key, not the value. For example, rather than
12742 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
12743 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
12744 # instances that can be created in a single (batch) request.
12745 &quot;a_key&quot;: &quot;A String&quot;,
12746 },
12747 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
12748 # proximate cause of the error. Error reasons are unique within a particular
12749 # domain of errors. This should be at most 63 characters and match a
12750 # regular expression of `A-Z+[A-Z0-9]`, which represents
12751 # UPPER_SNAKE_CASE.
12752 },
12753 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
12754 #
12755 # For example, if a quota check failed with an error indicating the calling
12756 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
12757 # directly to the right place in the developer console to flip the bit.
12758 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
12759 { # Describes a URL link.
12760 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
12761 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
12762 },
12763 ],
12764 },
12765 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
12766 # which can be attached to an RPC error.
12767 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
12768 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
12769 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
12770 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
12771 },
12772 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
12773 &quot;dimensions&quot;: { # The map holding related quota dimensions.
12774 &quot;a_key&quot;: &quot;A String&quot;,
12775 },
12776 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
12777 # type or metric.
12778 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
12779 # or metric.
12780 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
12781 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
12782 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
12783 },
12784 },
12785 ],
12786 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
12787 # This property is optional.
12788 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
12789 },
12790 ],
12791 },
12792 &quot;getVersionOperationMetadata&quot;: {
12793 &quot;inlineSbomInfo&quot;: {
12794 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
12795 # appropriate identifiers.
12796 &quot;a_key&quot;: &quot;A String&quot;,
12797 },
12798 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
12799 # identifiers.
12800 &quot;a_key&quot;: &quot;A String&quot;,
12801 },
12802 },
12803 },
12804 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
12805 # message that was returned, such as `NOT FOUND`.
12806 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
12807 # status code that was returned. For example, a `404` means the
12808 # resource was not found.
12809 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
12810 # defined by the server.
12811 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
12812 # This value is inRFC3339
12813 # text format.
12814 &quot;instancesBulkInsertOperationMetadata&quot;: {
12815 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
12816 # Example key: zones/us-central1-a
12817 &quot;a_key&quot;: {
12818 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
12819 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
12820 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
12821 # error.
12822 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
12823 # if the flow is rolling forward or rolling back.
12824 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
12825 },
12826 },
12827 },
12828 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
12829 # Operation resources.
12830 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
12831 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
12832 # group of operations results from a `bulkInsert` API request.
12833 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
12834 # `update`, or `delete`, and so on.
12835 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
12836 # There is no requirement that this be linear or support any granularity of
12837 # operations. This should not be used to guess when the operation will be
12838 # complete. This number should monotonically increase as the operation
12839 # progresses.
12840 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
12841 # applicable when performing regional operations.
12842 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
12843 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
12844 # this field will contain information on all underlying zonal actions and
12845 # their state.
12846 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
12847 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
12848 # Example key: zones/us-central1-a
12849 &quot;a_key&quot;: {
12850 &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
12851 # populated.
12852 # different programming environments, including REST APIs and RPC APIs. It is
12853 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
12854 # three pieces of data: error code, error message, and error details.
12855 #
12856 # You can find out more about this error model and how to work with it in the
12857 # [API Design Guide](https://cloud.google.com/apis/design/errors).
12858 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
12859 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
12860 # message types for APIs to use.
12861 {
12862 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
12863 },
12864 ],
12865 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
12866 # user-facing error message should be localized and sent in the
12867 # google.rpc.Status.details field, or localized by the client.
12868 },
12869 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
12870 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
12871 },
12872 },
12873 },
12874 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
12875 # This value is inRFC3339
12876 # text format.
12877 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
12878 # following:
12879 # `PENDING`, `RUNNING`, or `DONE`.
12880 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
12881 # operation.
12882 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
12883 # of the target resource.
12884 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
12885 # operations related to creating a snapshot, this points to the disk
12886 # that the snapshot was created from.
12887 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
12888 # `[email protected]` or
12889 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
12890 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
12891 # operation, this field will be populated.
12892 {
12893 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
12894 # Engine returns NO_RESULTS_ON_PAGE if there
12895 # are no results in the response.
12896 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
12897 # value format. For example:
12898 #
12899 # &quot;data&quot;: [
12900 # {
12901 # &quot;key&quot;: &quot;scope&quot;,
12902 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
12903 # }
12904 {
12905 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
12906 # returned. For example, for warnings where there are no results in a list
12907 # request for a particular zone, this key might be scope and
12908 # the key value might be the zone name. Other examples might be a key
12909 # indicating a deprecated resource and a suggested replacement, or a
12910 # warning about invalid network settings (for example, if an instance
12911 # attempts to perform IP forwarding but is not enabled for IP forwarding).
12912 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
12913 },
12914 ],
12915 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
12916 },
12917 ],
12918 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
12919 # applicable when performing per-zone operations.
12920 }</pre>
12921 </div>
12922
12923 <div class="method">
12924 <code class="details" id="sendDiagnosticInterrupt">sendDiagnosticInterrupt(project, zone, instance, x__xgafv=None)</code>
12925 <pre>Sends diagnostic interrupt to the instance.
12926
12927 Args:
12928 project: string, Project ID for this request. (required)
12929 zone: string, The name of the zone for this request. (required)
12930 instance: string, Name of the instance scoping this request. (required)
12931 x__xgafv: string, V1 error format.
12932 Allowed values
12933 1 - v1 error format
12934 2 - v2 error format
12935 </pre>
12936 </div>
12937
12938 <div class="method">
12939 <code class="details" id="setDeletionProtection">setDeletionProtection(project, zone, resource, deletionProtection=None, requestId=None, x__xgafv=None)</code>
12940 <pre>Sets deletion protection on the instance.
12941
12942 Args:
12943 project: string, Project ID for this request. (required)
12944 zone: string, The name of the zone for this request. (required)
12945 resource: string, Name or id of the resource for this request. (required)
12946 deletionProtection: boolean, Whether the resource should be protected against deletion.
12947 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
12948 that if you must retry your request, the server will know to ignore the
12949 request if it has already been completed.
12950
12951 For example, consider a situation where you make an initial request and
12952 the request times out. If you make the request again with the same
12953 request ID, the server can check if original operation with the same
12954 request ID was received, and if so, will ignore the second request. This
12955 prevents clients from accidentally creating duplicate commitments.
12956
12957 The request ID must be
12958 a valid UUID with the exception that zero UUID is not supported
12959 (00000000-0000-0000-0000-000000000000).
12960 x__xgafv: string, V1 error format.
12961 Allowed values
12962 1 - v1 error format
12963 2 - v2 error format
12964
12965 Returns:
12966 An object of the form:
12967
12968 { # Represents an Operation resource.
12969 #
12970 # Google Compute Engine has three Operation resources:
12971 #
12972 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
12973 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
12974 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
12975 #
12976 # You can use an operation resource to manage asynchronous API requests.
12977 # For more information, readHandling
12978 # API responses.
12979 #
12980 # Operations can be global, regional or zonal.
12981 #
12982 # - For global operations, use the `globalOperations`
12983 # resource.
12984 # - For regional operations, use the
12985 # `regionOperations` resource.
12986 # - For zonal operations, use
12987 # the `zoneOperations` resource.
12988 #
12989 #
12990 #
12991 # For more information, read
12992 # Global, Regional, and Zonal Resources.
12993 #
12994 # Note that completed Operation resources have a limited
12995 # retention period.
12996 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
12997 # Not present otherwise.
12998 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
12999 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
13000 # set when the operation is created.
13001 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
13002 # text format.
13003 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
13004 # this field will be populated.
13005 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
13006 # operation.
13007 {
13008 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
13009 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
13010 # details. There is a set of defined message types to use for providing
13011 # details.The syntax depends on the error code. For example,
13012 # QuotaExceededInfo will have details when the error code is
13013 # QUOTA_EXCEEDED.
13014 {
13015 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
13016 #
13017 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
13018 # is not enabled:
13019 #
13020 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
13021 # &quot;domain&quot;: &quot;googleapis.com&quot;
13022 # &quot;metadata&quot;: {
13023 # &quot;resource&quot;: &quot;projects/123&quot;,
13024 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
13025 # }
13026 # }
13027 #
13028 # This response indicates that the pubsub.googleapis.com API is not enabled.
13029 #
13030 # Example of an error that is returned when attempting to create a Spanner
13031 # instance in a region that is out of stock:
13032 #
13033 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
13034 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
13035 # &quot;metadata&quot;: {
13036 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
13037 # }
13038 # }
13039 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
13040 # is typically the registered service name of the tool or product that
13041 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
13042 # generated by some common infrastructure, the error domain must be a
13043 # globally unique value that identifies the infrastructure. For Google API
13044 # infrastructure, the error domain is &quot;googleapis.com&quot;.
13045 &quot;metadatas&quot;: { # Additional structured details about this error.
13046 #
13047 # Keys must match a regular expression of `a-z+` but should
13048 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
13049 # length. When identifying the current value of an exceeded limit, the units
13050 # should be contained in the key, not the value. For example, rather than
13051 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
13052 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
13053 # instances that can be created in a single (batch) request.
13054 &quot;a_key&quot;: &quot;A String&quot;,
13055 },
13056 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
13057 # proximate cause of the error. Error reasons are unique within a particular
13058 # domain of errors. This should be at most 63 characters and match a
13059 # regular expression of `A-Z+[A-Z0-9]`, which represents
13060 # UPPER_SNAKE_CASE.
13061 },
13062 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
13063 #
13064 # For example, if a quota check failed with an error indicating the calling
13065 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
13066 # directly to the right place in the developer console to flip the bit.
13067 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
13068 { # Describes a URL link.
13069 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
13070 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
13071 },
13072 ],
13073 },
13074 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
13075 # which can be attached to an RPC error.
13076 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
13077 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
13078 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
13079 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
13080 },
13081 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
13082 &quot;dimensions&quot;: { # The map holding related quota dimensions.
13083 &quot;a_key&quot;: &quot;A String&quot;,
13084 },
13085 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
13086 # type or metric.
13087 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
13088 # or metric.
13089 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
13090 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
13091 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
13092 },
13093 },
13094 ],
13095 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
13096 # This property is optional.
13097 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
13098 },
13099 ],
13100 },
13101 &quot;getVersionOperationMetadata&quot;: {
13102 &quot;inlineSbomInfo&quot;: {
13103 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
13104 # appropriate identifiers.
13105 &quot;a_key&quot;: &quot;A String&quot;,
13106 },
13107 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
13108 # identifiers.
13109 &quot;a_key&quot;: &quot;A String&quot;,
13110 },
13111 },
13112 },
13113 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
13114 # message that was returned, such as `NOT FOUND`.
13115 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
13116 # status code that was returned. For example, a `404` means the
13117 # resource was not found.
13118 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
13119 # defined by the server.
13120 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
13121 # This value is inRFC3339
13122 # text format.
13123 &quot;instancesBulkInsertOperationMetadata&quot;: {
13124 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
13125 # Example key: zones/us-central1-a
13126 &quot;a_key&quot;: {
13127 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
13128 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
13129 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
13130 # error.
13131 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
13132 # if the flow is rolling forward or rolling back.
13133 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
13134 },
13135 },
13136 },
13137 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
13138 # Operation resources.
13139 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
13140 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
13141 # group of operations results from a `bulkInsert` API request.
13142 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
13143 # `update`, or `delete`, and so on.
13144 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
13145 # There is no requirement that this be linear or support any granularity of
13146 # operations. This should not be used to guess when the operation will be
13147 # complete. This number should monotonically increase as the operation
13148 # progresses.
13149 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
13150 # applicable when performing regional operations.
13151 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
13152 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
13153 # this field will contain information on all underlying zonal actions and
13154 # their state.
13155 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
13156 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
13157 # Example key: zones/us-central1-a
13158 &quot;a_key&quot;: {
13159 &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
13160 # populated.
13161 # different programming environments, including REST APIs and RPC APIs. It is
13162 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
13163 # three pieces of data: error code, error message, and error details.
13164 #
13165 # You can find out more about this error model and how to work with it in the
13166 # [API Design Guide](https://cloud.google.com/apis/design/errors).
13167 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
13168 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
13169 # message types for APIs to use.
13170 {
13171 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
13172 },
13173 ],
13174 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
13175 # user-facing error message should be localized and sent in the
13176 # google.rpc.Status.details field, or localized by the client.
13177 },
13178 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
13179 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
13180 },
13181 },
13182 },
13183 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
13184 # This value is inRFC3339
13185 # text format.
13186 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
13187 # following:
13188 # `PENDING`, `RUNNING`, or `DONE`.
13189 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
13190 # operation.
13191 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
13192 # of the target resource.
13193 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
13194 # operations related to creating a snapshot, this points to the disk
13195 # that the snapshot was created from.
13196 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
13197 # `[email protected]` or
13198 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
13199 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
13200 # operation, this field will be populated.
13201 {
13202 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
13203 # Engine returns NO_RESULTS_ON_PAGE if there
13204 # are no results in the response.
13205 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
13206 # value format. For example:
13207 #
13208 # &quot;data&quot;: [
13209 # {
13210 # &quot;key&quot;: &quot;scope&quot;,
13211 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
13212 # }
13213 {
13214 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
13215 # returned. For example, for warnings where there are no results in a list
13216 # request for a particular zone, this key might be scope and
13217 # the key value might be the zone name. Other examples might be a key
13218 # indicating a deprecated resource and a suggested replacement, or a
13219 # warning about invalid network settings (for example, if an instance
13220 # attempts to perform IP forwarding but is not enabled for IP forwarding).
13221 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
13222 },
13223 ],
13224 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
13225 },
13226 ],
13227 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
13228 # applicable when performing per-zone operations.
13229 }</pre>
13230 </div>
13231
13232 <div class="method">
13233 <code class="details" id="setDiskAutoDelete">setDiskAutoDelete(project, zone, instance, autoDelete, deviceName, requestId=None, x__xgafv=None)</code>
13234 <pre>Sets the auto-delete flag for a disk attached to an instance.
13235
13236 Args:
13237 project: string, Project ID for this request. (required)
13238 zone: string, The name of the zone for this request. (required)
13239 instance: string, The instance name for this request. (required)
13240 autoDelete: boolean, Whether to auto-delete the disk when the instance is deleted. (required)
13241 deviceName: string, The device name of the disk to modify. Make a get() request
13242 on the instance to view currently attached disks and device names. (required)
13243 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
13244 that if you must retry your request, the server will know to ignore the
13245 request if it has already been completed.
13246
13247 For example, consider a situation where you make an initial request and
13248 the request times out. If you make the request again with the same
13249 request ID, the server can check if original operation with the same
13250 request ID was received, and if so, will ignore the second request. This
13251 prevents clients from accidentally creating duplicate commitments.
13252
13253 The request ID must be
13254 a valid UUID with the exception that zero UUID is not supported
13255 (00000000-0000-0000-0000-000000000000).
13256 x__xgafv: string, V1 error format.
13257 Allowed values
13258 1 - v1 error format
13259 2 - v2 error format
13260
13261 Returns:
13262 An object of the form:
13263
13264 { # Represents an Operation resource.
13265 #
13266 # Google Compute Engine has three Operation resources:
13267 #
13268 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
13269 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
13270 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
13271 #
13272 # You can use an operation resource to manage asynchronous API requests.
13273 # For more information, readHandling
13274 # API responses.
13275 #
13276 # Operations can be global, regional or zonal.
13277 #
13278 # - For global operations, use the `globalOperations`
13279 # resource.
13280 # - For regional operations, use the
13281 # `regionOperations` resource.
13282 # - For zonal operations, use
13283 # the `zoneOperations` resource.
13284 #
13285 #
13286 #
13287 # For more information, read
13288 # Global, Regional, and Zonal Resources.
13289 #
13290 # Note that completed Operation resources have a limited
13291 # retention period.
13292 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
13293 # Not present otherwise.
13294 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
13295 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
13296 # set when the operation is created.
13297 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
13298 # text format.
13299 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
13300 # this field will be populated.
13301 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
13302 # operation.
13303 {
13304 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
13305 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
13306 # details. There is a set of defined message types to use for providing
13307 # details.The syntax depends on the error code. For example,
13308 # QuotaExceededInfo will have details when the error code is
13309 # QUOTA_EXCEEDED.
13310 {
13311 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
13312 #
13313 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
13314 # is not enabled:
13315 #
13316 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
13317 # &quot;domain&quot;: &quot;googleapis.com&quot;
13318 # &quot;metadata&quot;: {
13319 # &quot;resource&quot;: &quot;projects/123&quot;,
13320 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
13321 # }
13322 # }
13323 #
13324 # This response indicates that the pubsub.googleapis.com API is not enabled.
13325 #
13326 # Example of an error that is returned when attempting to create a Spanner
13327 # instance in a region that is out of stock:
13328 #
13329 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
13330 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
13331 # &quot;metadata&quot;: {
13332 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
13333 # }
13334 # }
13335 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
13336 # is typically the registered service name of the tool or product that
13337 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
13338 # generated by some common infrastructure, the error domain must be a
13339 # globally unique value that identifies the infrastructure. For Google API
13340 # infrastructure, the error domain is &quot;googleapis.com&quot;.
13341 &quot;metadatas&quot;: { # Additional structured details about this error.
13342 #
13343 # Keys must match a regular expression of `a-z+` but should
13344 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
13345 # length. When identifying the current value of an exceeded limit, the units
13346 # should be contained in the key, not the value. For example, rather than
13347 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
13348 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
13349 # instances that can be created in a single (batch) request.
13350 &quot;a_key&quot;: &quot;A String&quot;,
13351 },
13352 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
13353 # proximate cause of the error. Error reasons are unique within a particular
13354 # domain of errors. This should be at most 63 characters and match a
13355 # regular expression of `A-Z+[A-Z0-9]`, which represents
13356 # UPPER_SNAKE_CASE.
13357 },
13358 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
13359 #
13360 # For example, if a quota check failed with an error indicating the calling
13361 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
13362 # directly to the right place in the developer console to flip the bit.
13363 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
13364 { # Describes a URL link.
13365 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
13366 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
13367 },
13368 ],
13369 },
13370 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
13371 # which can be attached to an RPC error.
13372 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
13373 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
13374 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
13375 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
13376 },
13377 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
13378 &quot;dimensions&quot;: { # The map holding related quota dimensions.
13379 &quot;a_key&quot;: &quot;A String&quot;,
13380 },
13381 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
13382 # type or metric.
13383 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
13384 # or metric.
13385 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
13386 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
13387 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
13388 },
13389 },
13390 ],
13391 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
13392 # This property is optional.
13393 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
13394 },
13395 ],
13396 },
13397 &quot;getVersionOperationMetadata&quot;: {
13398 &quot;inlineSbomInfo&quot;: {
13399 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
13400 # appropriate identifiers.
13401 &quot;a_key&quot;: &quot;A String&quot;,
13402 },
13403 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
13404 # identifiers.
13405 &quot;a_key&quot;: &quot;A String&quot;,
13406 },
13407 },
13408 },
13409 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
13410 # message that was returned, such as `NOT FOUND`.
13411 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
13412 # status code that was returned. For example, a `404` means the
13413 # resource was not found.
13414 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
13415 # defined by the server.
13416 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
13417 # This value is inRFC3339
13418 # text format.
13419 &quot;instancesBulkInsertOperationMetadata&quot;: {
13420 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
13421 # Example key: zones/us-central1-a
13422 &quot;a_key&quot;: {
13423 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
13424 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
13425 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
13426 # error.
13427 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
13428 # if the flow is rolling forward or rolling back.
13429 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
13430 },
13431 },
13432 },
13433 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
13434 # Operation resources.
13435 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
13436 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
13437 # group of operations results from a `bulkInsert` API request.
13438 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
13439 # `update`, or `delete`, and so on.
13440 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
13441 # There is no requirement that this be linear or support any granularity of
13442 # operations. This should not be used to guess when the operation will be
13443 # complete. This number should monotonically increase as the operation
13444 # progresses.
13445 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
13446 # applicable when performing regional operations.
13447 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
13448 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
13449 # this field will contain information on all underlying zonal actions and
13450 # their state.
13451 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
13452 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
13453 # Example key: zones/us-central1-a
13454 &quot;a_key&quot;: {
13455 &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
13456 # populated.
13457 # different programming environments, including REST APIs and RPC APIs. It is
13458 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
13459 # three pieces of data: error code, error message, and error details.
13460 #
13461 # You can find out more about this error model and how to work with it in the
13462 # [API Design Guide](https://cloud.google.com/apis/design/errors).
13463 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
13464 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
13465 # message types for APIs to use.
13466 {
13467 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
13468 },
13469 ],
13470 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
13471 # user-facing error message should be localized and sent in the
13472 # google.rpc.Status.details field, or localized by the client.
13473 },
13474 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
13475 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
13476 },
13477 },
13478 },
13479 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
13480 # This value is inRFC3339
13481 # text format.
13482 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
13483 # following:
13484 # `PENDING`, `RUNNING`, or `DONE`.
13485 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
13486 # operation.
13487 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
13488 # of the target resource.
13489 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
13490 # operations related to creating a snapshot, this points to the disk
13491 # that the snapshot was created from.
13492 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
13493 # `[email protected]` or
13494 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
13495 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
13496 # operation, this field will be populated.
13497 {
13498 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
13499 # Engine returns NO_RESULTS_ON_PAGE if there
13500 # are no results in the response.
13501 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
13502 # value format. For example:
13503 #
13504 # &quot;data&quot;: [
13505 # {
13506 # &quot;key&quot;: &quot;scope&quot;,
13507 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
13508 # }
13509 {
13510 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
13511 # returned. For example, for warnings where there are no results in a list
13512 # request for a particular zone, this key might be scope and
13513 # the key value might be the zone name. Other examples might be a key
13514 # indicating a deprecated resource and a suggested replacement, or a
13515 # warning about invalid network settings (for example, if an instance
13516 # attempts to perform IP forwarding but is not enabled for IP forwarding).
13517 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
13518 },
13519 ],
13520 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
13521 },
13522 ],
13523 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
13524 # applicable when performing per-zone operations.
13525 }</pre>
13526 </div>
13527
13528 <div class="method">
13529 <code class="details" id="setIamPolicy">setIamPolicy(project, zone, resource, body=None, x__xgafv=None)</code>
13530 <pre>Sets the access control policy on the specified resource.
13531 Replaces any existing policy.
13532
13533 Args:
13534 project: string, Project ID for this request. (required)
13535 zone: string, The name of the zone for this request. (required)
13536 resource: string, Name or id of the resource for this request. (required)
13537 body: object, The request body.
13538 The object takes the form of:
13539
13540 {
13541 &quot;bindings&quot;: [ # Flatten Policy to create a backwacd compatible wire-format.
13542 # Deprecated. Use &#x27;policy&#x27; to specify bindings.
13543 { # Associates `members`, or principals, with a `role`.
13544 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
13545 #
13546 # If the condition evaluates to `true`, then this binding applies to the
13547 # current request.
13548 #
13549 # If the condition evaluates to `false`, then this binding does not apply to
13550 # the current request. However, a different role binding might grant the same
13551 # role to one or more of the principals in this binding.
13552 #
13553 # To learn which resources support conditions in their IAM policies, see the
13554 # [IAM
13555 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
13556 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
13557 # are documented at https://github.com/google/cel-spec.
13558 #
13559 # Example (Comparison):
13560 #
13561 # title: &quot;Summary size limit&quot;
13562 # description: &quot;Determines if a summary is less than 100 chars&quot;
13563 # expression: &quot;document.summary.size() &lt; 100&quot;
13564 #
13565 # Example (Equality):
13566 #
13567 # title: &quot;Requestor is owner&quot;
13568 # description: &quot;Determines if requestor is the document owner&quot;
13569 # expression: &quot;document.owner == request.auth.claims.email&quot;
13570 #
13571 # Example (Logic):
13572 #
13573 # title: &quot;Public documents&quot;
13574 # description: &quot;Determine whether the document should be publicly visible&quot;
13575 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
13576 #
13577 # Example (Data Manipulation):
13578 #
13579 # title: &quot;Notification string&quot;
13580 # description: &quot;Create a notification string with a timestamp.&quot;
13581 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
13582 #
13583 # The exact variables and functions that may be referenced within an expression
13584 # are determined by the service that evaluates it. See the service
13585 # documentation for additional information.
13586 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
13587 # describes the expression, e.g. when hovered over it in a UI.
13588 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
13589 # syntax.
13590 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
13591 # reporting, e.g. a file name and a position in the file.
13592 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
13593 # its purpose. This can be used e.g. in UIs which allow to enter the
13594 # expression.
13595 },
13596 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
13597 # `members` can have the following values:
13598 #
13599 # * `allUsers`: A special identifier that represents anyone who is
13600 # on the internet; with or without a Google account.
13601 #
13602 # * `allAuthenticatedUsers`: A special identifier that represents anyone
13603 # who is authenticated with a Google account or a service account.
13604 # Does not include identities that come from external identity providers
13605 # (IdPs) through identity federation.
13606 #
13607 # * `user:{emailid}`: An email address that represents a specific Google
13608 # account. For example, `[email protected]` .
13609 #
13610 #
13611 # * `serviceAccount:{emailid}`: An email address that represents a Google
13612 # service account. For example,
13613 # `[email protected]`.
13614 #
13615 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
13616 # identifier for a
13617 # [Kubernetes service
13618 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
13619 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
13620 #
13621 # * `group:{emailid}`: An email address that represents a Google group.
13622 # For example, `[email protected]`.
13623 #
13624 #
13625 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
13626 # users of that domain. For example, `google.com` or `example.com`.
13627 #
13628 #
13629 #
13630 #
13631 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
13632 # A single identity in a workforce identity pool.
13633 #
13634 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
13635 # All workforce identities in a group.
13636 #
13637 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
13638 # All workforce identities with a specific attribute value.
13639 #
13640 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
13641 # All identities in a workforce identity pool.
13642 #
13643 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
13644 # A single identity in a workload identity pool.
13645 #
13646 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
13647 # A workload identity pool group.
13648 #
13649 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
13650 # All identities in a workload identity pool with a certain attribute.
13651 #
13652 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
13653 # All identities in a workload identity pool.
13654 #
13655 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
13656 # identifier) representing a user that has been recently deleted. For
13657 # example, `[email protected]?uid=123456789012345678901`. If the user is
13658 # recovered, this value reverts to `user:{emailid}` and the recovered user
13659 # retains the role in the binding.
13660 #
13661 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
13662 # unique identifier) representing a service account that has been recently
13663 # deleted. For example,
13664 # `[email protected]?uid=123456789012345678901`.
13665 # If the service account is undeleted, this value reverts to
13666 # `serviceAccount:{emailid}` and the undeleted service account retains the
13667 # role in the binding.
13668 #
13669 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
13670 # identifier) representing a Google group that has been recently
13671 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
13672 # the group is recovered, this value reverts to `group:{emailid}` and the
13673 # recovered group retains the role in the binding.
13674 #
13675 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
13676 # Deleted single identity in a workforce identity pool. For example,
13677 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
13678 &quot;A String&quot;,
13679 ],
13680 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
13681 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
13682 #
13683 # For an overview of the IAM roles and permissions, see the
13684 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
13685 # a list of the available pre-defined roles, see
13686 # [here](https://cloud.google.com/iam/docs/understanding-roles).
13687 },
13688 ],
13689 &quot;etag&quot;: &quot;A String&quot;, # Flatten Policy to create a backward compatible wire-format.
13690 # Deprecated. Use &#x27;policy&#x27; to specify the etag.
13691 &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
13692 # the policy is limited to a few 10s of KB. An empty policy is in general a
13693 # valid policy but certain services (like Projects) might reject them.
13694 # controls for Google Cloud resources.
13695 #
13696 #
13697 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
13698 # `members`, or principals, to a single `role`. Principals can be user
13699 # accounts, service accounts, Google groups, and domains (such as G Suite). A
13700 # `role` is a named list of permissions; each `role` can be an IAM predefined
13701 # role or a user-created custom role.
13702 #
13703 # For some types of Google Cloud resources, a `binding` can also specify a
13704 # `condition`, which is a logical expression that allows access to a resource
13705 # only if the expression evaluates to `true`. A condition can add constraints
13706 # based on attributes of the request, the resource, or both. To learn which
13707 # resources support conditions in their IAM policies, see the
13708 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
13709 #
13710 # **JSON example:**
13711 #
13712 # ```
13713 # {
13714 # &quot;bindings&quot;: [
13715 # {
13716 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
13717 # &quot;members&quot;: [
13718 # &quot;user:[email protected]&quot;,
13719 # &quot;group:[email protected]&quot;,
13720 # &quot;domain:google.com&quot;,
13721 # &quot;serviceAccount:[email protected]&quot;
13722 # ]
13723 # },
13724 # {
13725 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
13726 # &quot;members&quot;: [
13727 # &quot;user:[email protected]&quot;
13728 # ],
13729 # &quot;condition&quot;: {
13730 # &quot;title&quot;: &quot;expirable access&quot;,
13731 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
13732 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
13733 # }
13734 # }
13735 # ],
13736 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
13737 # &quot;version&quot;: 3
13738 # }
13739 # ```
13740 #
13741 # **YAML example:**
13742 #
13743 # ```
13744 # bindings:
13745 # - members:
13746 # - user:[email protected]
13747 # - group:[email protected]
13748 # - domain:google.com
13749 # - serviceAccount:[email protected]
13750 # role: roles/resourcemanager.organizationAdmin
13751 # - members:
13752 # - user:[email protected]
13753 # role: roles/resourcemanager.organizationViewer
13754 # condition:
13755 # title: expirable access
13756 # description: Does not grant access after Sep 2020
13757 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
13758 # etag: BwWWja0YfJA=
13759 # version: 3
13760 # ```
13761 #
13762 # For a description of IAM and its features, see the
13763 # [IAM documentation](https://cloud.google.com/iam/docs/).
13764 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
13765 { # Specifies the audit configuration for a service.
13766 # The configuration determines which permission types are logged, and what
13767 # identities, if any, are exempted from logging.
13768 # An AuditConfig must have one or more AuditLogConfigs.
13769 #
13770 # If there are AuditConfigs for both `allServices` and a specific service,
13771 # the union of the two AuditConfigs is used for that service: the log_types
13772 # specified in each AuditConfig are enabled, and the exempted_members in each
13773 # AuditLogConfig are exempted.
13774 #
13775 # Example Policy with multiple AuditConfigs:
13776 #
13777 # {
13778 # &quot;audit_configs&quot;: [
13779 # {
13780 # &quot;service&quot;: &quot;allServices&quot;,
13781 # &quot;audit_log_configs&quot;: [
13782 # {
13783 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
13784 # &quot;exempted_members&quot;: [
13785 # &quot;user:[email protected]&quot;
13786 # ]
13787 # },
13788 # {
13789 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
13790 # },
13791 # {
13792 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
13793 # }
13794 # ]
13795 # },
13796 # {
13797 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
13798 # &quot;audit_log_configs&quot;: [
13799 # {
13800 # &quot;log_type&quot;: &quot;DATA_READ&quot;
13801 # },
13802 # {
13803 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
13804 # &quot;exempted_members&quot;: [
13805 # &quot;user:[email protected]&quot;
13806 # ]
13807 # }
13808 # ]
13809 # }
13810 # ]
13811 # }
13812 #
13813 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
13814 # logging. It also exempts `[email protected]` from DATA_READ logging, and
13815 # `[email protected]` from DATA_WRITE logging.
13816 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
13817 { # Provides the configuration for logging a type of permissions.
13818 # Example:
13819 #
13820 # {
13821 # &quot;audit_log_configs&quot;: [
13822 # {
13823 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
13824 # &quot;exempted_members&quot;: [
13825 # &quot;user:[email protected]&quot;
13826 # ]
13827 # },
13828 # {
13829 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
13830 # }
13831 # ]
13832 # }
13833 #
13834 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
13835 # [email protected] from DATA_READ logging.
13836 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
13837 # permission.
13838 # Follows the same format of Binding.members.
13839 &quot;A String&quot;,
13840 ],
13841 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
13842 },
13843 ],
13844 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
13845 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
13846 # `allServices` is a special value that covers all services.
13847 },
13848 ],
13849 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
13850 # may specify a `condition` that determines how and when the `bindings` are
13851 # applied. Each of the `bindings` must contain at least one principal.
13852 #
13853 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
13854 # of these principals can be Google groups. Each occurrence of a principal
13855 # counts towards these limits. For example, if the `bindings` grant 50
13856 # different roles to `user:[email protected]`, and not to any other
13857 # principal, then you can add another 1,450 principals to the `bindings` in
13858 # the `Policy`.
13859 { # Associates `members`, or principals, with a `role`.
13860 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
13861 #
13862 # If the condition evaluates to `true`, then this binding applies to the
13863 # current request.
13864 #
13865 # If the condition evaluates to `false`, then this binding does not apply to
13866 # the current request. However, a different role binding might grant the same
13867 # role to one or more of the principals in this binding.
13868 #
13869 # To learn which resources support conditions in their IAM policies, see the
13870 # [IAM
13871 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
13872 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
13873 # are documented at https://github.com/google/cel-spec.
13874 #
13875 # Example (Comparison):
13876 #
13877 # title: &quot;Summary size limit&quot;
13878 # description: &quot;Determines if a summary is less than 100 chars&quot;
13879 # expression: &quot;document.summary.size() &lt; 100&quot;
13880 #
13881 # Example (Equality):
13882 #
13883 # title: &quot;Requestor is owner&quot;
13884 # description: &quot;Determines if requestor is the document owner&quot;
13885 # expression: &quot;document.owner == request.auth.claims.email&quot;
13886 #
13887 # Example (Logic):
13888 #
13889 # title: &quot;Public documents&quot;
13890 # description: &quot;Determine whether the document should be publicly visible&quot;
13891 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
13892 #
13893 # Example (Data Manipulation):
13894 #
13895 # title: &quot;Notification string&quot;
13896 # description: &quot;Create a notification string with a timestamp.&quot;
13897 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
13898 #
13899 # The exact variables and functions that may be referenced within an expression
13900 # are determined by the service that evaluates it. See the service
13901 # documentation for additional information.
13902 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
13903 # describes the expression, e.g. when hovered over it in a UI.
13904 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
13905 # syntax.
13906 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
13907 # reporting, e.g. a file name and a position in the file.
13908 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
13909 # its purpose. This can be used e.g. in UIs which allow to enter the
13910 # expression.
13911 },
13912 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
13913 # `members` can have the following values:
13914 #
13915 # * `allUsers`: A special identifier that represents anyone who is
13916 # on the internet; with or without a Google account.
13917 #
13918 # * `allAuthenticatedUsers`: A special identifier that represents anyone
13919 # who is authenticated with a Google account or a service account.
13920 # Does not include identities that come from external identity providers
13921 # (IdPs) through identity federation.
13922 #
13923 # * `user:{emailid}`: An email address that represents a specific Google
13924 # account. For example, `[email protected]` .
13925 #
13926 #
13927 # * `serviceAccount:{emailid}`: An email address that represents a Google
13928 # service account. For example,
13929 # `[email protected]`.
13930 #
13931 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
13932 # identifier for a
13933 # [Kubernetes service
13934 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
13935 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
13936 #
13937 # * `group:{emailid}`: An email address that represents a Google group.
13938 # For example, `[email protected]`.
13939 #
13940 #
13941 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
13942 # users of that domain. For example, `google.com` or `example.com`.
13943 #
13944 #
13945 #
13946 #
13947 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
13948 # A single identity in a workforce identity pool.
13949 #
13950 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
13951 # All workforce identities in a group.
13952 #
13953 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
13954 # All workforce identities with a specific attribute value.
13955 #
13956 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
13957 # All identities in a workforce identity pool.
13958 #
13959 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
13960 # A single identity in a workload identity pool.
13961 #
13962 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
13963 # A workload identity pool group.
13964 #
13965 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
13966 # All identities in a workload identity pool with a certain attribute.
13967 #
13968 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
13969 # All identities in a workload identity pool.
13970 #
13971 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
13972 # identifier) representing a user that has been recently deleted. For
13973 # example, `[email protected]?uid=123456789012345678901`. If the user is
13974 # recovered, this value reverts to `user:{emailid}` and the recovered user
13975 # retains the role in the binding.
13976 #
13977 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
13978 # unique identifier) representing a service account that has been recently
13979 # deleted. For example,
13980 # `[email protected]?uid=123456789012345678901`.
13981 # If the service account is undeleted, this value reverts to
13982 # `serviceAccount:{emailid}` and the undeleted service account retains the
13983 # role in the binding.
13984 #
13985 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
13986 # identifier) representing a Google group that has been recently
13987 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
13988 # the group is recovered, this value reverts to `group:{emailid}` and the
13989 # recovered group retains the role in the binding.
13990 #
13991 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
13992 # Deleted single identity in a workforce identity pool. For example,
13993 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
13994 &quot;A String&quot;,
13995 ],
13996 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
13997 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
13998 #
13999 # For an overview of the IAM roles and permissions, see the
14000 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
14001 # a list of the available pre-defined roles, see
14002 # [here](https://cloud.google.com/iam/docs/understanding-roles).
14003 },
14004 ],
14005 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
14006 # prevent simultaneous updates of a policy from overwriting each other.
14007 # It is strongly suggested that systems make use of the `etag` in the
14008 # read-modify-write cycle to perform policy updates in order to avoid race
14009 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
14010 # systems are expected to put that etag in the request to `setIamPolicy` to
14011 # ensure that their change will be applied to the same version of the policy.
14012 #
14013 # **Important:** If you use IAM Conditions, you must include the `etag` field
14014 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
14015 # you to overwrite a version `3` policy with a version `1` policy, and all of
14016 # the conditions in the version `3` policy are lost.
14017 &quot;version&quot;: 42, # Specifies the format of the policy.
14018 #
14019 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
14020 # are rejected.
14021 #
14022 # Any operation that affects conditional role bindings must specify version
14023 # `3`. This requirement applies to the following operations:
14024 #
14025 # * Getting a policy that includes a conditional role binding
14026 # * Adding a conditional role binding to a policy
14027 # * Changing a conditional role binding in a policy
14028 # * Removing any role binding, with or without a condition, from a policy
14029 # that includes conditions
14030 #
14031 # **Important:** If you use IAM Conditions, you must include the `etag` field
14032 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
14033 # you to overwrite a version `3` policy with a version `1` policy, and all of
14034 # the conditions in the version `3` policy are lost.
14035 #
14036 # If a policy does not include any conditions, operations on that policy may
14037 # specify any valid version or leave the field unset.
14038 #
14039 # To learn which resources support conditions in their IAM policies, see the
14040 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
14041 },
14042 }
14043
14044 x__xgafv: string, V1 error format.
14045 Allowed values
14046 1 - v1 error format
14047 2 - v2 error format
14048
14049 Returns:
14050 An object of the form:
14051
14052 { # An Identity and Access Management (IAM) policy, which specifies access
14053 # controls for Google Cloud resources.
14054 #
14055 #
14056 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
14057 # `members`, or principals, to a single `role`. Principals can be user
14058 # accounts, service accounts, Google groups, and domains (such as G Suite). A
14059 # `role` is a named list of permissions; each `role` can be an IAM predefined
14060 # role or a user-created custom role.
14061 #
14062 # For some types of Google Cloud resources, a `binding` can also specify a
14063 # `condition`, which is a logical expression that allows access to a resource
14064 # only if the expression evaluates to `true`. A condition can add constraints
14065 # based on attributes of the request, the resource, or both. To learn which
14066 # resources support conditions in their IAM policies, see the
14067 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
14068 #
14069 # **JSON example:**
14070 #
14071 # ```
14072 # {
14073 # &quot;bindings&quot;: [
14074 # {
14075 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
14076 # &quot;members&quot;: [
14077 # &quot;user:[email protected]&quot;,
14078 # &quot;group:[email protected]&quot;,
14079 # &quot;domain:google.com&quot;,
14080 # &quot;serviceAccount:[email protected]&quot;
14081 # ]
14082 # },
14083 # {
14084 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
14085 # &quot;members&quot;: [
14086 # &quot;user:[email protected]&quot;
14087 # ],
14088 # &quot;condition&quot;: {
14089 # &quot;title&quot;: &quot;expirable access&quot;,
14090 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
14091 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
14092 # }
14093 # }
14094 # ],
14095 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
14096 # &quot;version&quot;: 3
14097 # }
14098 # ```
14099 #
14100 # **YAML example:**
14101 #
14102 # ```
14103 # bindings:
14104 # - members:
14105 # - user:[email protected]
14106 # - group:[email protected]
14107 # - domain:google.com
14108 # - serviceAccount:[email protected]
14109 # role: roles/resourcemanager.organizationAdmin
14110 # - members:
14111 # - user:[email protected]
14112 # role: roles/resourcemanager.organizationViewer
14113 # condition:
14114 # title: expirable access
14115 # description: Does not grant access after Sep 2020
14116 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
14117 # etag: BwWWja0YfJA=
14118 # version: 3
14119 # ```
14120 #
14121 # For a description of IAM and its features, see the
14122 # [IAM documentation](https://cloud.google.com/iam/docs/).
14123 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
14124 { # Specifies the audit configuration for a service.
14125 # The configuration determines which permission types are logged, and what
14126 # identities, if any, are exempted from logging.
14127 # An AuditConfig must have one or more AuditLogConfigs.
14128 #
14129 # If there are AuditConfigs for both `allServices` and a specific service,
14130 # the union of the two AuditConfigs is used for that service: the log_types
14131 # specified in each AuditConfig are enabled, and the exempted_members in each
14132 # AuditLogConfig are exempted.
14133 #
14134 # Example Policy with multiple AuditConfigs:
14135 #
14136 # {
14137 # &quot;audit_configs&quot;: [
14138 # {
14139 # &quot;service&quot;: &quot;allServices&quot;,
14140 # &quot;audit_log_configs&quot;: [
14141 # {
14142 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
14143 # &quot;exempted_members&quot;: [
14144 # &quot;user:[email protected]&quot;
14145 # ]
14146 # },
14147 # {
14148 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
14149 # },
14150 # {
14151 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
14152 # }
14153 # ]
14154 # },
14155 # {
14156 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
14157 # &quot;audit_log_configs&quot;: [
14158 # {
14159 # &quot;log_type&quot;: &quot;DATA_READ&quot;
14160 # },
14161 # {
14162 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
14163 # &quot;exempted_members&quot;: [
14164 # &quot;user:[email protected]&quot;
14165 # ]
14166 # }
14167 # ]
14168 # }
14169 # ]
14170 # }
14171 #
14172 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
14173 # logging. It also exempts `[email protected]` from DATA_READ logging, and
14174 # `[email protected]` from DATA_WRITE logging.
14175 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
14176 { # Provides the configuration for logging a type of permissions.
14177 # Example:
14178 #
14179 # {
14180 # &quot;audit_log_configs&quot;: [
14181 # {
14182 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
14183 # &quot;exempted_members&quot;: [
14184 # &quot;user:[email protected]&quot;
14185 # ]
14186 # },
14187 # {
14188 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
14189 # }
14190 # ]
14191 # }
14192 #
14193 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
14194 # [email protected] from DATA_READ logging.
14195 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
14196 # permission.
14197 # Follows the same format of Binding.members.
14198 &quot;A String&quot;,
14199 ],
14200 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
14201 },
14202 ],
14203 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
14204 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
14205 # `allServices` is a special value that covers all services.
14206 },
14207 ],
14208 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
14209 # may specify a `condition` that determines how and when the `bindings` are
14210 # applied. Each of the `bindings` must contain at least one principal.
14211 #
14212 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
14213 # of these principals can be Google groups. Each occurrence of a principal
14214 # counts towards these limits. For example, if the `bindings` grant 50
14215 # different roles to `user:[email protected]`, and not to any other
14216 # principal, then you can add another 1,450 principals to the `bindings` in
14217 # the `Policy`.
14218 { # Associates `members`, or principals, with a `role`.
14219 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
14220 #
14221 # If the condition evaluates to `true`, then this binding applies to the
14222 # current request.
14223 #
14224 # If the condition evaluates to `false`, then this binding does not apply to
14225 # the current request. However, a different role binding might grant the same
14226 # role to one or more of the principals in this binding.
14227 #
14228 # To learn which resources support conditions in their IAM policies, see the
14229 # [IAM
14230 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
14231 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
14232 # are documented at https://github.com/google/cel-spec.
14233 #
14234 # Example (Comparison):
14235 #
14236 # title: &quot;Summary size limit&quot;
14237 # description: &quot;Determines if a summary is less than 100 chars&quot;
14238 # expression: &quot;document.summary.size() &lt; 100&quot;
14239 #
14240 # Example (Equality):
14241 #
14242 # title: &quot;Requestor is owner&quot;
14243 # description: &quot;Determines if requestor is the document owner&quot;
14244 # expression: &quot;document.owner == request.auth.claims.email&quot;
14245 #
14246 # Example (Logic):
14247 #
14248 # title: &quot;Public documents&quot;
14249 # description: &quot;Determine whether the document should be publicly visible&quot;
14250 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
14251 #
14252 # Example (Data Manipulation):
14253 #
14254 # title: &quot;Notification string&quot;
14255 # description: &quot;Create a notification string with a timestamp.&quot;
14256 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
14257 #
14258 # The exact variables and functions that may be referenced within an expression
14259 # are determined by the service that evaluates it. See the service
14260 # documentation for additional information.
14261 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
14262 # describes the expression, e.g. when hovered over it in a UI.
14263 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
14264 # syntax.
14265 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
14266 # reporting, e.g. a file name and a position in the file.
14267 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
14268 # its purpose. This can be used e.g. in UIs which allow to enter the
14269 # expression.
14270 },
14271 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
14272 # `members` can have the following values:
14273 #
14274 # * `allUsers`: A special identifier that represents anyone who is
14275 # on the internet; with or without a Google account.
14276 #
14277 # * `allAuthenticatedUsers`: A special identifier that represents anyone
14278 # who is authenticated with a Google account or a service account.
14279 # Does not include identities that come from external identity providers
14280 # (IdPs) through identity federation.
14281 #
14282 # * `user:{emailid}`: An email address that represents a specific Google
14283 # account. For example, `[email protected]` .
14284 #
14285 #
14286 # * `serviceAccount:{emailid}`: An email address that represents a Google
14287 # service account. For example,
14288 # `[email protected]`.
14289 #
14290 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
14291 # identifier for a
14292 # [Kubernetes service
14293 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
14294 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
14295 #
14296 # * `group:{emailid}`: An email address that represents a Google group.
14297 # For example, `[email protected]`.
14298 #
14299 #
14300 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
14301 # users of that domain. For example, `google.com` or `example.com`.
14302 #
14303 #
14304 #
14305 #
14306 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
14307 # A single identity in a workforce identity pool.
14308 #
14309 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
14310 # All workforce identities in a group.
14311 #
14312 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
14313 # All workforce identities with a specific attribute value.
14314 #
14315 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
14316 # All identities in a workforce identity pool.
14317 #
14318 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
14319 # A single identity in a workload identity pool.
14320 #
14321 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
14322 # A workload identity pool group.
14323 #
14324 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
14325 # All identities in a workload identity pool with a certain attribute.
14326 #
14327 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
14328 # All identities in a workload identity pool.
14329 #
14330 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
14331 # identifier) representing a user that has been recently deleted. For
14332 # example, `[email protected]?uid=123456789012345678901`. If the user is
14333 # recovered, this value reverts to `user:{emailid}` and the recovered user
14334 # retains the role in the binding.
14335 #
14336 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
14337 # unique identifier) representing a service account that has been recently
14338 # deleted. For example,
14339 # `[email protected]?uid=123456789012345678901`.
14340 # If the service account is undeleted, this value reverts to
14341 # `serviceAccount:{emailid}` and the undeleted service account retains the
14342 # role in the binding.
14343 #
14344 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
14345 # identifier) representing a Google group that has been recently
14346 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
14347 # the group is recovered, this value reverts to `group:{emailid}` and the
14348 # recovered group retains the role in the binding.
14349 #
14350 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
14351 # Deleted single identity in a workforce identity pool. For example,
14352 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
14353 &quot;A String&quot;,
14354 ],
14355 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
14356 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
14357 #
14358 # For an overview of the IAM roles and permissions, see the
14359 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
14360 # a list of the available pre-defined roles, see
14361 # [here](https://cloud.google.com/iam/docs/understanding-roles).
14362 },
14363 ],
14364 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
14365 # prevent simultaneous updates of a policy from overwriting each other.
14366 # It is strongly suggested that systems make use of the `etag` in the
14367 # read-modify-write cycle to perform policy updates in order to avoid race
14368 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
14369 # systems are expected to put that etag in the request to `setIamPolicy` to
14370 # ensure that their change will be applied to the same version of the policy.
14371 #
14372 # **Important:** If you use IAM Conditions, you must include the `etag` field
14373 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
14374 # you to overwrite a version `3` policy with a version `1` policy, and all of
14375 # the conditions in the version `3` policy are lost.
14376 &quot;version&quot;: 42, # Specifies the format of the policy.
14377 #
14378 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
14379 # are rejected.
14380 #
14381 # Any operation that affects conditional role bindings must specify version
14382 # `3`. This requirement applies to the following operations:
14383 #
14384 # * Getting a policy that includes a conditional role binding
14385 # * Adding a conditional role binding to a policy
14386 # * Changing a conditional role binding in a policy
14387 # * Removing any role binding, with or without a condition, from a policy
14388 # that includes conditions
14389 #
14390 # **Important:** If you use IAM Conditions, you must include the `etag` field
14391 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
14392 # you to overwrite a version `3` policy with a version `1` policy, and all of
14393 # the conditions in the version `3` policy are lost.
14394 #
14395 # If a policy does not include any conditions, operations on that policy may
14396 # specify any valid version or leave the field unset.
14397 #
14398 # To learn which resources support conditions in their IAM policies, see the
14399 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
14400 }</pre>
14401 </div>
14402
14403 <div class="method">
14404 <code class="details" id="setLabels">setLabels(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
14405 <pre>Sets labels on an instance. To learn more about labels, read theLabeling
14406 Resources documentation.
14407
14408 Args:
14409 project: string, Project ID for this request. (required)
14410 zone: string, The name of the zone for this request. (required)
14411 instance: string, Name of the instance scoping this request. (required)
14412 body: object, The request body.
14413 The object takes the form of:
14414
14415 {
14416 &quot;labelFingerprint&quot;: &quot;A String&quot;, # Fingerprint of the previous set of labels for this resource,
14417 # used to prevent conflicts. Provide the latest fingerprint value when making
14418 # a request to add or change labels.
14419 &quot;labels&quot;: {
14420 &quot;a_key&quot;: &quot;A String&quot;,
14421 },
14422 }
14423
14424 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
14425 that if you must retry your request, the server will know to ignore the
14426 request if it has already been completed.
14427
14428 For example, consider a situation where you make an initial request and
14429 the request times out. If you make the request again with the same
14430 request ID, the server can check if original operation with the same
14431 request ID was received, and if so, will ignore the second request. This
14432 prevents clients from accidentally creating duplicate commitments.
14433
14434 The request ID must be
14435 a valid UUID with the exception that zero UUID is not supported
14436 (00000000-0000-0000-0000-000000000000).
14437 x__xgafv: string, V1 error format.
14438 Allowed values
14439 1 - v1 error format
14440 2 - v2 error format
14441
14442 Returns:
14443 An object of the form:
14444
14445 { # Represents an Operation resource.
14446 #
14447 # Google Compute Engine has three Operation resources:
14448 #
14449 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
14450 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
14451 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
14452 #
14453 # You can use an operation resource to manage asynchronous API requests.
14454 # For more information, readHandling
14455 # API responses.
14456 #
14457 # Operations can be global, regional or zonal.
14458 #
14459 # - For global operations, use the `globalOperations`
14460 # resource.
14461 # - For regional operations, use the
14462 # `regionOperations` resource.
14463 # - For zonal operations, use
14464 # the `zoneOperations` resource.
14465 #
14466 #
14467 #
14468 # For more information, read
14469 # Global, Regional, and Zonal Resources.
14470 #
14471 # Note that completed Operation resources have a limited
14472 # retention period.
14473 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
14474 # Not present otherwise.
14475 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
14476 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
14477 # set when the operation is created.
14478 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
14479 # text format.
14480 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
14481 # this field will be populated.
14482 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
14483 # operation.
14484 {
14485 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
14486 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
14487 # details. There is a set of defined message types to use for providing
14488 # details.The syntax depends on the error code. For example,
14489 # QuotaExceededInfo will have details when the error code is
14490 # QUOTA_EXCEEDED.
14491 {
14492 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
14493 #
14494 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
14495 # is not enabled:
14496 #
14497 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
14498 # &quot;domain&quot;: &quot;googleapis.com&quot;
14499 # &quot;metadata&quot;: {
14500 # &quot;resource&quot;: &quot;projects/123&quot;,
14501 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
14502 # }
14503 # }
14504 #
14505 # This response indicates that the pubsub.googleapis.com API is not enabled.
14506 #
14507 # Example of an error that is returned when attempting to create a Spanner
14508 # instance in a region that is out of stock:
14509 #
14510 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
14511 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
14512 # &quot;metadata&quot;: {
14513 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
14514 # }
14515 # }
14516 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
14517 # is typically the registered service name of the tool or product that
14518 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
14519 # generated by some common infrastructure, the error domain must be a
14520 # globally unique value that identifies the infrastructure. For Google API
14521 # infrastructure, the error domain is &quot;googleapis.com&quot;.
14522 &quot;metadatas&quot;: { # Additional structured details about this error.
14523 #
14524 # Keys must match a regular expression of `a-z+` but should
14525 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
14526 # length. When identifying the current value of an exceeded limit, the units
14527 # should be contained in the key, not the value. For example, rather than
14528 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
14529 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
14530 # instances that can be created in a single (batch) request.
14531 &quot;a_key&quot;: &quot;A String&quot;,
14532 },
14533 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
14534 # proximate cause of the error. Error reasons are unique within a particular
14535 # domain of errors. This should be at most 63 characters and match a
14536 # regular expression of `A-Z+[A-Z0-9]`, which represents
14537 # UPPER_SNAKE_CASE.
14538 },
14539 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
14540 #
14541 # For example, if a quota check failed with an error indicating the calling
14542 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
14543 # directly to the right place in the developer console to flip the bit.
14544 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
14545 { # Describes a URL link.
14546 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
14547 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
14548 },
14549 ],
14550 },
14551 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
14552 # which can be attached to an RPC error.
14553 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
14554 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
14555 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
14556 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
14557 },
14558 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
14559 &quot;dimensions&quot;: { # The map holding related quota dimensions.
14560 &quot;a_key&quot;: &quot;A String&quot;,
14561 },
14562 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
14563 # type or metric.
14564 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
14565 # or metric.
14566 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
14567 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
14568 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
14569 },
14570 },
14571 ],
14572 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
14573 # This property is optional.
14574 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
14575 },
14576 ],
14577 },
14578 &quot;getVersionOperationMetadata&quot;: {
14579 &quot;inlineSbomInfo&quot;: {
14580 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
14581 # appropriate identifiers.
14582 &quot;a_key&quot;: &quot;A String&quot;,
14583 },
14584 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
14585 # identifiers.
14586 &quot;a_key&quot;: &quot;A String&quot;,
14587 },
14588 },
14589 },
14590 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
14591 # message that was returned, such as `NOT FOUND`.
14592 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
14593 # status code that was returned. For example, a `404` means the
14594 # resource was not found.
14595 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
14596 # defined by the server.
14597 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
14598 # This value is inRFC3339
14599 # text format.
14600 &quot;instancesBulkInsertOperationMetadata&quot;: {
14601 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
14602 # Example key: zones/us-central1-a
14603 &quot;a_key&quot;: {
14604 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
14605 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
14606 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
14607 # error.
14608 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
14609 # if the flow is rolling forward or rolling back.
14610 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
14611 },
14612 },
14613 },
14614 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
14615 # Operation resources.
14616 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
14617 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
14618 # group of operations results from a `bulkInsert` API request.
14619 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
14620 # `update`, or `delete`, and so on.
14621 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
14622 # There is no requirement that this be linear or support any granularity of
14623 # operations. This should not be used to guess when the operation will be
14624 # complete. This number should monotonically increase as the operation
14625 # progresses.
14626 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
14627 # applicable when performing regional operations.
14628 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
14629 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
14630 # this field will contain information on all underlying zonal actions and
14631 # their state.
14632 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
14633 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
14634 # Example key: zones/us-central1-a
14635 &quot;a_key&quot;: {
14636 &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
14637 # populated.
14638 # different programming environments, including REST APIs and RPC APIs. It is
14639 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
14640 # three pieces of data: error code, error message, and error details.
14641 #
14642 # You can find out more about this error model and how to work with it in the
14643 # [API Design Guide](https://cloud.google.com/apis/design/errors).
14644 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
14645 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
14646 # message types for APIs to use.
14647 {
14648 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
14649 },
14650 ],
14651 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
14652 # user-facing error message should be localized and sent in the
14653 # google.rpc.Status.details field, or localized by the client.
14654 },
14655 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
14656 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
14657 },
14658 },
14659 },
14660 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
14661 # This value is inRFC3339
14662 # text format.
14663 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
14664 # following:
14665 # `PENDING`, `RUNNING`, or `DONE`.
14666 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
14667 # operation.
14668 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
14669 # of the target resource.
14670 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
14671 # operations related to creating a snapshot, this points to the disk
14672 # that the snapshot was created from.
14673 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
14674 # `[email protected]` or
14675 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
14676 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
14677 # operation, this field will be populated.
14678 {
14679 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
14680 # Engine returns NO_RESULTS_ON_PAGE if there
14681 # are no results in the response.
14682 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
14683 # value format. For example:
14684 #
14685 # &quot;data&quot;: [
14686 # {
14687 # &quot;key&quot;: &quot;scope&quot;,
14688 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
14689 # }
14690 {
14691 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
14692 # returned. For example, for warnings where there are no results in a list
14693 # request for a particular zone, this key might be scope and
14694 # the key value might be the zone name. Other examples might be a key
14695 # indicating a deprecated resource and a suggested replacement, or a
14696 # warning about invalid network settings (for example, if an instance
14697 # attempts to perform IP forwarding but is not enabled for IP forwarding).
14698 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
14699 },
14700 ],
14701 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
14702 },
14703 ],
14704 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
14705 # applicable when performing per-zone operations.
14706 }</pre>
14707 </div>
14708
14709 <div class="method">
14710 <code class="details" id="setMachineResources">setMachineResources(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
14711 <pre>Changes the number and/or type of accelerator for a stopped instance to the
14712 values specified in the request.
14713
14714 Args:
14715 project: string, Project ID for this request. (required)
14716 zone: string, The name of the zone for this request. (required)
14717 instance: string, Name of the instance scoping this request. (required)
14718 body: object, The request body.
14719 The object takes the form of:
14720
14721 {
14722 &quot;guestAccelerators&quot;: [ # A list of the type and count of accelerator cards attached to the instance.
14723 { # A specification of the type and number of accelerator cards attached to the
14724 # instance.
14725 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
14726 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this
14727 # instance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100
14728 # If you are creating an instance template, specify only the
14729 # accelerator name.
14730 # See GPUs on Compute Engine
14731 # for a full list of accelerator types.
14732 },
14733 ],
14734 }
14735
14736 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
14737 that if you must retry your request, the server will know to ignore the
14738 request if it has already been completed.
14739
14740 For example, consider a situation where you make an initial request and
14741 the request times out. If you make the request again with the same
14742 request ID, the server can check if original operation with the same
14743 request ID was received, and if so, will ignore the second request. This
14744 prevents clients from accidentally creating duplicate commitments.
14745
14746 The request ID must be
14747 a valid UUID with the exception that zero UUID is not supported
14748 (00000000-0000-0000-0000-000000000000).
14749 x__xgafv: string, V1 error format.
14750 Allowed values
14751 1 - v1 error format
14752 2 - v2 error format
14753
14754 Returns:
14755 An object of the form:
14756
14757 { # Represents an Operation resource.
14758 #
14759 # Google Compute Engine has three Operation resources:
14760 #
14761 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
14762 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
14763 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
14764 #
14765 # You can use an operation resource to manage asynchronous API requests.
14766 # For more information, readHandling
14767 # API responses.
14768 #
14769 # Operations can be global, regional or zonal.
14770 #
14771 # - For global operations, use the `globalOperations`
14772 # resource.
14773 # - For regional operations, use the
14774 # `regionOperations` resource.
14775 # - For zonal operations, use
14776 # the `zoneOperations` resource.
14777 #
14778 #
14779 #
14780 # For more information, read
14781 # Global, Regional, and Zonal Resources.
14782 #
14783 # Note that completed Operation resources have a limited
14784 # retention period.
14785 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
14786 # Not present otherwise.
14787 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
14788 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
14789 # set when the operation is created.
14790 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
14791 # text format.
14792 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
14793 # this field will be populated.
14794 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
14795 # operation.
14796 {
14797 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
14798 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
14799 # details. There is a set of defined message types to use for providing
14800 # details.The syntax depends on the error code. For example,
14801 # QuotaExceededInfo will have details when the error code is
14802 # QUOTA_EXCEEDED.
14803 {
14804 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
14805 #
14806 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
14807 # is not enabled:
14808 #
14809 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
14810 # &quot;domain&quot;: &quot;googleapis.com&quot;
14811 # &quot;metadata&quot;: {
14812 # &quot;resource&quot;: &quot;projects/123&quot;,
14813 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
14814 # }
14815 # }
14816 #
14817 # This response indicates that the pubsub.googleapis.com API is not enabled.
14818 #
14819 # Example of an error that is returned when attempting to create a Spanner
14820 # instance in a region that is out of stock:
14821 #
14822 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
14823 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
14824 # &quot;metadata&quot;: {
14825 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
14826 # }
14827 # }
14828 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
14829 # is typically the registered service name of the tool or product that
14830 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
14831 # generated by some common infrastructure, the error domain must be a
14832 # globally unique value that identifies the infrastructure. For Google API
14833 # infrastructure, the error domain is &quot;googleapis.com&quot;.
14834 &quot;metadatas&quot;: { # Additional structured details about this error.
14835 #
14836 # Keys must match a regular expression of `a-z+` but should
14837 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
14838 # length. When identifying the current value of an exceeded limit, the units
14839 # should be contained in the key, not the value. For example, rather than
14840 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
14841 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
14842 # instances that can be created in a single (batch) request.
14843 &quot;a_key&quot;: &quot;A String&quot;,
14844 },
14845 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
14846 # proximate cause of the error. Error reasons are unique within a particular
14847 # domain of errors. This should be at most 63 characters and match a
14848 # regular expression of `A-Z+[A-Z0-9]`, which represents
14849 # UPPER_SNAKE_CASE.
14850 },
14851 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
14852 #
14853 # For example, if a quota check failed with an error indicating the calling
14854 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
14855 # directly to the right place in the developer console to flip the bit.
14856 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
14857 { # Describes a URL link.
14858 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
14859 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
14860 },
14861 ],
14862 },
14863 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
14864 # which can be attached to an RPC error.
14865 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
14866 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
14867 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
14868 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
14869 },
14870 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
14871 &quot;dimensions&quot;: { # The map holding related quota dimensions.
14872 &quot;a_key&quot;: &quot;A String&quot;,
14873 },
14874 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
14875 # type or metric.
14876 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
14877 # or metric.
14878 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
14879 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
14880 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
14881 },
14882 },
14883 ],
14884 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
14885 # This property is optional.
14886 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
14887 },
14888 ],
14889 },
14890 &quot;getVersionOperationMetadata&quot;: {
14891 &quot;inlineSbomInfo&quot;: {
14892 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
14893 # appropriate identifiers.
14894 &quot;a_key&quot;: &quot;A String&quot;,
14895 },
14896 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
14897 # identifiers.
14898 &quot;a_key&quot;: &quot;A String&quot;,
14899 },
14900 },
14901 },
14902 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
14903 # message that was returned, such as `NOT FOUND`.
14904 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
14905 # status code that was returned. For example, a `404` means the
14906 # resource was not found.
14907 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
14908 # defined by the server.
14909 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
14910 # This value is inRFC3339
14911 # text format.
14912 &quot;instancesBulkInsertOperationMetadata&quot;: {
14913 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
14914 # Example key: zones/us-central1-a
14915 &quot;a_key&quot;: {
14916 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
14917 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
14918 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
14919 # error.
14920 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
14921 # if the flow is rolling forward or rolling back.
14922 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
14923 },
14924 },
14925 },
14926 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
14927 # Operation resources.
14928 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
14929 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
14930 # group of operations results from a `bulkInsert` API request.
14931 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
14932 # `update`, or `delete`, and so on.
14933 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
14934 # There is no requirement that this be linear or support any granularity of
14935 # operations. This should not be used to guess when the operation will be
14936 # complete. This number should monotonically increase as the operation
14937 # progresses.
14938 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
14939 # applicable when performing regional operations.
14940 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
14941 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
14942 # this field will contain information on all underlying zonal actions and
14943 # their state.
14944 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
14945 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
14946 # Example key: zones/us-central1-a
14947 &quot;a_key&quot;: {
14948 &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
14949 # populated.
14950 # different programming environments, including REST APIs and RPC APIs. It is
14951 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
14952 # three pieces of data: error code, error message, and error details.
14953 #
14954 # You can find out more about this error model and how to work with it in the
14955 # [API Design Guide](https://cloud.google.com/apis/design/errors).
14956 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
14957 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
14958 # message types for APIs to use.
14959 {
14960 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
14961 },
14962 ],
14963 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
14964 # user-facing error message should be localized and sent in the
14965 # google.rpc.Status.details field, or localized by the client.
14966 },
14967 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
14968 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
14969 },
14970 },
14971 },
14972 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
14973 # This value is inRFC3339
14974 # text format.
14975 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
14976 # following:
14977 # `PENDING`, `RUNNING`, or `DONE`.
14978 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
14979 # operation.
14980 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
14981 # of the target resource.
14982 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
14983 # operations related to creating a snapshot, this points to the disk
14984 # that the snapshot was created from.
14985 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
14986 # `[email protected]` or
14987 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
14988 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
14989 # operation, this field will be populated.
14990 {
14991 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
14992 # Engine returns NO_RESULTS_ON_PAGE if there
14993 # are no results in the response.
14994 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
14995 # value format. For example:
14996 #
14997 # &quot;data&quot;: [
14998 # {
14999 # &quot;key&quot;: &quot;scope&quot;,
15000 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
15001 # }
15002 {
15003 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
15004 # returned. For example, for warnings where there are no results in a list
15005 # request for a particular zone, this key might be scope and
15006 # the key value might be the zone name. Other examples might be a key
15007 # indicating a deprecated resource and a suggested replacement, or a
15008 # warning about invalid network settings (for example, if an instance
15009 # attempts to perform IP forwarding but is not enabled for IP forwarding).
15010 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
15011 },
15012 ],
15013 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
15014 },
15015 ],
15016 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
15017 # applicable when performing per-zone operations.
15018 }</pre>
15019 </div>
15020
15021 <div class="method">
15022 <code class="details" id="setMachineType">setMachineType(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
15023 <pre>Changes the machine type for a stopped instance to the machine
15024 type specified in the request.
15025
15026 Args:
15027 project: string, Project ID for this request. (required)
15028 zone: string, The name of the zone for this request. (required)
15029 instance: string, Name of the instance scoping this request. (required)
15030 body: object, The request body.
15031 The object takes the form of:
15032
15033 {
15034 &quot;machineType&quot;: &quot;A String&quot;, # Full or partial URL of the machine type resource. See Machine Types for a full list of
15035 # machine types. For example:zones/us-central1-f/machineTypes/n1-standard-1
15036 }
15037
15038 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
15039 that if you must retry your request, the server will know to ignore the
15040 request if it has already been completed.
15041
15042 For example, consider a situation where you make an initial request and
15043 the request times out. If you make the request again with the same
15044 request ID, the server can check if original operation with the same
15045 request ID was received, and if so, will ignore the second request. This
15046 prevents clients from accidentally creating duplicate commitments.
15047
15048 The request ID must be
15049 a valid UUID with the exception that zero UUID is not supported
15050 (00000000-0000-0000-0000-000000000000).
15051 x__xgafv: string, V1 error format.
15052 Allowed values
15053 1 - v1 error format
15054 2 - v2 error format
15055
15056 Returns:
15057 An object of the form:
15058
15059 { # Represents an Operation resource.
15060 #
15061 # Google Compute Engine has three Operation resources:
15062 #
15063 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
15064 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
15065 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
15066 #
15067 # You can use an operation resource to manage asynchronous API requests.
15068 # For more information, readHandling
15069 # API responses.
15070 #
15071 # Operations can be global, regional or zonal.
15072 #
15073 # - For global operations, use the `globalOperations`
15074 # resource.
15075 # - For regional operations, use the
15076 # `regionOperations` resource.
15077 # - For zonal operations, use
15078 # the `zoneOperations` resource.
15079 #
15080 #
15081 #
15082 # For more information, read
15083 # Global, Regional, and Zonal Resources.
15084 #
15085 # Note that completed Operation resources have a limited
15086 # retention period.
15087 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
15088 # Not present otherwise.
15089 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
15090 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
15091 # set when the operation is created.
15092 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
15093 # text format.
15094 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
15095 # this field will be populated.
15096 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
15097 # operation.
15098 {
15099 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
15100 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
15101 # details. There is a set of defined message types to use for providing
15102 # details.The syntax depends on the error code. For example,
15103 # QuotaExceededInfo will have details when the error code is
15104 # QUOTA_EXCEEDED.
15105 {
15106 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
15107 #
15108 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
15109 # is not enabled:
15110 #
15111 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
15112 # &quot;domain&quot;: &quot;googleapis.com&quot;
15113 # &quot;metadata&quot;: {
15114 # &quot;resource&quot;: &quot;projects/123&quot;,
15115 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
15116 # }
15117 # }
15118 #
15119 # This response indicates that the pubsub.googleapis.com API is not enabled.
15120 #
15121 # Example of an error that is returned when attempting to create a Spanner
15122 # instance in a region that is out of stock:
15123 #
15124 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
15125 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
15126 # &quot;metadata&quot;: {
15127 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
15128 # }
15129 # }
15130 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
15131 # is typically the registered service name of the tool or product that
15132 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
15133 # generated by some common infrastructure, the error domain must be a
15134 # globally unique value that identifies the infrastructure. For Google API
15135 # infrastructure, the error domain is &quot;googleapis.com&quot;.
15136 &quot;metadatas&quot;: { # Additional structured details about this error.
15137 #
15138 # Keys must match a regular expression of `a-z+` but should
15139 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
15140 # length. When identifying the current value of an exceeded limit, the units
15141 # should be contained in the key, not the value. For example, rather than
15142 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
15143 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
15144 # instances that can be created in a single (batch) request.
15145 &quot;a_key&quot;: &quot;A String&quot;,
15146 },
15147 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
15148 # proximate cause of the error. Error reasons are unique within a particular
15149 # domain of errors. This should be at most 63 characters and match a
15150 # regular expression of `A-Z+[A-Z0-9]`, which represents
15151 # UPPER_SNAKE_CASE.
15152 },
15153 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
15154 #
15155 # For example, if a quota check failed with an error indicating the calling
15156 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
15157 # directly to the right place in the developer console to flip the bit.
15158 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
15159 { # Describes a URL link.
15160 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
15161 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
15162 },
15163 ],
15164 },
15165 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
15166 # which can be attached to an RPC error.
15167 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
15168 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
15169 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
15170 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
15171 },
15172 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
15173 &quot;dimensions&quot;: { # The map holding related quota dimensions.
15174 &quot;a_key&quot;: &quot;A String&quot;,
15175 },
15176 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
15177 # type or metric.
15178 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
15179 # or metric.
15180 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
15181 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
15182 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
15183 },
15184 },
15185 ],
15186 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
15187 # This property is optional.
15188 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
15189 },
15190 ],
15191 },
15192 &quot;getVersionOperationMetadata&quot;: {
15193 &quot;inlineSbomInfo&quot;: {
15194 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
15195 # appropriate identifiers.
15196 &quot;a_key&quot;: &quot;A String&quot;,
15197 },
15198 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
15199 # identifiers.
15200 &quot;a_key&quot;: &quot;A String&quot;,
15201 },
15202 },
15203 },
15204 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
15205 # message that was returned, such as `NOT FOUND`.
15206 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
15207 # status code that was returned. For example, a `404` means the
15208 # resource was not found.
15209 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
15210 # defined by the server.
15211 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
15212 # This value is inRFC3339
15213 # text format.
15214 &quot;instancesBulkInsertOperationMetadata&quot;: {
15215 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
15216 # Example key: zones/us-central1-a
15217 &quot;a_key&quot;: {
15218 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
15219 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
15220 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
15221 # error.
15222 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
15223 # if the flow is rolling forward or rolling back.
15224 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
15225 },
15226 },
15227 },
15228 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
15229 # Operation resources.
15230 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
15231 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
15232 # group of operations results from a `bulkInsert` API request.
15233 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
15234 # `update`, or `delete`, and so on.
15235 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
15236 # There is no requirement that this be linear or support any granularity of
15237 # operations. This should not be used to guess when the operation will be
15238 # complete. This number should monotonically increase as the operation
15239 # progresses.
15240 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
15241 # applicable when performing regional operations.
15242 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
15243 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
15244 # this field will contain information on all underlying zonal actions and
15245 # their state.
15246 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
15247 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
15248 # Example key: zones/us-central1-a
15249 &quot;a_key&quot;: {
15250 &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
15251 # populated.
15252 # different programming environments, including REST APIs and RPC APIs. It is
15253 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
15254 # three pieces of data: error code, error message, and error details.
15255 #
15256 # You can find out more about this error model and how to work with it in the
15257 # [API Design Guide](https://cloud.google.com/apis/design/errors).
15258 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
15259 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
15260 # message types for APIs to use.
15261 {
15262 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
15263 },
15264 ],
15265 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
15266 # user-facing error message should be localized and sent in the
15267 # google.rpc.Status.details field, or localized by the client.
15268 },
15269 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
15270 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
15271 },
15272 },
15273 },
15274 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
15275 # This value is inRFC3339
15276 # text format.
15277 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
15278 # following:
15279 # `PENDING`, `RUNNING`, or `DONE`.
15280 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
15281 # operation.
15282 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
15283 # of the target resource.
15284 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
15285 # operations related to creating a snapshot, this points to the disk
15286 # that the snapshot was created from.
15287 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
15288 # `[email protected]` or
15289 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
15290 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
15291 # operation, this field will be populated.
15292 {
15293 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
15294 # Engine returns NO_RESULTS_ON_PAGE if there
15295 # are no results in the response.
15296 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
15297 # value format. For example:
15298 #
15299 # &quot;data&quot;: [
15300 # {
15301 # &quot;key&quot;: &quot;scope&quot;,
15302 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
15303 # }
15304 {
15305 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
15306 # returned. For example, for warnings where there are no results in a list
15307 # request for a particular zone, this key might be scope and
15308 # the key value might be the zone name. Other examples might be a key
15309 # indicating a deprecated resource and a suggested replacement, or a
15310 # warning about invalid network settings (for example, if an instance
15311 # attempts to perform IP forwarding but is not enabled for IP forwarding).
15312 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
15313 },
15314 ],
15315 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
15316 },
15317 ],
15318 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
15319 # applicable when performing per-zone operations.
15320 }</pre>
15321 </div>
15322
15323 <div class="method">
15324 <code class="details" id="setMetadata">setMetadata(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
15325 <pre>Sets metadata for the specified instance to the data included
15326 in the request.
15327
15328 Args:
15329 project: string, Project ID for this request. (required)
15330 zone: string, The name of the zone for this request. (required)
15331 instance: string, Name of the instance scoping this request. (required)
15332 body: object, The request body.
15333 The object takes the form of:
15334
15335 { # A metadata key/value entry.
15336 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
15337 # the metadata&#x27;s contents and used for optimistic locking. The
15338 # fingerprint is initially generated by Compute Engine and changes after
15339 # every request to modify or update metadata. You must always provide an
15340 # up-to-date fingerprint hash in order to update or change metadata,
15341 # otherwise the request will fail with error412 conditionNotMet.
15342 #
15343 # To see the latest fingerprint, make a get() request to
15344 # retrieve the resource.
15345 &quot;items&quot;: [ # Array of key/value pairs. The total size of all keys and values must be
15346 # less than 512 KB.
15347 { # Metadata
15348 &quot;key&quot;: &quot;A String&quot;, # Key for the metadata entry. Keys must conform to the following
15349 # regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length.
15350 # This is reflected as part of a URL in the metadata server. Additionally, to
15351 # avoid ambiguity, keys must not conflict with any other metadata keys
15352 # for the project.
15353 &quot;value&quot;: &quot;A String&quot;, # Value for the metadata entry. These are free-form strings, and only
15354 # have meaning as interpreted by the image running in the instance. The
15355 # only restriction placed on values is that their size must be less than
15356 # or equal to 262144 bytes (256 KiB).
15357 },
15358 ],
15359 &quot;kind&quot;: &quot;compute#metadata&quot;, # Output only. [Output Only] Type of the resource. Always compute#metadata
15360 # for metadata.
15361 }
15362
15363 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
15364 that if you must retry your request, the server will know to ignore the
15365 request if it has already been completed.
15366
15367 For example, consider a situation where you make an initial request and
15368 the request times out. If you make the request again with the same
15369 request ID, the server can check if original operation with the same
15370 request ID was received, and if so, will ignore the second request. This
15371 prevents clients from accidentally creating duplicate commitments.
15372
15373 The request ID must be
15374 a valid UUID with the exception that zero UUID is not supported
15375 (00000000-0000-0000-0000-000000000000).
15376 x__xgafv: string, V1 error format.
15377 Allowed values
15378 1 - v1 error format
15379 2 - v2 error format
15380
15381 Returns:
15382 An object of the form:
15383
15384 { # Represents an Operation resource.
15385 #
15386 # Google Compute Engine has three Operation resources:
15387 #
15388 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
15389 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
15390 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
15391 #
15392 # You can use an operation resource to manage asynchronous API requests.
15393 # For more information, readHandling
15394 # API responses.
15395 #
15396 # Operations can be global, regional or zonal.
15397 #
15398 # - For global operations, use the `globalOperations`
15399 # resource.
15400 # - For regional operations, use the
15401 # `regionOperations` resource.
15402 # - For zonal operations, use
15403 # the `zoneOperations` resource.
15404 #
15405 #
15406 #
15407 # For more information, read
15408 # Global, Regional, and Zonal Resources.
15409 #
15410 # Note that completed Operation resources have a limited
15411 # retention period.
15412 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
15413 # Not present otherwise.
15414 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
15415 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
15416 # set when the operation is created.
15417 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
15418 # text format.
15419 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
15420 # this field will be populated.
15421 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
15422 # operation.
15423 {
15424 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
15425 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
15426 # details. There is a set of defined message types to use for providing
15427 # details.The syntax depends on the error code. For example,
15428 # QuotaExceededInfo will have details when the error code is
15429 # QUOTA_EXCEEDED.
15430 {
15431 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
15432 #
15433 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
15434 # is not enabled:
15435 #
15436 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
15437 # &quot;domain&quot;: &quot;googleapis.com&quot;
15438 # &quot;metadata&quot;: {
15439 # &quot;resource&quot;: &quot;projects/123&quot;,
15440 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
15441 # }
15442 # }
15443 #
15444 # This response indicates that the pubsub.googleapis.com API is not enabled.
15445 #
15446 # Example of an error that is returned when attempting to create a Spanner
15447 # instance in a region that is out of stock:
15448 #
15449 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
15450 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
15451 # &quot;metadata&quot;: {
15452 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
15453 # }
15454 # }
15455 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
15456 # is typically the registered service name of the tool or product that
15457 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
15458 # generated by some common infrastructure, the error domain must be a
15459 # globally unique value that identifies the infrastructure. For Google API
15460 # infrastructure, the error domain is &quot;googleapis.com&quot;.
15461 &quot;metadatas&quot;: { # Additional structured details about this error.
15462 #
15463 # Keys must match a regular expression of `a-z+` but should
15464 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
15465 # length. When identifying the current value of an exceeded limit, the units
15466 # should be contained in the key, not the value. For example, rather than
15467 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
15468 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
15469 # instances that can be created in a single (batch) request.
15470 &quot;a_key&quot;: &quot;A String&quot;,
15471 },
15472 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
15473 # proximate cause of the error. Error reasons are unique within a particular
15474 # domain of errors. This should be at most 63 characters and match a
15475 # regular expression of `A-Z+[A-Z0-9]`, which represents
15476 # UPPER_SNAKE_CASE.
15477 },
15478 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
15479 #
15480 # For example, if a quota check failed with an error indicating the calling
15481 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
15482 # directly to the right place in the developer console to flip the bit.
15483 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
15484 { # Describes a URL link.
15485 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
15486 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
15487 },
15488 ],
15489 },
15490 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
15491 # which can be attached to an RPC error.
15492 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
15493 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
15494 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
15495 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
15496 },
15497 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
15498 &quot;dimensions&quot;: { # The map holding related quota dimensions.
15499 &quot;a_key&quot;: &quot;A String&quot;,
15500 },
15501 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
15502 # type or metric.
15503 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
15504 # or metric.
15505 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
15506 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
15507 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
15508 },
15509 },
15510 ],
15511 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
15512 # This property is optional.
15513 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
15514 },
15515 ],
15516 },
15517 &quot;getVersionOperationMetadata&quot;: {
15518 &quot;inlineSbomInfo&quot;: {
15519 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
15520 # appropriate identifiers.
15521 &quot;a_key&quot;: &quot;A String&quot;,
15522 },
15523 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
15524 # identifiers.
15525 &quot;a_key&quot;: &quot;A String&quot;,
15526 },
15527 },
15528 },
15529 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
15530 # message that was returned, such as `NOT FOUND`.
15531 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
15532 # status code that was returned. For example, a `404` means the
15533 # resource was not found.
15534 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
15535 # defined by the server.
15536 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
15537 # This value is inRFC3339
15538 # text format.
15539 &quot;instancesBulkInsertOperationMetadata&quot;: {
15540 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
15541 # Example key: zones/us-central1-a
15542 &quot;a_key&quot;: {
15543 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
15544 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
15545 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
15546 # error.
15547 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
15548 # if the flow is rolling forward or rolling back.
15549 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
15550 },
15551 },
15552 },
15553 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
15554 # Operation resources.
15555 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
15556 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
15557 # group of operations results from a `bulkInsert` API request.
15558 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
15559 # `update`, or `delete`, and so on.
15560 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
15561 # There is no requirement that this be linear or support any granularity of
15562 # operations. This should not be used to guess when the operation will be
15563 # complete. This number should monotonically increase as the operation
15564 # progresses.
15565 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
15566 # applicable when performing regional operations.
15567 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
15568 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
15569 # this field will contain information on all underlying zonal actions and
15570 # their state.
15571 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
15572 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
15573 # Example key: zones/us-central1-a
15574 &quot;a_key&quot;: {
15575 &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
15576 # populated.
15577 # different programming environments, including REST APIs and RPC APIs. It is
15578 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
15579 # three pieces of data: error code, error message, and error details.
15580 #
15581 # You can find out more about this error model and how to work with it in the
15582 # [API Design Guide](https://cloud.google.com/apis/design/errors).
15583 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
15584 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
15585 # message types for APIs to use.
15586 {
15587 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
15588 },
15589 ],
15590 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
15591 # user-facing error message should be localized and sent in the
15592 # google.rpc.Status.details field, or localized by the client.
15593 },
15594 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
15595 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
15596 },
15597 },
15598 },
15599 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
15600 # This value is inRFC3339
15601 # text format.
15602 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
15603 # following:
15604 # `PENDING`, `RUNNING`, or `DONE`.
15605 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
15606 # operation.
15607 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
15608 # of the target resource.
15609 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
15610 # operations related to creating a snapshot, this points to the disk
15611 # that the snapshot was created from.
15612 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
15613 # `[email protected]` or
15614 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
15615 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
15616 # operation, this field will be populated.
15617 {
15618 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
15619 # Engine returns NO_RESULTS_ON_PAGE if there
15620 # are no results in the response.
15621 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
15622 # value format. For example:
15623 #
15624 # &quot;data&quot;: [
15625 # {
15626 # &quot;key&quot;: &quot;scope&quot;,
15627 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
15628 # }
15629 {
15630 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
15631 # returned. For example, for warnings where there are no results in a list
15632 # request for a particular zone, this key might be scope and
15633 # the key value might be the zone name. Other examples might be a key
15634 # indicating a deprecated resource and a suggested replacement, or a
15635 # warning about invalid network settings (for example, if an instance
15636 # attempts to perform IP forwarding but is not enabled for IP forwarding).
15637 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
15638 },
15639 ],
15640 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
15641 },
15642 ],
15643 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
15644 # applicable when performing per-zone operations.
15645 }</pre>
15646 </div>
15647
15648 <div class="method">
15649 <code class="details" id="setMinCpuPlatform">setMinCpuPlatform(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
15650 <pre>Changes the minimum CPU platform that this instance should use.
15651 This method can only
15652 be called on a stopped instance. For more information, readSpecifying a
15653 Minimum CPU Platform.
15654
15655 Args:
15656 project: string, Project ID for this request. (required)
15657 zone: string, The name of the zone for this request. (required)
15658 instance: string, Name of the instance scoping this request. (required)
15659 body: object, The request body.
15660 The object takes the form of:
15661
15662 {
15663 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Minimum cpu/platform this instance should be started at.
15664 }
15665
15666 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
15667 that if you must retry your request, the server will know to ignore the
15668 request if it has already been completed.
15669
15670 For example, consider a situation where you make an initial request and
15671 the request times out. If you make the request again with the same
15672 request ID, the server can check if original operation with the same
15673 request ID was received, and if so, will ignore the second request. This
15674 prevents clients from accidentally creating duplicate commitments.
15675
15676 The request ID must be
15677 a valid UUID with the exception that zero UUID is not supported
15678 (00000000-0000-0000-0000-000000000000).
15679 x__xgafv: string, V1 error format.
15680 Allowed values
15681 1 - v1 error format
15682 2 - v2 error format
15683
15684 Returns:
15685 An object of the form:
15686
15687 { # Represents an Operation resource.
15688 #
15689 # Google Compute Engine has three Operation resources:
15690 #
15691 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
15692 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
15693 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
15694 #
15695 # You can use an operation resource to manage asynchronous API requests.
15696 # For more information, readHandling
15697 # API responses.
15698 #
15699 # Operations can be global, regional or zonal.
15700 #
15701 # - For global operations, use the `globalOperations`
15702 # resource.
15703 # - For regional operations, use the
15704 # `regionOperations` resource.
15705 # - For zonal operations, use
15706 # the `zoneOperations` resource.
15707 #
15708 #
15709 #
15710 # For more information, read
15711 # Global, Regional, and Zonal Resources.
15712 #
15713 # Note that completed Operation resources have a limited
15714 # retention period.
15715 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
15716 # Not present otherwise.
15717 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
15718 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
15719 # set when the operation is created.
15720 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
15721 # text format.
15722 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
15723 # this field will be populated.
15724 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
15725 # operation.
15726 {
15727 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
15728 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
15729 # details. There is a set of defined message types to use for providing
15730 # details.The syntax depends on the error code. For example,
15731 # QuotaExceededInfo will have details when the error code is
15732 # QUOTA_EXCEEDED.
15733 {
15734 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
15735 #
15736 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
15737 # is not enabled:
15738 #
15739 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
15740 # &quot;domain&quot;: &quot;googleapis.com&quot;
15741 # &quot;metadata&quot;: {
15742 # &quot;resource&quot;: &quot;projects/123&quot;,
15743 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
15744 # }
15745 # }
15746 #
15747 # This response indicates that the pubsub.googleapis.com API is not enabled.
15748 #
15749 # Example of an error that is returned when attempting to create a Spanner
15750 # instance in a region that is out of stock:
15751 #
15752 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
15753 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
15754 # &quot;metadata&quot;: {
15755 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
15756 # }
15757 # }
15758 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
15759 # is typically the registered service name of the tool or product that
15760 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
15761 # generated by some common infrastructure, the error domain must be a
15762 # globally unique value that identifies the infrastructure. For Google API
15763 # infrastructure, the error domain is &quot;googleapis.com&quot;.
15764 &quot;metadatas&quot;: { # Additional structured details about this error.
15765 #
15766 # Keys must match a regular expression of `a-z+` but should
15767 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
15768 # length. When identifying the current value of an exceeded limit, the units
15769 # should be contained in the key, not the value. For example, rather than
15770 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
15771 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
15772 # instances that can be created in a single (batch) request.
15773 &quot;a_key&quot;: &quot;A String&quot;,
15774 },
15775 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
15776 # proximate cause of the error. Error reasons are unique within a particular
15777 # domain of errors. This should be at most 63 characters and match a
15778 # regular expression of `A-Z+[A-Z0-9]`, which represents
15779 # UPPER_SNAKE_CASE.
15780 },
15781 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
15782 #
15783 # For example, if a quota check failed with an error indicating the calling
15784 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
15785 # directly to the right place in the developer console to flip the bit.
15786 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
15787 { # Describes a URL link.
15788 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
15789 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
15790 },
15791 ],
15792 },
15793 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
15794 # which can be attached to an RPC error.
15795 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
15796 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
15797 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
15798 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
15799 },
15800 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
15801 &quot;dimensions&quot;: { # The map holding related quota dimensions.
15802 &quot;a_key&quot;: &quot;A String&quot;,
15803 },
15804 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
15805 # type or metric.
15806 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
15807 # or metric.
15808 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
15809 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
15810 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
15811 },
15812 },
15813 ],
15814 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
15815 # This property is optional.
15816 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
15817 },
15818 ],
15819 },
15820 &quot;getVersionOperationMetadata&quot;: {
15821 &quot;inlineSbomInfo&quot;: {
15822 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
15823 # appropriate identifiers.
15824 &quot;a_key&quot;: &quot;A String&quot;,
15825 },
15826 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
15827 # identifiers.
15828 &quot;a_key&quot;: &quot;A String&quot;,
15829 },
15830 },
15831 },
15832 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
15833 # message that was returned, such as `NOT FOUND`.
15834 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
15835 # status code that was returned. For example, a `404` means the
15836 # resource was not found.
15837 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
15838 # defined by the server.
15839 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
15840 # This value is inRFC3339
15841 # text format.
15842 &quot;instancesBulkInsertOperationMetadata&quot;: {
15843 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
15844 # Example key: zones/us-central1-a
15845 &quot;a_key&quot;: {
15846 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
15847 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
15848 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
15849 # error.
15850 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
15851 # if the flow is rolling forward or rolling back.
15852 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
15853 },
15854 },
15855 },
15856 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
15857 # Operation resources.
15858 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
15859 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
15860 # group of operations results from a `bulkInsert` API request.
15861 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
15862 # `update`, or `delete`, and so on.
15863 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
15864 # There is no requirement that this be linear or support any granularity of
15865 # operations. This should not be used to guess when the operation will be
15866 # complete. This number should monotonically increase as the operation
15867 # progresses.
15868 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
15869 # applicable when performing regional operations.
15870 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
15871 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
15872 # this field will contain information on all underlying zonal actions and
15873 # their state.
15874 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
15875 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
15876 # Example key: zones/us-central1-a
15877 &quot;a_key&quot;: {
15878 &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
15879 # populated.
15880 # different programming environments, including REST APIs and RPC APIs. It is
15881 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
15882 # three pieces of data: error code, error message, and error details.
15883 #
15884 # You can find out more about this error model and how to work with it in the
15885 # [API Design Guide](https://cloud.google.com/apis/design/errors).
15886 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
15887 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
15888 # message types for APIs to use.
15889 {
15890 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
15891 },
15892 ],
15893 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
15894 # user-facing error message should be localized and sent in the
15895 # google.rpc.Status.details field, or localized by the client.
15896 },
15897 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
15898 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
15899 },
15900 },
15901 },
15902 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
15903 # This value is inRFC3339
15904 # text format.
15905 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
15906 # following:
15907 # `PENDING`, `RUNNING`, or `DONE`.
15908 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
15909 # operation.
15910 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
15911 # of the target resource.
15912 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
15913 # operations related to creating a snapshot, this points to the disk
15914 # that the snapshot was created from.
15915 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
15916 # `[email protected]` or
15917 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
15918 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
15919 # operation, this field will be populated.
15920 {
15921 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
15922 # Engine returns NO_RESULTS_ON_PAGE if there
15923 # are no results in the response.
15924 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
15925 # value format. For example:
15926 #
15927 # &quot;data&quot;: [
15928 # {
15929 # &quot;key&quot;: &quot;scope&quot;,
15930 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
15931 # }
15932 {
15933 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
15934 # returned. For example, for warnings where there are no results in a list
15935 # request for a particular zone, this key might be scope and
15936 # the key value might be the zone name. Other examples might be a key
15937 # indicating a deprecated resource and a suggested replacement, or a
15938 # warning about invalid network settings (for example, if an instance
15939 # attempts to perform IP forwarding but is not enabled for IP forwarding).
15940 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
15941 },
15942 ],
15943 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
15944 },
15945 ],
15946 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
15947 # applicable when performing per-zone operations.
15948 }</pre>
15949 </div>
15950
15951 <div class="method">
15952 <code class="details" id="setName">setName(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
15953 <pre>Sets name of an instance.
15954
15955 Args:
15956 project: string, Project ID for this request. (required)
15957 zone: string, The name of the zone for this request. (required)
15958 instance: string, The instance name for this request. (required)
15959 body: object, The request body.
15960 The object takes the form of:
15961
15962 {
15963 &quot;currentName&quot;: &quot;A String&quot;, # The current name of this resource, used to prevent conflicts. Provide the
15964 # latest name when making a request to change name.
15965 &quot;name&quot;: &quot;A String&quot;, # The name to be applied to the instance. Needs to be RFC 1035 compliant.
15966 }
15967
15968 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
15969 that if you must retry your request, the server will know to ignore the
15970 request if it has already been completed.
15971
15972 For example, consider a situation where you make an initial request and
15973 the request times out. If you make the request again with the same
15974 request ID, the server can check if original operation with the same
15975 request ID was received, and if so, will ignore the second request. This
15976 prevents clients from accidentally creating duplicate commitments.
15977
15978 The request ID must be
15979 a valid UUID with the exception that zero UUID is not supported
15980 (00000000-0000-0000-0000-000000000000).
15981 x__xgafv: string, V1 error format.
15982 Allowed values
15983 1 - v1 error format
15984 2 - v2 error format
15985
15986 Returns:
15987 An object of the form:
15988
15989 { # Represents an Operation resource.
15990 #
15991 # Google Compute Engine has three Operation resources:
15992 #
15993 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
15994 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
15995 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
15996 #
15997 # You can use an operation resource to manage asynchronous API requests.
15998 # For more information, readHandling
15999 # API responses.
16000 #
16001 # Operations can be global, regional or zonal.
16002 #
16003 # - For global operations, use the `globalOperations`
16004 # resource.
16005 # - For regional operations, use the
16006 # `regionOperations` resource.
16007 # - For zonal operations, use
16008 # the `zoneOperations` resource.
16009 #
16010 #
16011 #
16012 # For more information, read
16013 # Global, Regional, and Zonal Resources.
16014 #
16015 # Note that completed Operation resources have a limited
16016 # retention period.
16017 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
16018 # Not present otherwise.
16019 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
16020 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
16021 # set when the operation is created.
16022 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
16023 # text format.
16024 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
16025 # this field will be populated.
16026 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
16027 # operation.
16028 {
16029 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
16030 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
16031 # details. There is a set of defined message types to use for providing
16032 # details.The syntax depends on the error code. For example,
16033 # QuotaExceededInfo will have details when the error code is
16034 # QUOTA_EXCEEDED.
16035 {
16036 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
16037 #
16038 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
16039 # is not enabled:
16040 #
16041 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
16042 # &quot;domain&quot;: &quot;googleapis.com&quot;
16043 # &quot;metadata&quot;: {
16044 # &quot;resource&quot;: &quot;projects/123&quot;,
16045 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
16046 # }
16047 # }
16048 #
16049 # This response indicates that the pubsub.googleapis.com API is not enabled.
16050 #
16051 # Example of an error that is returned when attempting to create a Spanner
16052 # instance in a region that is out of stock:
16053 #
16054 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
16055 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
16056 # &quot;metadata&quot;: {
16057 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
16058 # }
16059 # }
16060 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
16061 # is typically the registered service name of the tool or product that
16062 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
16063 # generated by some common infrastructure, the error domain must be a
16064 # globally unique value that identifies the infrastructure. For Google API
16065 # infrastructure, the error domain is &quot;googleapis.com&quot;.
16066 &quot;metadatas&quot;: { # Additional structured details about this error.
16067 #
16068 # Keys must match a regular expression of `a-z+` but should
16069 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
16070 # length. When identifying the current value of an exceeded limit, the units
16071 # should be contained in the key, not the value. For example, rather than
16072 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
16073 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
16074 # instances that can be created in a single (batch) request.
16075 &quot;a_key&quot;: &quot;A String&quot;,
16076 },
16077 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
16078 # proximate cause of the error. Error reasons are unique within a particular
16079 # domain of errors. This should be at most 63 characters and match a
16080 # regular expression of `A-Z+[A-Z0-9]`, which represents
16081 # UPPER_SNAKE_CASE.
16082 },
16083 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
16084 #
16085 # For example, if a quota check failed with an error indicating the calling
16086 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
16087 # directly to the right place in the developer console to flip the bit.
16088 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
16089 { # Describes a URL link.
16090 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
16091 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
16092 },
16093 ],
16094 },
16095 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
16096 # which can be attached to an RPC error.
16097 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
16098 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
16099 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
16100 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
16101 },
16102 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
16103 &quot;dimensions&quot;: { # The map holding related quota dimensions.
16104 &quot;a_key&quot;: &quot;A String&quot;,
16105 },
16106 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
16107 # type or metric.
16108 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
16109 # or metric.
16110 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
16111 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
16112 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
16113 },
16114 },
16115 ],
16116 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
16117 # This property is optional.
16118 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
16119 },
16120 ],
16121 },
16122 &quot;getVersionOperationMetadata&quot;: {
16123 &quot;inlineSbomInfo&quot;: {
16124 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
16125 # appropriate identifiers.
16126 &quot;a_key&quot;: &quot;A String&quot;,
16127 },
16128 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
16129 # identifiers.
16130 &quot;a_key&quot;: &quot;A String&quot;,
16131 },
16132 },
16133 },
16134 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
16135 # message that was returned, such as `NOT FOUND`.
16136 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
16137 # status code that was returned. For example, a `404` means the
16138 # resource was not found.
16139 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
16140 # defined by the server.
16141 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
16142 # This value is inRFC3339
16143 # text format.
16144 &quot;instancesBulkInsertOperationMetadata&quot;: {
16145 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
16146 # Example key: zones/us-central1-a
16147 &quot;a_key&quot;: {
16148 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
16149 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
16150 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
16151 # error.
16152 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
16153 # if the flow is rolling forward or rolling back.
16154 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
16155 },
16156 },
16157 },
16158 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
16159 # Operation resources.
16160 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
16161 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
16162 # group of operations results from a `bulkInsert` API request.
16163 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
16164 # `update`, or `delete`, and so on.
16165 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
16166 # There is no requirement that this be linear or support any granularity of
16167 # operations. This should not be used to guess when the operation will be
16168 # complete. This number should monotonically increase as the operation
16169 # progresses.
16170 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
16171 # applicable when performing regional operations.
16172 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
16173 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
16174 # this field will contain information on all underlying zonal actions and
16175 # their state.
16176 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
16177 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
16178 # Example key: zones/us-central1-a
16179 &quot;a_key&quot;: {
16180 &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
16181 # populated.
16182 # different programming environments, including REST APIs and RPC APIs. It is
16183 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
16184 # three pieces of data: error code, error message, and error details.
16185 #
16186 # You can find out more about this error model and how to work with it in the
16187 # [API Design Guide](https://cloud.google.com/apis/design/errors).
16188 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
16189 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
16190 # message types for APIs to use.
16191 {
16192 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
16193 },
16194 ],
16195 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
16196 # user-facing error message should be localized and sent in the
16197 # google.rpc.Status.details field, or localized by the client.
16198 },
16199 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
16200 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
16201 },
16202 },
16203 },
16204 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
16205 # This value is inRFC3339
16206 # text format.
16207 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
16208 # following:
16209 # `PENDING`, `RUNNING`, or `DONE`.
16210 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
16211 # operation.
16212 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
16213 # of the target resource.
16214 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
16215 # operations related to creating a snapshot, this points to the disk
16216 # that the snapshot was created from.
16217 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
16218 # `[email protected]` or
16219 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
16220 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
16221 # operation, this field will be populated.
16222 {
16223 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
16224 # Engine returns NO_RESULTS_ON_PAGE if there
16225 # are no results in the response.
16226 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
16227 # value format. For example:
16228 #
16229 # &quot;data&quot;: [
16230 # {
16231 # &quot;key&quot;: &quot;scope&quot;,
16232 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
16233 # }
16234 {
16235 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
16236 # returned. For example, for warnings where there are no results in a list
16237 # request for a particular zone, this key might be scope and
16238 # the key value might be the zone name. Other examples might be a key
16239 # indicating a deprecated resource and a suggested replacement, or a
16240 # warning about invalid network settings (for example, if an instance
16241 # attempts to perform IP forwarding but is not enabled for IP forwarding).
16242 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
16243 },
16244 ],
16245 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
16246 },
16247 ],
16248 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
16249 # applicable when performing per-zone operations.
16250 }</pre>
16251 </div>
16252
16253 <div class="method">
16254 <code class="details" id="setScheduling">setScheduling(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
16255 <pre>Sets an instance&#x27;s scheduling options. You can only call this method on astopped instance,
16256 that is, a VM instance that is in a `TERMINATED` state. SeeInstance Life
16257 Cycle for more information on the possible instance states.
16258 For more information about setting scheduling options for a VM, seeSet
16259 VM host maintenance policy.
16260
16261 Args:
16262 project: string, Project ID for this request. (required)
16263 zone: string, The name of the zone for this request. (required)
16264 instance: string, Instance name for this request. (required)
16265 body: object, The request body.
16266 The object takes the form of:
16267
16268 { # Sets the scheduling options for an Instance.
16269 &quot;automaticRestart&quot;: True or False, # Specifies whether the instance should be automatically restarted if it is
16270 # terminated by Compute Engine (not terminated by a user). You can only set
16271 # the automatic restart option for standard instances.Preemptible instances
16272 # cannot be automatically restarted.
16273 #
16274 # By default, this is set to true so an instance is
16275 # automatically restarted if it is terminated by Compute Engine.
16276 &quot;availabilityDomain&quot;: 42, # Specifies the availability domain to place the instance in. The value
16277 # must be a number between 1 and the number of availability domains
16278 # specified in the spread placement policy attached to the instance.
16279 &quot;hostErrorTimeoutSeconds&quot;: 42, # Specify the time in seconds for host error detection, the value must be
16280 # within the range of [90, 330] with the increment of 30, if unset, the
16281 # default behavior of host error recovery will be used.
16282 &quot;instanceTerminationAction&quot;: &quot;A String&quot;, # Specifies the termination action for the instance.
16283 &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
16284 # recovery of the Local Ssd state is attempted. Its value should be in
16285 # between 0 and 168 hours with hour granularity and the default value being 1
16286 # hour.
16287 # as a count of seconds and fractions of seconds at nanosecond
16288 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
16289 # or &quot;month&quot;. Range is approximately 10,000 years.
16290 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
16291 # Durations less than one second are represented with a 0
16292 # `seconds` field and a positive `nanos` field. Must be from 0
16293 # to 999,999,999 inclusive.
16294 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
16295 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
16296 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
16297 },
16298 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the instance close to other
16299 # resources.
16300 # This field is for use by internal tools that use the public API.
16301 &quot;maxRunDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the max run duration for the given instance. If specified,
16302 # the instance termination action will be performed at the end of the run
16303 # duration.
16304 # as a count of seconds and fractions of seconds at nanosecond
16305 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
16306 # or &quot;month&quot;. Range is approximately 10,000 years.
16307 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
16308 # Durations less than one second are represented with a 0
16309 # `seconds` field and a positive `nanos` field. Must be from 0
16310 # to 999,999,999 inclusive.
16311 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
16312 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
16313 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
16314 },
16315 &quot;minNodeCpus&quot;: 42, # The minimum number of virtual CPUs this instance will consume when running
16316 # on a sole-tenant node.
16317 &quot;nodeAffinities&quot;: [ # A set of node affinity and anti-affinity configurations. Refer toConfiguring node
16318 # affinity for more information.
16319 # Overrides reservationAffinity.
16320 { # Node Affinity: the configuration of desired nodes onto which this Instance
16321 # could be scheduled.
16322 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of Node resource.
16323 &quot;operator&quot;: &quot;A String&quot;, # Defines the operation of node selection. Valid operators areIN for affinity and NOT_IN for anti-affinity.
16324 &quot;values&quot;: [ # Corresponds to the label values of Node resource.
16325 &quot;A String&quot;,
16326 ],
16327 },
16328 ],
16329 &quot;onHostMaintenance&quot;: &quot;A String&quot;, # Defines the maintenance behavior for this instance. For standard instances,
16330 # the default behavior is MIGRATE. Forpreemptible instances,
16331 # the default and only possible behavior is TERMINATE. For more
16332 # information, see
16333 # Set
16334 # VM host maintenance policy.
16335 &quot;onInstanceStopAction&quot;: { # Defines the behaviour for instances with the instance_termination_actionSTOP.
16336 &quot;discardLocalSsd&quot;: True or False, # If true, the contents of any attached Local SSD disks will be discarded
16337 # else, the Local SSD data will be preserved when the instance is stopped
16338 # at the end of the run duration/termination time.
16339 },
16340 &quot;preemptible&quot;: True or False, # Defines whether the instance is preemptible. This can only be set during
16341 # instance creation or while the instance isstopped and
16342 # therefore, in a `TERMINATED` state. SeeInstance Life
16343 # Cycle for more information on the possible instance states.
16344 &quot;provisioningModel&quot;: &quot;A String&quot;, # Specifies the provisioning model of the instance.
16345 &quot;skipGuestOsShutdown&quot;: True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
16346 # Off and ACPI G3 Mechanical
16347 # Off for Standard VMs and 30 seconds for Spot VMs.
16348 &quot;terminationTime&quot;: &quot;A String&quot;, # Specifies the timestamp, when the instance will be terminated, inRFC3339 text format. If specified, the instance
16349 # termination action will be performed at the termination time.
16350 }
16351
16352 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
16353 that if you must retry your request, the server will know to ignore the
16354 request if it has already been completed.
16355
16356 For example, consider a situation where you make an initial request and
16357 the request times out. If you make the request again with the same
16358 request ID, the server can check if original operation with the same
16359 request ID was received, and if so, will ignore the second request. This
16360 prevents clients from accidentally creating duplicate commitments.
16361
16362 The request ID must be
16363 a valid UUID with the exception that zero UUID is not supported
16364 (00000000-0000-0000-0000-000000000000).
16365 x__xgafv: string, V1 error format.
16366 Allowed values
16367 1 - v1 error format
16368 2 - v2 error format
16369
16370 Returns:
16371 An object of the form:
16372
16373 { # Represents an Operation resource.
16374 #
16375 # Google Compute Engine has three Operation resources:
16376 #
16377 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
16378 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
16379 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
16380 #
16381 # You can use an operation resource to manage asynchronous API requests.
16382 # For more information, readHandling
16383 # API responses.
16384 #
16385 # Operations can be global, regional or zonal.
16386 #
16387 # - For global operations, use the `globalOperations`
16388 # resource.
16389 # - For regional operations, use the
16390 # `regionOperations` resource.
16391 # - For zonal operations, use
16392 # the `zoneOperations` resource.
16393 #
16394 #
16395 #
16396 # For more information, read
16397 # Global, Regional, and Zonal Resources.
16398 #
16399 # Note that completed Operation resources have a limited
16400 # retention period.
16401 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
16402 # Not present otherwise.
16403 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
16404 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
16405 # set when the operation is created.
16406 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
16407 # text format.
16408 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
16409 # this field will be populated.
16410 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
16411 # operation.
16412 {
16413 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
16414 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
16415 # details. There is a set of defined message types to use for providing
16416 # details.The syntax depends on the error code. For example,
16417 # QuotaExceededInfo will have details when the error code is
16418 # QUOTA_EXCEEDED.
16419 {
16420 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
16421 #
16422 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
16423 # is not enabled:
16424 #
16425 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
16426 # &quot;domain&quot;: &quot;googleapis.com&quot;
16427 # &quot;metadata&quot;: {
16428 # &quot;resource&quot;: &quot;projects/123&quot;,
16429 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
16430 # }
16431 # }
16432 #
16433 # This response indicates that the pubsub.googleapis.com API is not enabled.
16434 #
16435 # Example of an error that is returned when attempting to create a Spanner
16436 # instance in a region that is out of stock:
16437 #
16438 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
16439 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
16440 # &quot;metadata&quot;: {
16441 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
16442 # }
16443 # }
16444 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
16445 # is typically the registered service name of the tool or product that
16446 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
16447 # generated by some common infrastructure, the error domain must be a
16448 # globally unique value that identifies the infrastructure. For Google API
16449 # infrastructure, the error domain is &quot;googleapis.com&quot;.
16450 &quot;metadatas&quot;: { # Additional structured details about this error.
16451 #
16452 # Keys must match a regular expression of `a-z+` but should
16453 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
16454 # length. When identifying the current value of an exceeded limit, the units
16455 # should be contained in the key, not the value. For example, rather than
16456 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
16457 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
16458 # instances that can be created in a single (batch) request.
16459 &quot;a_key&quot;: &quot;A String&quot;,
16460 },
16461 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
16462 # proximate cause of the error. Error reasons are unique within a particular
16463 # domain of errors. This should be at most 63 characters and match a
16464 # regular expression of `A-Z+[A-Z0-9]`, which represents
16465 # UPPER_SNAKE_CASE.
16466 },
16467 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
16468 #
16469 # For example, if a quota check failed with an error indicating the calling
16470 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
16471 # directly to the right place in the developer console to flip the bit.
16472 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
16473 { # Describes a URL link.
16474 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
16475 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
16476 },
16477 ],
16478 },
16479 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
16480 # which can be attached to an RPC error.
16481 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
16482 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
16483 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
16484 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
16485 },
16486 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
16487 &quot;dimensions&quot;: { # The map holding related quota dimensions.
16488 &quot;a_key&quot;: &quot;A String&quot;,
16489 },
16490 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
16491 # type or metric.
16492 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
16493 # or metric.
16494 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
16495 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
16496 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
16497 },
16498 },
16499 ],
16500 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
16501 # This property is optional.
16502 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
16503 },
16504 ],
16505 },
16506 &quot;getVersionOperationMetadata&quot;: {
16507 &quot;inlineSbomInfo&quot;: {
16508 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
16509 # appropriate identifiers.
16510 &quot;a_key&quot;: &quot;A String&quot;,
16511 },
16512 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
16513 # identifiers.
16514 &quot;a_key&quot;: &quot;A String&quot;,
16515 },
16516 },
16517 },
16518 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
16519 # message that was returned, such as `NOT FOUND`.
16520 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
16521 # status code that was returned. For example, a `404` means the
16522 # resource was not found.
16523 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
16524 # defined by the server.
16525 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
16526 # This value is inRFC3339
16527 # text format.
16528 &quot;instancesBulkInsertOperationMetadata&quot;: {
16529 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
16530 # Example key: zones/us-central1-a
16531 &quot;a_key&quot;: {
16532 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
16533 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
16534 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
16535 # error.
16536 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
16537 # if the flow is rolling forward or rolling back.
16538 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
16539 },
16540 },
16541 },
16542 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
16543 # Operation resources.
16544 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
16545 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
16546 # group of operations results from a `bulkInsert` API request.
16547 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
16548 # `update`, or `delete`, and so on.
16549 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
16550 # There is no requirement that this be linear or support any granularity of
16551 # operations. This should not be used to guess when the operation will be
16552 # complete. This number should monotonically increase as the operation
16553 # progresses.
16554 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
16555 # applicable when performing regional operations.
16556 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
16557 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
16558 # this field will contain information on all underlying zonal actions and
16559 # their state.
16560 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
16561 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
16562 # Example key: zones/us-central1-a
16563 &quot;a_key&quot;: {
16564 &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
16565 # populated.
16566 # different programming environments, including REST APIs and RPC APIs. It is
16567 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
16568 # three pieces of data: error code, error message, and error details.
16569 #
16570 # You can find out more about this error model and how to work with it in the
16571 # [API Design Guide](https://cloud.google.com/apis/design/errors).
16572 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
16573 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
16574 # message types for APIs to use.
16575 {
16576 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
16577 },
16578 ],
16579 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
16580 # user-facing error message should be localized and sent in the
16581 # google.rpc.Status.details field, or localized by the client.
16582 },
16583 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
16584 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
16585 },
16586 },
16587 },
16588 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
16589 # This value is inRFC3339
16590 # text format.
16591 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
16592 # following:
16593 # `PENDING`, `RUNNING`, or `DONE`.
16594 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
16595 # operation.
16596 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
16597 # of the target resource.
16598 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
16599 # operations related to creating a snapshot, this points to the disk
16600 # that the snapshot was created from.
16601 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
16602 # `[email protected]` or
16603 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
16604 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
16605 # operation, this field will be populated.
16606 {
16607 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
16608 # Engine returns NO_RESULTS_ON_PAGE if there
16609 # are no results in the response.
16610 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
16611 # value format. For example:
16612 #
16613 # &quot;data&quot;: [
16614 # {
16615 # &quot;key&quot;: &quot;scope&quot;,
16616 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
16617 # }
16618 {
16619 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
16620 # returned. For example, for warnings where there are no results in a list
16621 # request for a particular zone, this key might be scope and
16622 # the key value might be the zone name. Other examples might be a key
16623 # indicating a deprecated resource and a suggested replacement, or a
16624 # warning about invalid network settings (for example, if an instance
16625 # attempts to perform IP forwarding but is not enabled for IP forwarding).
16626 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
16627 },
16628 ],
16629 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
16630 },
16631 ],
16632 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
16633 # applicable when performing per-zone operations.
16634 }</pre>
16635 </div>
16636
16637 <div class="method">
16638 <code class="details" id="setSecurityPolicy">setSecurityPolicy(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
16639 <pre>Sets the Google Cloud Armor security policy for the specified instance.
16640 For more information, seeGoogle
16641 Cloud Armor Overview
16642
16643 Args:
16644 project: string, Project ID for this request. (required)
16645 zone: string, Name of the zone scoping this request. (required)
16646 instance: string, Name of the Instance resource to which the security policy should be
16647 set. The name should conform to RFC1035. (required)
16648 body: object, The request body.
16649 The object takes the form of:
16650
16651 {
16652 &quot;networkInterfaces&quot;: [ # The network interfaces that the security policy will be applied to. Network
16653 # interfaces use the nicN naming format. You can only set a
16654 # security policy for network interfaces with an access config.
16655 &quot;A String&quot;,
16656 ],
16657 &quot;securityPolicy&quot;: &quot;A String&quot;, # A full or partial URL to a security policy to add to this instance.
16658 # If this field is set to an empty string it will remove the associated
16659 # security policy.
16660 }
16661
16662 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
16663 that if you must retry your request, the server will know to ignore the
16664 request if it has already been completed.
16665
16666 For example, consider a situation where you make an initial request and
16667 the request times out. If you make the request again with the same
16668 request ID, the server can check if original operation with the same
16669 request ID was received, and if so, will ignore the second request. This
16670 prevents clients from accidentally creating duplicate commitments.
16671
16672 The request ID must be
16673 a valid UUID with the exception that zero UUID is not supported
16674 (00000000-0000-0000-0000-000000000000).
16675 x__xgafv: string, V1 error format.
16676 Allowed values
16677 1 - v1 error format
16678 2 - v2 error format
16679
16680 Returns:
16681 An object of the form:
16682
16683 { # Represents an Operation resource.
16684 #
16685 # Google Compute Engine has three Operation resources:
16686 #
16687 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
16688 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
16689 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
16690 #
16691 # You can use an operation resource to manage asynchronous API requests.
16692 # For more information, readHandling
16693 # API responses.
16694 #
16695 # Operations can be global, regional or zonal.
16696 #
16697 # - For global operations, use the `globalOperations`
16698 # resource.
16699 # - For regional operations, use the
16700 # `regionOperations` resource.
16701 # - For zonal operations, use
16702 # the `zoneOperations` resource.
16703 #
16704 #
16705 #
16706 # For more information, read
16707 # Global, Regional, and Zonal Resources.
16708 #
16709 # Note that completed Operation resources have a limited
16710 # retention period.
16711 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
16712 # Not present otherwise.
16713 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
16714 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
16715 # set when the operation is created.
16716 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
16717 # text format.
16718 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
16719 # this field will be populated.
16720 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
16721 # operation.
16722 {
16723 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
16724 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
16725 # details. There is a set of defined message types to use for providing
16726 # details.The syntax depends on the error code. For example,
16727 # QuotaExceededInfo will have details when the error code is
16728 # QUOTA_EXCEEDED.
16729 {
16730 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
16731 #
16732 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
16733 # is not enabled:
16734 #
16735 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
16736 # &quot;domain&quot;: &quot;googleapis.com&quot;
16737 # &quot;metadata&quot;: {
16738 # &quot;resource&quot;: &quot;projects/123&quot;,
16739 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
16740 # }
16741 # }
16742 #
16743 # This response indicates that the pubsub.googleapis.com API is not enabled.
16744 #
16745 # Example of an error that is returned when attempting to create a Spanner
16746 # instance in a region that is out of stock:
16747 #
16748 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
16749 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
16750 # &quot;metadata&quot;: {
16751 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
16752 # }
16753 # }
16754 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
16755 # is typically the registered service name of the tool or product that
16756 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
16757 # generated by some common infrastructure, the error domain must be a
16758 # globally unique value that identifies the infrastructure. For Google API
16759 # infrastructure, the error domain is &quot;googleapis.com&quot;.
16760 &quot;metadatas&quot;: { # Additional structured details about this error.
16761 #
16762 # Keys must match a regular expression of `a-z+` but should
16763 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
16764 # length. When identifying the current value of an exceeded limit, the units
16765 # should be contained in the key, not the value. For example, rather than
16766 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
16767 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
16768 # instances that can be created in a single (batch) request.
16769 &quot;a_key&quot;: &quot;A String&quot;,
16770 },
16771 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
16772 # proximate cause of the error. Error reasons are unique within a particular
16773 # domain of errors. This should be at most 63 characters and match a
16774 # regular expression of `A-Z+[A-Z0-9]`, which represents
16775 # UPPER_SNAKE_CASE.
16776 },
16777 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
16778 #
16779 # For example, if a quota check failed with an error indicating the calling
16780 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
16781 # directly to the right place in the developer console to flip the bit.
16782 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
16783 { # Describes a URL link.
16784 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
16785 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
16786 },
16787 ],
16788 },
16789 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
16790 # which can be attached to an RPC error.
16791 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
16792 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
16793 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
16794 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
16795 },
16796 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
16797 &quot;dimensions&quot;: { # The map holding related quota dimensions.
16798 &quot;a_key&quot;: &quot;A String&quot;,
16799 },
16800 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
16801 # type or metric.
16802 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
16803 # or metric.
16804 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
16805 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
16806 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
16807 },
16808 },
16809 ],
16810 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
16811 # This property is optional.
16812 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
16813 },
16814 ],
16815 },
16816 &quot;getVersionOperationMetadata&quot;: {
16817 &quot;inlineSbomInfo&quot;: {
16818 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
16819 # appropriate identifiers.
16820 &quot;a_key&quot;: &quot;A String&quot;,
16821 },
16822 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
16823 # identifiers.
16824 &quot;a_key&quot;: &quot;A String&quot;,
16825 },
16826 },
16827 },
16828 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
16829 # message that was returned, such as `NOT FOUND`.
16830 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
16831 # status code that was returned. For example, a `404` means the
16832 # resource was not found.
16833 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
16834 # defined by the server.
16835 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
16836 # This value is inRFC3339
16837 # text format.
16838 &quot;instancesBulkInsertOperationMetadata&quot;: {
16839 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
16840 # Example key: zones/us-central1-a
16841 &quot;a_key&quot;: {
16842 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
16843 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
16844 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
16845 # error.
16846 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
16847 # if the flow is rolling forward or rolling back.
16848 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
16849 },
16850 },
16851 },
16852 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
16853 # Operation resources.
16854 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
16855 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
16856 # group of operations results from a `bulkInsert` API request.
16857 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
16858 # `update`, or `delete`, and so on.
16859 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
16860 # There is no requirement that this be linear or support any granularity of
16861 # operations. This should not be used to guess when the operation will be
16862 # complete. This number should monotonically increase as the operation
16863 # progresses.
16864 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
16865 # applicable when performing regional operations.
16866 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
16867 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
16868 # this field will contain information on all underlying zonal actions and
16869 # their state.
16870 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
16871 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
16872 # Example key: zones/us-central1-a
16873 &quot;a_key&quot;: {
16874 &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
16875 # populated.
16876 # different programming environments, including REST APIs and RPC APIs. It is
16877 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
16878 # three pieces of data: error code, error message, and error details.
16879 #
16880 # You can find out more about this error model and how to work with it in the
16881 # [API Design Guide](https://cloud.google.com/apis/design/errors).
16882 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
16883 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
16884 # message types for APIs to use.
16885 {
16886 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
16887 },
16888 ],
16889 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
16890 # user-facing error message should be localized and sent in the
16891 # google.rpc.Status.details field, or localized by the client.
16892 },
16893 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
16894 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
16895 },
16896 },
16897 },
16898 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
16899 # This value is inRFC3339
16900 # text format.
16901 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
16902 # following:
16903 # `PENDING`, `RUNNING`, or `DONE`.
16904 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
16905 # operation.
16906 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
16907 # of the target resource.
16908 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
16909 # operations related to creating a snapshot, this points to the disk
16910 # that the snapshot was created from.
16911 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
16912 # `[email protected]` or
16913 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
16914 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
16915 # operation, this field will be populated.
16916 {
16917 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
16918 # Engine returns NO_RESULTS_ON_PAGE if there
16919 # are no results in the response.
16920 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
16921 # value format. For example:
16922 #
16923 # &quot;data&quot;: [
16924 # {
16925 # &quot;key&quot;: &quot;scope&quot;,
16926 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
16927 # }
16928 {
16929 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
16930 # returned. For example, for warnings where there are no results in a list
16931 # request for a particular zone, this key might be scope and
16932 # the key value might be the zone name. Other examples might be a key
16933 # indicating a deprecated resource and a suggested replacement, or a
16934 # warning about invalid network settings (for example, if an instance
16935 # attempts to perform IP forwarding but is not enabled for IP forwarding).
16936 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
16937 },
16938 ],
16939 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
16940 },
16941 ],
16942 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
16943 # applicable when performing per-zone operations.
16944 }</pre>
16945 </div>
16946
16947 <div class="method">
16948 <code class="details" id="setServiceAccount">setServiceAccount(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
16949 <pre>Sets the service account on the instance. For more information,
16950 readChanging
16951 the service account and access scopes for an instance.
16952
16953 Args:
16954 project: string, Project ID for this request. (required)
16955 zone: string, The name of the zone for this request. (required)
16956 instance: string, Name of the instance resource to start. (required)
16957 body: object, The request body.
16958 The object takes the form of:
16959
16960 {
16961 &quot;email&quot;: &quot;A String&quot;, # Email address of the service account.
16962 &quot;scopes&quot;: [ # The list of scopes to be made available for this service account.
16963 &quot;A String&quot;,
16964 ],
16965 }
16966
16967 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
16968 that if you must retry your request, the server will know to ignore the
16969 request if it has already been completed.
16970
16971 For example, consider a situation where you make an initial request and
16972 the request times out. If you make the request again with the same
16973 request ID, the server can check if original operation with the same
16974 request ID was received, and if so, will ignore the second request. This
16975 prevents clients from accidentally creating duplicate commitments.
16976
16977 The request ID must be
16978 a valid UUID with the exception that zero UUID is not supported
16979 (00000000-0000-0000-0000-000000000000).
16980 x__xgafv: string, V1 error format.
16981 Allowed values
16982 1 - v1 error format
16983 2 - v2 error format
16984
16985 Returns:
16986 An object of the form:
16987
16988 { # Represents an Operation resource.
16989 #
16990 # Google Compute Engine has three Operation resources:
16991 #
16992 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
16993 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
16994 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
16995 #
16996 # You can use an operation resource to manage asynchronous API requests.
16997 # For more information, readHandling
16998 # API responses.
16999 #
17000 # Operations can be global, regional or zonal.
17001 #
17002 # - For global operations, use the `globalOperations`
17003 # resource.
17004 # - For regional operations, use the
17005 # `regionOperations` resource.
17006 # - For zonal operations, use
17007 # the `zoneOperations` resource.
17008 #
17009 #
17010 #
17011 # For more information, read
17012 # Global, Regional, and Zonal Resources.
17013 #
17014 # Note that completed Operation resources have a limited
17015 # retention period.
17016 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
17017 # Not present otherwise.
17018 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
17019 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
17020 # set when the operation is created.
17021 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
17022 # text format.
17023 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
17024 # this field will be populated.
17025 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
17026 # operation.
17027 {
17028 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
17029 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
17030 # details. There is a set of defined message types to use for providing
17031 # details.The syntax depends on the error code. For example,
17032 # QuotaExceededInfo will have details when the error code is
17033 # QUOTA_EXCEEDED.
17034 {
17035 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
17036 #
17037 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
17038 # is not enabled:
17039 #
17040 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
17041 # &quot;domain&quot;: &quot;googleapis.com&quot;
17042 # &quot;metadata&quot;: {
17043 # &quot;resource&quot;: &quot;projects/123&quot;,
17044 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
17045 # }
17046 # }
17047 #
17048 # This response indicates that the pubsub.googleapis.com API is not enabled.
17049 #
17050 # Example of an error that is returned when attempting to create a Spanner
17051 # instance in a region that is out of stock:
17052 #
17053 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
17054 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
17055 # &quot;metadata&quot;: {
17056 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
17057 # }
17058 # }
17059 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
17060 # is typically the registered service name of the tool or product that
17061 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
17062 # generated by some common infrastructure, the error domain must be a
17063 # globally unique value that identifies the infrastructure. For Google API
17064 # infrastructure, the error domain is &quot;googleapis.com&quot;.
17065 &quot;metadatas&quot;: { # Additional structured details about this error.
17066 #
17067 # Keys must match a regular expression of `a-z+` but should
17068 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
17069 # length. When identifying the current value of an exceeded limit, the units
17070 # should be contained in the key, not the value. For example, rather than
17071 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
17072 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
17073 # instances that can be created in a single (batch) request.
17074 &quot;a_key&quot;: &quot;A String&quot;,
17075 },
17076 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
17077 # proximate cause of the error. Error reasons are unique within a particular
17078 # domain of errors. This should be at most 63 characters and match a
17079 # regular expression of `A-Z+[A-Z0-9]`, which represents
17080 # UPPER_SNAKE_CASE.
17081 },
17082 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
17083 #
17084 # For example, if a quota check failed with an error indicating the calling
17085 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
17086 # directly to the right place in the developer console to flip the bit.
17087 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
17088 { # Describes a URL link.
17089 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
17090 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
17091 },
17092 ],
17093 },
17094 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
17095 # which can be attached to an RPC error.
17096 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
17097 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
17098 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
17099 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
17100 },
17101 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
17102 &quot;dimensions&quot;: { # The map holding related quota dimensions.
17103 &quot;a_key&quot;: &quot;A String&quot;,
17104 },
17105 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
17106 # type or metric.
17107 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
17108 # or metric.
17109 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
17110 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
17111 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
17112 },
17113 },
17114 ],
17115 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
17116 # This property is optional.
17117 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
17118 },
17119 ],
17120 },
17121 &quot;getVersionOperationMetadata&quot;: {
17122 &quot;inlineSbomInfo&quot;: {
17123 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
17124 # appropriate identifiers.
17125 &quot;a_key&quot;: &quot;A String&quot;,
17126 },
17127 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
17128 # identifiers.
17129 &quot;a_key&quot;: &quot;A String&quot;,
17130 },
17131 },
17132 },
17133 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
17134 # message that was returned, such as `NOT FOUND`.
17135 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
17136 # status code that was returned. For example, a `404` means the
17137 # resource was not found.
17138 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
17139 # defined by the server.
17140 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
17141 # This value is inRFC3339
17142 # text format.
17143 &quot;instancesBulkInsertOperationMetadata&quot;: {
17144 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
17145 # Example key: zones/us-central1-a
17146 &quot;a_key&quot;: {
17147 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
17148 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
17149 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
17150 # error.
17151 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
17152 # if the flow is rolling forward or rolling back.
17153 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
17154 },
17155 },
17156 },
17157 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
17158 # Operation resources.
17159 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
17160 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
17161 # group of operations results from a `bulkInsert` API request.
17162 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
17163 # `update`, or `delete`, and so on.
17164 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
17165 # There is no requirement that this be linear or support any granularity of
17166 # operations. This should not be used to guess when the operation will be
17167 # complete. This number should monotonically increase as the operation
17168 # progresses.
17169 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
17170 # applicable when performing regional operations.
17171 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
17172 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
17173 # this field will contain information on all underlying zonal actions and
17174 # their state.
17175 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
17176 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
17177 # Example key: zones/us-central1-a
17178 &quot;a_key&quot;: {
17179 &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
17180 # populated.
17181 # different programming environments, including REST APIs and RPC APIs. It is
17182 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
17183 # three pieces of data: error code, error message, and error details.
17184 #
17185 # You can find out more about this error model and how to work with it in the
17186 # [API Design Guide](https://cloud.google.com/apis/design/errors).
17187 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
17188 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
17189 # message types for APIs to use.
17190 {
17191 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
17192 },
17193 ],
17194 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
17195 # user-facing error message should be localized and sent in the
17196 # google.rpc.Status.details field, or localized by the client.
17197 },
17198 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
17199 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
17200 },
17201 },
17202 },
17203 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
17204 # This value is inRFC3339
17205 # text format.
17206 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
17207 # following:
17208 # `PENDING`, `RUNNING`, or `DONE`.
17209 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
17210 # operation.
17211 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
17212 # of the target resource.
17213 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
17214 # operations related to creating a snapshot, this points to the disk
17215 # that the snapshot was created from.
17216 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
17217 # `[email protected]` or
17218 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
17219 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
17220 # operation, this field will be populated.
17221 {
17222 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
17223 # Engine returns NO_RESULTS_ON_PAGE if there
17224 # are no results in the response.
17225 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
17226 # value format. For example:
17227 #
17228 # &quot;data&quot;: [
17229 # {
17230 # &quot;key&quot;: &quot;scope&quot;,
17231 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
17232 # }
17233 {
17234 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
17235 # returned. For example, for warnings where there are no results in a list
17236 # request for a particular zone, this key might be scope and
17237 # the key value might be the zone name. Other examples might be a key
17238 # indicating a deprecated resource and a suggested replacement, or a
17239 # warning about invalid network settings (for example, if an instance
17240 # attempts to perform IP forwarding but is not enabled for IP forwarding).
17241 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
17242 },
17243 ],
17244 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
17245 },
17246 ],
17247 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
17248 # applicable when performing per-zone operations.
17249 }</pre>
17250 </div>
17251
17252 <div class="method">
17253 <code class="details" id="setShieldedInstanceIntegrityPolicy">setShieldedInstanceIntegrityPolicy(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
17254 <pre>Sets the Shielded Instance integrity policy for an instance. You can
17255 only use this method on a running instance. This method
17256 supports PATCH semantics and uses the JSON merge
17257 patch format and processing rules.
17258
17259 Args:
17260 project: string, Project ID for this request. (required)
17261 zone: string, The name of the zone for this request. (required)
17262 instance: string, Name or id of the instance scoping this request. (required)
17263 body: object, The request body.
17264 The object takes the form of:
17265
17266 { # The policy describes the baseline against which
17267 # Instance boot integrity is measured.
17268 &quot;updateAutoLearnPolicy&quot;: True or False, # Updates the integrity policy baseline using the
17269 # measurements from the VM instance&#x27;s most recent boot.
17270 }
17271
17272 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
17273 that if you must retry your request, the server will know to ignore the
17274 request if it has already been completed.
17275
17276 For example, consider a situation where you make an initial request and
17277 the request times out. If you make the request again with the same
17278 request ID, the server can check if original operation with the same
17279 request ID was received, and if so, will ignore the second request. This
17280 prevents clients from accidentally creating duplicate commitments.
17281
17282 The request ID must be
17283 a valid UUID with the exception that zero UUID is not supported
17284 (00000000-0000-0000-0000-000000000000).
17285 x__xgafv: string, V1 error format.
17286 Allowed values
17287 1 - v1 error format
17288 2 - v2 error format
17289
17290 Returns:
17291 An object of the form:
17292
17293 { # Represents an Operation resource.
17294 #
17295 # Google Compute Engine has three Operation resources:
17296 #
17297 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
17298 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
17299 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
17300 #
17301 # You can use an operation resource to manage asynchronous API requests.
17302 # For more information, readHandling
17303 # API responses.
17304 #
17305 # Operations can be global, regional or zonal.
17306 #
17307 # - For global operations, use the `globalOperations`
17308 # resource.
17309 # - For regional operations, use the
17310 # `regionOperations` resource.
17311 # - For zonal operations, use
17312 # the `zoneOperations` resource.
17313 #
17314 #
17315 #
17316 # For more information, read
17317 # Global, Regional, and Zonal Resources.
17318 #
17319 # Note that completed Operation resources have a limited
17320 # retention period.
17321 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
17322 # Not present otherwise.
17323 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
17324 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
17325 # set when the operation is created.
17326 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
17327 # text format.
17328 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
17329 # this field will be populated.
17330 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
17331 # operation.
17332 {
17333 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
17334 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
17335 # details. There is a set of defined message types to use for providing
17336 # details.The syntax depends on the error code. For example,
17337 # QuotaExceededInfo will have details when the error code is
17338 # QUOTA_EXCEEDED.
17339 {
17340 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
17341 #
17342 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
17343 # is not enabled:
17344 #
17345 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
17346 # &quot;domain&quot;: &quot;googleapis.com&quot;
17347 # &quot;metadata&quot;: {
17348 # &quot;resource&quot;: &quot;projects/123&quot;,
17349 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
17350 # }
17351 # }
17352 #
17353 # This response indicates that the pubsub.googleapis.com API is not enabled.
17354 #
17355 # Example of an error that is returned when attempting to create a Spanner
17356 # instance in a region that is out of stock:
17357 #
17358 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
17359 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
17360 # &quot;metadata&quot;: {
17361 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
17362 # }
17363 # }
17364 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
17365 # is typically the registered service name of the tool or product that
17366 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
17367 # generated by some common infrastructure, the error domain must be a
17368 # globally unique value that identifies the infrastructure. For Google API
17369 # infrastructure, the error domain is &quot;googleapis.com&quot;.
17370 &quot;metadatas&quot;: { # Additional structured details about this error.
17371 #
17372 # Keys must match a regular expression of `a-z+` but should
17373 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
17374 # length. When identifying the current value of an exceeded limit, the units
17375 # should be contained in the key, not the value. For example, rather than
17376 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
17377 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
17378 # instances that can be created in a single (batch) request.
17379 &quot;a_key&quot;: &quot;A String&quot;,
17380 },
17381 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
17382 # proximate cause of the error. Error reasons are unique within a particular
17383 # domain of errors. This should be at most 63 characters and match a
17384 # regular expression of `A-Z+[A-Z0-9]`, which represents
17385 # UPPER_SNAKE_CASE.
17386 },
17387 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
17388 #
17389 # For example, if a quota check failed with an error indicating the calling
17390 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
17391 # directly to the right place in the developer console to flip the bit.
17392 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
17393 { # Describes a URL link.
17394 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
17395 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
17396 },
17397 ],
17398 },
17399 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
17400 # which can be attached to an RPC error.
17401 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
17402 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
17403 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
17404 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
17405 },
17406 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
17407 &quot;dimensions&quot;: { # The map holding related quota dimensions.
17408 &quot;a_key&quot;: &quot;A String&quot;,
17409 },
17410 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
17411 # type or metric.
17412 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
17413 # or metric.
17414 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
17415 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
17416 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
17417 },
17418 },
17419 ],
17420 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
17421 # This property is optional.
17422 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
17423 },
17424 ],
17425 },
17426 &quot;getVersionOperationMetadata&quot;: {
17427 &quot;inlineSbomInfo&quot;: {
17428 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
17429 # appropriate identifiers.
17430 &quot;a_key&quot;: &quot;A String&quot;,
17431 },
17432 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
17433 # identifiers.
17434 &quot;a_key&quot;: &quot;A String&quot;,
17435 },
17436 },
17437 },
17438 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
17439 # message that was returned, such as `NOT FOUND`.
17440 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
17441 # status code that was returned. For example, a `404` means the
17442 # resource was not found.
17443 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
17444 # defined by the server.
17445 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
17446 # This value is inRFC3339
17447 # text format.
17448 &quot;instancesBulkInsertOperationMetadata&quot;: {
17449 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
17450 # Example key: zones/us-central1-a
17451 &quot;a_key&quot;: {
17452 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
17453 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
17454 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
17455 # error.
17456 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
17457 # if the flow is rolling forward or rolling back.
17458 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
17459 },
17460 },
17461 },
17462 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
17463 # Operation resources.
17464 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
17465 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
17466 # group of operations results from a `bulkInsert` API request.
17467 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
17468 # `update`, or `delete`, and so on.
17469 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
17470 # There is no requirement that this be linear or support any granularity of
17471 # operations. This should not be used to guess when the operation will be
17472 # complete. This number should monotonically increase as the operation
17473 # progresses.
17474 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
17475 # applicable when performing regional operations.
17476 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
17477 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
17478 # this field will contain information on all underlying zonal actions and
17479 # their state.
17480 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
17481 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
17482 # Example key: zones/us-central1-a
17483 &quot;a_key&quot;: {
17484 &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
17485 # populated.
17486 # different programming environments, including REST APIs and RPC APIs. It is
17487 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
17488 # three pieces of data: error code, error message, and error details.
17489 #
17490 # You can find out more about this error model and how to work with it in the
17491 # [API Design Guide](https://cloud.google.com/apis/design/errors).
17492 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
17493 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
17494 # message types for APIs to use.
17495 {
17496 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
17497 },
17498 ],
17499 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
17500 # user-facing error message should be localized and sent in the
17501 # google.rpc.Status.details field, or localized by the client.
17502 },
17503 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
17504 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
17505 },
17506 },
17507 },
17508 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
17509 # This value is inRFC3339
17510 # text format.
17511 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
17512 # following:
17513 # `PENDING`, `RUNNING`, or `DONE`.
17514 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
17515 # operation.
17516 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
17517 # of the target resource.
17518 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
17519 # operations related to creating a snapshot, this points to the disk
17520 # that the snapshot was created from.
17521 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
17522 # `[email protected]` or
17523 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
17524 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
17525 # operation, this field will be populated.
17526 {
17527 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
17528 # Engine returns NO_RESULTS_ON_PAGE if there
17529 # are no results in the response.
17530 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
17531 # value format. For example:
17532 #
17533 # &quot;data&quot;: [
17534 # {
17535 # &quot;key&quot;: &quot;scope&quot;,
17536 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
17537 # }
17538 {
17539 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
17540 # returned. For example, for warnings where there are no results in a list
17541 # request for a particular zone, this key might be scope and
17542 # the key value might be the zone name. Other examples might be a key
17543 # indicating a deprecated resource and a suggested replacement, or a
17544 # warning about invalid network settings (for example, if an instance
17545 # attempts to perform IP forwarding but is not enabled for IP forwarding).
17546 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
17547 },
17548 ],
17549 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
17550 },
17551 ],
17552 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
17553 # applicable when performing per-zone operations.
17554 }</pre>
17555 </div>
17556
17557 <div class="method">
17558 <code class="details" id="setTags">setTags(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
17559 <pre>Sets network tags
17560 for the specified instance to the data included in the request.
17561
17562 Args:
17563 project: string, Project ID for this request. (required)
17564 zone: string, The name of the zone for this request. (required)
17565 instance: string, Name of the instance scoping this request. (required)
17566 body: object, The request body.
17567 The object takes the form of:
17568
17569 { # A set of instance tags.
17570 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
17571 # the tags&#x27; contents and used for optimistic locking. The
17572 # fingerprint is initially generated by Compute Engine and changes after
17573 # every request to modify or update tags. You must always provide an
17574 # up-to-date fingerprint hash in order to update or change tags.
17575 #
17576 # To see the latest fingerprint, make get() request to the
17577 # instance.
17578 &quot;items&quot;: [ # An array of tags. Each tag must be 1-63 characters long, and comply
17579 # with RFC1035.
17580 &quot;A String&quot;,
17581 ],
17582 }
17583
17584 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
17585 that if you must retry your request, the server will know to ignore the
17586 request if it has already been completed.
17587
17588 For example, consider a situation where you make an initial request and
17589 the request times out. If you make the request again with the same
17590 request ID, the server can check if original operation with the same
17591 request ID was received, and if so, will ignore the second request. This
17592 prevents clients from accidentally creating duplicate commitments.
17593
17594 The request ID must be
17595 a valid UUID with the exception that zero UUID is not supported
17596 (00000000-0000-0000-0000-000000000000).
17597 x__xgafv: string, V1 error format.
17598 Allowed values
17599 1 - v1 error format
17600 2 - v2 error format
17601
17602 Returns:
17603 An object of the form:
17604
17605 { # Represents an Operation resource.
17606 #
17607 # Google Compute Engine has three Operation resources:
17608 #
17609 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
17610 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
17611 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
17612 #
17613 # You can use an operation resource to manage asynchronous API requests.
17614 # For more information, readHandling
17615 # API responses.
17616 #
17617 # Operations can be global, regional or zonal.
17618 #
17619 # - For global operations, use the `globalOperations`
17620 # resource.
17621 # - For regional operations, use the
17622 # `regionOperations` resource.
17623 # - For zonal operations, use
17624 # the `zoneOperations` resource.
17625 #
17626 #
17627 #
17628 # For more information, read
17629 # Global, Regional, and Zonal Resources.
17630 #
17631 # Note that completed Operation resources have a limited
17632 # retention period.
17633 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
17634 # Not present otherwise.
17635 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
17636 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
17637 # set when the operation is created.
17638 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
17639 # text format.
17640 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
17641 # this field will be populated.
17642 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
17643 # operation.
17644 {
17645 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
17646 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
17647 # details. There is a set of defined message types to use for providing
17648 # details.The syntax depends on the error code. For example,
17649 # QuotaExceededInfo will have details when the error code is
17650 # QUOTA_EXCEEDED.
17651 {
17652 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
17653 #
17654 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
17655 # is not enabled:
17656 #
17657 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
17658 # &quot;domain&quot;: &quot;googleapis.com&quot;
17659 # &quot;metadata&quot;: {
17660 # &quot;resource&quot;: &quot;projects/123&quot;,
17661 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
17662 # }
17663 # }
17664 #
17665 # This response indicates that the pubsub.googleapis.com API is not enabled.
17666 #
17667 # Example of an error that is returned when attempting to create a Spanner
17668 # instance in a region that is out of stock:
17669 #
17670 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
17671 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
17672 # &quot;metadata&quot;: {
17673 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
17674 # }
17675 # }
17676 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
17677 # is typically the registered service name of the tool or product that
17678 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
17679 # generated by some common infrastructure, the error domain must be a
17680 # globally unique value that identifies the infrastructure. For Google API
17681 # infrastructure, the error domain is &quot;googleapis.com&quot;.
17682 &quot;metadatas&quot;: { # Additional structured details about this error.
17683 #
17684 # Keys must match a regular expression of `a-z+` but should
17685 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
17686 # length. When identifying the current value of an exceeded limit, the units
17687 # should be contained in the key, not the value. For example, rather than
17688 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
17689 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
17690 # instances that can be created in a single (batch) request.
17691 &quot;a_key&quot;: &quot;A String&quot;,
17692 },
17693 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
17694 # proximate cause of the error. Error reasons are unique within a particular
17695 # domain of errors. This should be at most 63 characters and match a
17696 # regular expression of `A-Z+[A-Z0-9]`, which represents
17697 # UPPER_SNAKE_CASE.
17698 },
17699 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
17700 #
17701 # For example, if a quota check failed with an error indicating the calling
17702 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
17703 # directly to the right place in the developer console to flip the bit.
17704 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
17705 { # Describes a URL link.
17706 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
17707 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
17708 },
17709 ],
17710 },
17711 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
17712 # which can be attached to an RPC error.
17713 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
17714 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
17715 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
17716 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
17717 },
17718 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
17719 &quot;dimensions&quot;: { # The map holding related quota dimensions.
17720 &quot;a_key&quot;: &quot;A String&quot;,
17721 },
17722 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
17723 # type or metric.
17724 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
17725 # or metric.
17726 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
17727 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
17728 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
17729 },
17730 },
17731 ],
17732 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
17733 # This property is optional.
17734 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
17735 },
17736 ],
17737 },
17738 &quot;getVersionOperationMetadata&quot;: {
17739 &quot;inlineSbomInfo&quot;: {
17740 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
17741 # appropriate identifiers.
17742 &quot;a_key&quot;: &quot;A String&quot;,
17743 },
17744 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
17745 # identifiers.
17746 &quot;a_key&quot;: &quot;A String&quot;,
17747 },
17748 },
17749 },
17750 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
17751 # message that was returned, such as `NOT FOUND`.
17752 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
17753 # status code that was returned. For example, a `404` means the
17754 # resource was not found.
17755 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
17756 # defined by the server.
17757 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
17758 # This value is inRFC3339
17759 # text format.
17760 &quot;instancesBulkInsertOperationMetadata&quot;: {
17761 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
17762 # Example key: zones/us-central1-a
17763 &quot;a_key&quot;: {
17764 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
17765 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
17766 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
17767 # error.
17768 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
17769 # if the flow is rolling forward or rolling back.
17770 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
17771 },
17772 },
17773 },
17774 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
17775 # Operation resources.
17776 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
17777 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
17778 # group of operations results from a `bulkInsert` API request.
17779 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
17780 # `update`, or `delete`, and so on.
17781 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
17782 # There is no requirement that this be linear or support any granularity of
17783 # operations. This should not be used to guess when the operation will be
17784 # complete. This number should monotonically increase as the operation
17785 # progresses.
17786 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
17787 # applicable when performing regional operations.
17788 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
17789 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
17790 # this field will contain information on all underlying zonal actions and
17791 # their state.
17792 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
17793 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
17794 # Example key: zones/us-central1-a
17795 &quot;a_key&quot;: {
17796 &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
17797 # populated.
17798 # different programming environments, including REST APIs and RPC APIs. It is
17799 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
17800 # three pieces of data: error code, error message, and error details.
17801 #
17802 # You can find out more about this error model and how to work with it in the
17803 # [API Design Guide](https://cloud.google.com/apis/design/errors).
17804 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
17805 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
17806 # message types for APIs to use.
17807 {
17808 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
17809 },
17810 ],
17811 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
17812 # user-facing error message should be localized and sent in the
17813 # google.rpc.Status.details field, or localized by the client.
17814 },
17815 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
17816 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
17817 },
17818 },
17819 },
17820 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
17821 # This value is inRFC3339
17822 # text format.
17823 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
17824 # following:
17825 # `PENDING`, `RUNNING`, or `DONE`.
17826 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
17827 # operation.
17828 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
17829 # of the target resource.
17830 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
17831 # operations related to creating a snapshot, this points to the disk
17832 # that the snapshot was created from.
17833 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
17834 # `[email protected]` or
17835 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
17836 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
17837 # operation, this field will be populated.
17838 {
17839 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
17840 # Engine returns NO_RESULTS_ON_PAGE if there
17841 # are no results in the response.
17842 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
17843 # value format. For example:
17844 #
17845 # &quot;data&quot;: [
17846 # {
17847 # &quot;key&quot;: &quot;scope&quot;,
17848 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
17849 # }
17850 {
17851 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
17852 # returned. For example, for warnings where there are no results in a list
17853 # request for a particular zone, this key might be scope and
17854 # the key value might be the zone name. Other examples might be a key
17855 # indicating a deprecated resource and a suggested replacement, or a
17856 # warning about invalid network settings (for example, if an instance
17857 # attempts to perform IP forwarding but is not enabled for IP forwarding).
17858 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
17859 },
17860 ],
17861 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
17862 },
17863 ],
17864 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
17865 # applicable when performing per-zone operations.
17866 }</pre>
17867 </div>
17868
17869 <div class="method">
17870 <code class="details" id="simulateMaintenanceEvent">simulateMaintenanceEvent(project, zone, instance, requestId=None, withExtendedNotifications=None, x__xgafv=None)</code>
17871 <pre>Simulates a host maintenance event on a VM. For more information, see
17872 Simulate a host maintenance event.
17873
17874 Args:
17875 project: string, Project ID for this request. (required)
17876 zone: string, The name of the zone for this request. (required)
17877 instance: string, Name of the instance scoping this request. (required)
17878 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
17879 that if you must retry your request, the server will know to ignore the
17880 request if it has already been completed.
17881
17882 For example, consider a situation where you make an initial request and
17883 the request times out. If you make the request again with the same
17884 request ID, the server can check if original operation with the same
17885 request ID was received, and if so, will ignore the second request. This
17886 prevents clients from accidentally creating duplicate commitments.
17887
17888 The request ID must be
17889 a valid UUID with the exception that zero UUID is not supported
17890 (00000000-0000-0000-0000-000000000000).
17891 withExtendedNotifications: boolean, Determines whether the customers receive notifications before migration.
17892 Only applicable to SF vms.
17893 x__xgafv: string, V1 error format.
17894 Allowed values
17895 1 - v1 error format
17896 2 - v2 error format
17897
17898 Returns:
17899 An object of the form:
17900
17901 { # Represents an Operation resource.
17902 #
17903 # Google Compute Engine has three Operation resources:
17904 #
17905 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
17906 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
17907 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
17908 #
17909 # You can use an operation resource to manage asynchronous API requests.
17910 # For more information, readHandling
17911 # API responses.
17912 #
17913 # Operations can be global, regional or zonal.
17914 #
17915 # - For global operations, use the `globalOperations`
17916 # resource.
17917 # - For regional operations, use the
17918 # `regionOperations` resource.
17919 # - For zonal operations, use
17920 # the `zoneOperations` resource.
17921 #
17922 #
17923 #
17924 # For more information, read
17925 # Global, Regional, and Zonal Resources.
17926 #
17927 # Note that completed Operation resources have a limited
17928 # retention period.
17929 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
17930 # Not present otherwise.
17931 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
17932 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
17933 # set when the operation is created.
17934 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
17935 # text format.
17936 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
17937 # this field will be populated.
17938 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
17939 # operation.
17940 {
17941 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
17942 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
17943 # details. There is a set of defined message types to use for providing
17944 # details.The syntax depends on the error code. For example,
17945 # QuotaExceededInfo will have details when the error code is
17946 # QUOTA_EXCEEDED.
17947 {
17948 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
17949 #
17950 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
17951 # is not enabled:
17952 #
17953 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
17954 # &quot;domain&quot;: &quot;googleapis.com&quot;
17955 # &quot;metadata&quot;: {
17956 # &quot;resource&quot;: &quot;projects/123&quot;,
17957 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
17958 # }
17959 # }
17960 #
17961 # This response indicates that the pubsub.googleapis.com API is not enabled.
17962 #
17963 # Example of an error that is returned when attempting to create a Spanner
17964 # instance in a region that is out of stock:
17965 #
17966 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
17967 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
17968 # &quot;metadata&quot;: {
17969 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
17970 # }
17971 # }
17972 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
17973 # is typically the registered service name of the tool or product that
17974 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
17975 # generated by some common infrastructure, the error domain must be a
17976 # globally unique value that identifies the infrastructure. For Google API
17977 # infrastructure, the error domain is &quot;googleapis.com&quot;.
17978 &quot;metadatas&quot;: { # Additional structured details about this error.
17979 #
17980 # Keys must match a regular expression of `a-z+` but should
17981 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
17982 # length. When identifying the current value of an exceeded limit, the units
17983 # should be contained in the key, not the value. For example, rather than
17984 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
17985 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
17986 # instances that can be created in a single (batch) request.
17987 &quot;a_key&quot;: &quot;A String&quot;,
17988 },
17989 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
17990 # proximate cause of the error. Error reasons are unique within a particular
17991 # domain of errors. This should be at most 63 characters and match a
17992 # regular expression of `A-Z+[A-Z0-9]`, which represents
17993 # UPPER_SNAKE_CASE.
17994 },
17995 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
17996 #
17997 # For example, if a quota check failed with an error indicating the calling
17998 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
17999 # directly to the right place in the developer console to flip the bit.
18000 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
18001 { # Describes a URL link.
18002 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
18003 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
18004 },
18005 ],
18006 },
18007 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
18008 # which can be attached to an RPC error.
18009 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
18010 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
18011 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
18012 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
18013 },
18014 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
18015 &quot;dimensions&quot;: { # The map holding related quota dimensions.
18016 &quot;a_key&quot;: &quot;A String&quot;,
18017 },
18018 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
18019 # type or metric.
18020 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
18021 # or metric.
18022 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
18023 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
18024 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
18025 },
18026 },
18027 ],
18028 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
18029 # This property is optional.
18030 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
18031 },
18032 ],
18033 },
18034 &quot;getVersionOperationMetadata&quot;: {
18035 &quot;inlineSbomInfo&quot;: {
18036 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
18037 # appropriate identifiers.
18038 &quot;a_key&quot;: &quot;A String&quot;,
18039 },
18040 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
18041 # identifiers.
18042 &quot;a_key&quot;: &quot;A String&quot;,
18043 },
18044 },
18045 },
18046 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
18047 # message that was returned, such as `NOT FOUND`.
18048 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
18049 # status code that was returned. For example, a `404` means the
18050 # resource was not found.
18051 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
18052 # defined by the server.
18053 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
18054 # This value is inRFC3339
18055 # text format.
18056 &quot;instancesBulkInsertOperationMetadata&quot;: {
18057 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
18058 # Example key: zones/us-central1-a
18059 &quot;a_key&quot;: {
18060 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
18061 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
18062 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
18063 # error.
18064 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
18065 # if the flow is rolling forward or rolling back.
18066 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
18067 },
18068 },
18069 },
18070 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
18071 # Operation resources.
18072 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
18073 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
18074 # group of operations results from a `bulkInsert` API request.
18075 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
18076 # `update`, or `delete`, and so on.
18077 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
18078 # There is no requirement that this be linear or support any granularity of
18079 # operations. This should not be used to guess when the operation will be
18080 # complete. This number should monotonically increase as the operation
18081 # progresses.
18082 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
18083 # applicable when performing regional operations.
18084 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
18085 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
18086 # this field will contain information on all underlying zonal actions and
18087 # their state.
18088 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
18089 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
18090 # Example key: zones/us-central1-a
18091 &quot;a_key&quot;: {
18092 &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
18093 # populated.
18094 # different programming environments, including REST APIs and RPC APIs. It is
18095 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
18096 # three pieces of data: error code, error message, and error details.
18097 #
18098 # You can find out more about this error model and how to work with it in the
18099 # [API Design Guide](https://cloud.google.com/apis/design/errors).
18100 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
18101 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
18102 # message types for APIs to use.
18103 {
18104 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
18105 },
18106 ],
18107 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
18108 # user-facing error message should be localized and sent in the
18109 # google.rpc.Status.details field, or localized by the client.
18110 },
18111 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
18112 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
18113 },
18114 },
18115 },
18116 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
18117 # This value is inRFC3339
18118 # text format.
18119 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
18120 # following:
18121 # `PENDING`, `RUNNING`, or `DONE`.
18122 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
18123 # operation.
18124 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
18125 # of the target resource.
18126 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
18127 # operations related to creating a snapshot, this points to the disk
18128 # that the snapshot was created from.
18129 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
18130 # `[email protected]` or
18131 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
18132 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
18133 # operation, this field will be populated.
18134 {
18135 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
18136 # Engine returns NO_RESULTS_ON_PAGE if there
18137 # are no results in the response.
18138 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
18139 # value format. For example:
18140 #
18141 # &quot;data&quot;: [
18142 # {
18143 # &quot;key&quot;: &quot;scope&quot;,
18144 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
18145 # }
18146 {
18147 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
18148 # returned. For example, for warnings where there are no results in a list
18149 # request for a particular zone, this key might be scope and
18150 # the key value might be the zone name. Other examples might be a key
18151 # indicating a deprecated resource and a suggested replacement, or a
18152 # warning about invalid network settings (for example, if an instance
18153 # attempts to perform IP forwarding but is not enabled for IP forwarding).
18154 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
18155 },
18156 ],
18157 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
18158 },
18159 ],
18160 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
18161 # applicable when performing per-zone operations.
18162 }</pre>
18163 </div>
18164
18165 <div class="method">
18166 <code class="details" id="start">start(project, zone, instance, requestId=None, x__xgafv=None)</code>
18167 <pre>Starts an instance that was stopped using theinstances().stop
18168 method. For more information, seeRestart an
18169 instance.
18170
18171 Args:
18172 project: string, Project ID for this request. (required)
18173 zone: string, The name of the zone for this request. (required)
18174 instance: string, Name of the instance resource to start. (required)
18175 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
18176 that if you must retry your request, the server will know to ignore the
18177 request if it has already been completed.
18178
18179 For example, consider a situation where you make an initial request and
18180 the request times out. If you make the request again with the same
18181 request ID, the server can check if original operation with the same
18182 request ID was received, and if so, will ignore the second request. This
18183 prevents clients from accidentally creating duplicate commitments.
18184
18185 The request ID must be
18186 a valid UUID with the exception that zero UUID is not supported
18187 (00000000-0000-0000-0000-000000000000).
18188 x__xgafv: string, V1 error format.
18189 Allowed values
18190 1 - v1 error format
18191 2 - v2 error format
18192
18193 Returns:
18194 An object of the form:
18195
18196 { # Represents an Operation resource.
18197 #
18198 # Google Compute Engine has three Operation resources:
18199 #
18200 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
18201 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
18202 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
18203 #
18204 # You can use an operation resource to manage asynchronous API requests.
18205 # For more information, readHandling
18206 # API responses.
18207 #
18208 # Operations can be global, regional or zonal.
18209 #
18210 # - For global operations, use the `globalOperations`
18211 # resource.
18212 # - For regional operations, use the
18213 # `regionOperations` resource.
18214 # - For zonal operations, use
18215 # the `zoneOperations` resource.
18216 #
18217 #
18218 #
18219 # For more information, read
18220 # Global, Regional, and Zonal Resources.
18221 #
18222 # Note that completed Operation resources have a limited
18223 # retention period.
18224 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
18225 # Not present otherwise.
18226 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
18227 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
18228 # set when the operation is created.
18229 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
18230 # text format.
18231 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
18232 # this field will be populated.
18233 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
18234 # operation.
18235 {
18236 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
18237 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
18238 # details. There is a set of defined message types to use for providing
18239 # details.The syntax depends on the error code. For example,
18240 # QuotaExceededInfo will have details when the error code is
18241 # QUOTA_EXCEEDED.
18242 {
18243 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
18244 #
18245 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
18246 # is not enabled:
18247 #
18248 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
18249 # &quot;domain&quot;: &quot;googleapis.com&quot;
18250 # &quot;metadata&quot;: {
18251 # &quot;resource&quot;: &quot;projects/123&quot;,
18252 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
18253 # }
18254 # }
18255 #
18256 # This response indicates that the pubsub.googleapis.com API is not enabled.
18257 #
18258 # Example of an error that is returned when attempting to create a Spanner
18259 # instance in a region that is out of stock:
18260 #
18261 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
18262 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
18263 # &quot;metadata&quot;: {
18264 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
18265 # }
18266 # }
18267 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
18268 # is typically the registered service name of the tool or product that
18269 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
18270 # generated by some common infrastructure, the error domain must be a
18271 # globally unique value that identifies the infrastructure. For Google API
18272 # infrastructure, the error domain is &quot;googleapis.com&quot;.
18273 &quot;metadatas&quot;: { # Additional structured details about this error.
18274 #
18275 # Keys must match a regular expression of `a-z+` but should
18276 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
18277 # length. When identifying the current value of an exceeded limit, the units
18278 # should be contained in the key, not the value. For example, rather than
18279 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
18280 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
18281 # instances that can be created in a single (batch) request.
18282 &quot;a_key&quot;: &quot;A String&quot;,
18283 },
18284 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
18285 # proximate cause of the error. Error reasons are unique within a particular
18286 # domain of errors. This should be at most 63 characters and match a
18287 # regular expression of `A-Z+[A-Z0-9]`, which represents
18288 # UPPER_SNAKE_CASE.
18289 },
18290 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
18291 #
18292 # For example, if a quota check failed with an error indicating the calling
18293 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
18294 # directly to the right place in the developer console to flip the bit.
18295 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
18296 { # Describes a URL link.
18297 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
18298 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
18299 },
18300 ],
18301 },
18302 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
18303 # which can be attached to an RPC error.
18304 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
18305 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
18306 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
18307 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
18308 },
18309 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
18310 &quot;dimensions&quot;: { # The map holding related quota dimensions.
18311 &quot;a_key&quot;: &quot;A String&quot;,
18312 },
18313 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
18314 # type or metric.
18315 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
18316 # or metric.
18317 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
18318 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
18319 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
18320 },
18321 },
18322 ],
18323 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
18324 # This property is optional.
18325 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
18326 },
18327 ],
18328 },
18329 &quot;getVersionOperationMetadata&quot;: {
18330 &quot;inlineSbomInfo&quot;: {
18331 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
18332 # appropriate identifiers.
18333 &quot;a_key&quot;: &quot;A String&quot;,
18334 },
18335 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
18336 # identifiers.
18337 &quot;a_key&quot;: &quot;A String&quot;,
18338 },
18339 },
18340 },
18341 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
18342 # message that was returned, such as `NOT FOUND`.
18343 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
18344 # status code that was returned. For example, a `404` means the
18345 # resource was not found.
18346 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
18347 # defined by the server.
18348 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
18349 # This value is inRFC3339
18350 # text format.
18351 &quot;instancesBulkInsertOperationMetadata&quot;: {
18352 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
18353 # Example key: zones/us-central1-a
18354 &quot;a_key&quot;: {
18355 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
18356 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
18357 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
18358 # error.
18359 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
18360 # if the flow is rolling forward or rolling back.
18361 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
18362 },
18363 },
18364 },
18365 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
18366 # Operation resources.
18367 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
18368 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
18369 # group of operations results from a `bulkInsert` API request.
18370 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
18371 # `update`, or `delete`, and so on.
18372 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
18373 # There is no requirement that this be linear or support any granularity of
18374 # operations. This should not be used to guess when the operation will be
18375 # complete. This number should monotonically increase as the operation
18376 # progresses.
18377 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
18378 # applicable when performing regional operations.
18379 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
18380 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
18381 # this field will contain information on all underlying zonal actions and
18382 # their state.
18383 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
18384 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
18385 # Example key: zones/us-central1-a
18386 &quot;a_key&quot;: {
18387 &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
18388 # populated.
18389 # different programming environments, including REST APIs and RPC APIs. It is
18390 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
18391 # three pieces of data: error code, error message, and error details.
18392 #
18393 # You can find out more about this error model and how to work with it in the
18394 # [API Design Guide](https://cloud.google.com/apis/design/errors).
18395 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
18396 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
18397 # message types for APIs to use.
18398 {
18399 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
18400 },
18401 ],
18402 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
18403 # user-facing error message should be localized and sent in the
18404 # google.rpc.Status.details field, or localized by the client.
18405 },
18406 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
18407 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
18408 },
18409 },
18410 },
18411 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
18412 # This value is inRFC3339
18413 # text format.
18414 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
18415 # following:
18416 # `PENDING`, `RUNNING`, or `DONE`.
18417 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
18418 # operation.
18419 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
18420 # of the target resource.
18421 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
18422 # operations related to creating a snapshot, this points to the disk
18423 # that the snapshot was created from.
18424 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
18425 # `[email protected]` or
18426 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
18427 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
18428 # operation, this field will be populated.
18429 {
18430 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
18431 # Engine returns NO_RESULTS_ON_PAGE if there
18432 # are no results in the response.
18433 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
18434 # value format. For example:
18435 #
18436 # &quot;data&quot;: [
18437 # {
18438 # &quot;key&quot;: &quot;scope&quot;,
18439 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
18440 # }
18441 {
18442 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
18443 # returned. For example, for warnings where there are no results in a list
18444 # request for a particular zone, this key might be scope and
18445 # the key value might be the zone name. Other examples might be a key
18446 # indicating a deprecated resource and a suggested replacement, or a
18447 # warning about invalid network settings (for example, if an instance
18448 # attempts to perform IP forwarding but is not enabled for IP forwarding).
18449 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
18450 },
18451 ],
18452 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
18453 },
18454 ],
18455 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
18456 # applicable when performing per-zone operations.
18457 }</pre>
18458 </div>
18459
18460 <div class="method">
18461 <code class="details" id="startWithEncryptionKey">startWithEncryptionKey(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
18462 <pre>Starts an instance that was stopped using theinstances().stop
18463 method. For more information, seeRestart an
18464 instance.
18465
18466 Args:
18467 project: string, Project ID for this request. (required)
18468 zone: string, The name of the zone for this request. (required)
18469 instance: string, Name of the instance resource to start. (required)
18470 body: object, The request body.
18471 The object takes the form of:
18472
18473 {
18474 &quot;disks&quot;: [ # Array of disks associated with this instance that are protected with acustomer-supplied
18475 # encryption key.
18476 #
18477 # In order to start the instance, the disk url and its corresponding key must
18478 # be provided.
18479 #
18480 # If the disk is not protected with a customer-supplied encryption key it
18481 # should not be specified.
18482 {
18483 &quot;diskEncryptionKey&quot;: { # Decrypts data associated with the disk with acustomer-supplied
18484 # encryption key.
18485 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
18486 # For example:
18487 #
18488 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
18489 # key_region/cryptoKeys/key
18490 #
18491 # The fully-qualifed key name may be returned for resource GET requests. For
18492 # example:
18493 #
18494 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
18495 # key_region/cryptoKeys/key
18496 # /cryptoKeyVersions/1
18497 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
18498 # key. If absent, the Compute Engine default service account is used.
18499 # For example:
18500 #
18501 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
18502 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
18503 # encryption key, encoded in RFC
18504 # 4648 base64 to either encrypt or decrypt this resource. You can
18505 # provide either the rawKey or thersaEncryptedKey.
18506 # For example:
18507 #
18508 # &quot;rawKey&quot;:
18509 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
18510 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
18511 # customer-supplied encryption key to either encrypt or decrypt this
18512 # resource. You can provide either the rawKey or thersaEncryptedKey.
18513 # For example:
18514 #
18515 # &quot;rsaEncryptedKey&quot;:
18516 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
18517 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
18518 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
18519 #
18520 # The key must meet the following requirements before you can provide it to
18521 # Compute Engine:
18522 #
18523 # 1. The key is wrapped using a RSA public key certificate provided by
18524 # Google.
18525 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
18526 # encoding.
18527 #
18528 # Gets the RSA public key certificate provided by Google at:
18529 #
18530 #
18531 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
18532 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
18533 # 4648 base64 encoded SHA-256 hash of the customer-supplied
18534 # encryption key that protects this resource.
18535 },
18536 &quot;source&quot;: &quot;A String&quot;, # Specifies a valid partial or full URL to an existing Persistent Disk
18537 # resource. This field is only applicable for persistent disks.
18538 # For example:
18539 #
18540 # &quot;source&quot;: &quot;/compute/v1/projects/project_id/zones/zone/disks/
18541 # disk_name
18542 },
18543 ],
18544 }
18545
18546 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
18547 that if you must retry your request, the server will know to ignore the
18548 request if it has already been completed.
18549
18550 For example, consider a situation where you make an initial request and
18551 the request times out. If you make the request again with the same
18552 request ID, the server can check if original operation with the same
18553 request ID was received, and if so, will ignore the second request. This
18554 prevents clients from accidentally creating duplicate commitments.
18555
18556 The request ID must be
18557 a valid UUID with the exception that zero UUID is not supported
18558 (00000000-0000-0000-0000-000000000000).
18559 x__xgafv: string, V1 error format.
18560 Allowed values
18561 1 - v1 error format
18562 2 - v2 error format
18563
18564 Returns:
18565 An object of the form:
18566
18567 { # Represents an Operation resource.
18568 #
18569 # Google Compute Engine has three Operation resources:
18570 #
18571 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
18572 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
18573 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
18574 #
18575 # You can use an operation resource to manage asynchronous API requests.
18576 # For more information, readHandling
18577 # API responses.
18578 #
18579 # Operations can be global, regional or zonal.
18580 #
18581 # - For global operations, use the `globalOperations`
18582 # resource.
18583 # - For regional operations, use the
18584 # `regionOperations` resource.
18585 # - For zonal operations, use
18586 # the `zoneOperations` resource.
18587 #
18588 #
18589 #
18590 # For more information, read
18591 # Global, Regional, and Zonal Resources.
18592 #
18593 # Note that completed Operation resources have a limited
18594 # retention period.
18595 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
18596 # Not present otherwise.
18597 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
18598 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
18599 # set when the operation is created.
18600 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
18601 # text format.
18602 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
18603 # this field will be populated.
18604 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
18605 # operation.
18606 {
18607 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
18608 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
18609 # details. There is a set of defined message types to use for providing
18610 # details.The syntax depends on the error code. For example,
18611 # QuotaExceededInfo will have details when the error code is
18612 # QUOTA_EXCEEDED.
18613 {
18614 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
18615 #
18616 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
18617 # is not enabled:
18618 #
18619 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
18620 # &quot;domain&quot;: &quot;googleapis.com&quot;
18621 # &quot;metadata&quot;: {
18622 # &quot;resource&quot;: &quot;projects/123&quot;,
18623 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
18624 # }
18625 # }
18626 #
18627 # This response indicates that the pubsub.googleapis.com API is not enabled.
18628 #
18629 # Example of an error that is returned when attempting to create a Spanner
18630 # instance in a region that is out of stock:
18631 #
18632 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
18633 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
18634 # &quot;metadata&quot;: {
18635 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
18636 # }
18637 # }
18638 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
18639 # is typically the registered service name of the tool or product that
18640 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
18641 # generated by some common infrastructure, the error domain must be a
18642 # globally unique value that identifies the infrastructure. For Google API
18643 # infrastructure, the error domain is &quot;googleapis.com&quot;.
18644 &quot;metadatas&quot;: { # Additional structured details about this error.
18645 #
18646 # Keys must match a regular expression of `a-z+` but should
18647 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
18648 # length. When identifying the current value of an exceeded limit, the units
18649 # should be contained in the key, not the value. For example, rather than
18650 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
18651 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
18652 # instances that can be created in a single (batch) request.
18653 &quot;a_key&quot;: &quot;A String&quot;,
18654 },
18655 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
18656 # proximate cause of the error. Error reasons are unique within a particular
18657 # domain of errors. This should be at most 63 characters and match a
18658 # regular expression of `A-Z+[A-Z0-9]`, which represents
18659 # UPPER_SNAKE_CASE.
18660 },
18661 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
18662 #
18663 # For example, if a quota check failed with an error indicating the calling
18664 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
18665 # directly to the right place in the developer console to flip the bit.
18666 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
18667 { # Describes a URL link.
18668 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
18669 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
18670 },
18671 ],
18672 },
18673 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
18674 # which can be attached to an RPC error.
18675 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
18676 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
18677 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
18678 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
18679 },
18680 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
18681 &quot;dimensions&quot;: { # The map holding related quota dimensions.
18682 &quot;a_key&quot;: &quot;A String&quot;,
18683 },
18684 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
18685 # type or metric.
18686 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
18687 # or metric.
18688 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
18689 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
18690 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
18691 },
18692 },
18693 ],
18694 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
18695 # This property is optional.
18696 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
18697 },
18698 ],
18699 },
18700 &quot;getVersionOperationMetadata&quot;: {
18701 &quot;inlineSbomInfo&quot;: {
18702 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
18703 # appropriate identifiers.
18704 &quot;a_key&quot;: &quot;A String&quot;,
18705 },
18706 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
18707 # identifiers.
18708 &quot;a_key&quot;: &quot;A String&quot;,
18709 },
18710 },
18711 },
18712 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
18713 # message that was returned, such as `NOT FOUND`.
18714 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
18715 # status code that was returned. For example, a `404` means the
18716 # resource was not found.
18717 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
18718 # defined by the server.
18719 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
18720 # This value is inRFC3339
18721 # text format.
18722 &quot;instancesBulkInsertOperationMetadata&quot;: {
18723 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
18724 # Example key: zones/us-central1-a
18725 &quot;a_key&quot;: {
18726 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
18727 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
18728 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
18729 # error.
18730 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
18731 # if the flow is rolling forward or rolling back.
18732 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
18733 },
18734 },
18735 },
18736 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
18737 # Operation resources.
18738 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
18739 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
18740 # group of operations results from a `bulkInsert` API request.
18741 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
18742 # `update`, or `delete`, and so on.
18743 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
18744 # There is no requirement that this be linear or support any granularity of
18745 # operations. This should not be used to guess when the operation will be
18746 # complete. This number should monotonically increase as the operation
18747 # progresses.
18748 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
18749 # applicable when performing regional operations.
18750 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
18751 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
18752 # this field will contain information on all underlying zonal actions and
18753 # their state.
18754 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
18755 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
18756 # Example key: zones/us-central1-a
18757 &quot;a_key&quot;: {
18758 &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
18759 # populated.
18760 # different programming environments, including REST APIs and RPC APIs. It is
18761 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
18762 # three pieces of data: error code, error message, and error details.
18763 #
18764 # You can find out more about this error model and how to work with it in the
18765 # [API Design Guide](https://cloud.google.com/apis/design/errors).
18766 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
18767 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
18768 # message types for APIs to use.
18769 {
18770 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
18771 },
18772 ],
18773 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
18774 # user-facing error message should be localized and sent in the
18775 # google.rpc.Status.details field, or localized by the client.
18776 },
18777 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
18778 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
18779 },
18780 },
18781 },
18782 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
18783 # This value is inRFC3339
18784 # text format.
18785 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
18786 # following:
18787 # `PENDING`, `RUNNING`, or `DONE`.
18788 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
18789 # operation.
18790 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
18791 # of the target resource.
18792 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
18793 # operations related to creating a snapshot, this points to the disk
18794 # that the snapshot was created from.
18795 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
18796 # `[email protected]` or
18797 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
18798 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
18799 # operation, this field will be populated.
18800 {
18801 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
18802 # Engine returns NO_RESULTS_ON_PAGE if there
18803 # are no results in the response.
18804 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
18805 # value format. For example:
18806 #
18807 # &quot;data&quot;: [
18808 # {
18809 # &quot;key&quot;: &quot;scope&quot;,
18810 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
18811 # }
18812 {
18813 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
18814 # returned. For example, for warnings where there are no results in a list
18815 # request for a particular zone, this key might be scope and
18816 # the key value might be the zone name. Other examples might be a key
18817 # indicating a deprecated resource and a suggested replacement, or a
18818 # warning about invalid network settings (for example, if an instance
18819 # attempts to perform IP forwarding but is not enabled for IP forwarding).
18820 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
18821 },
18822 ],
18823 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
18824 },
18825 ],
18826 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
18827 # applicable when performing per-zone operations.
18828 }</pre>
18829 </div>
18830
18831 <div class="method">
18832 <code class="details" id="stop">stop(project, zone, instance, discardLocalSsd=None, requestId=None, x__xgafv=None)</code>
18833 <pre>Stops a running instance, shutting it down cleanly, and allows
18834 you to restart the instance at a later time. Stopped instances do not incur
18835 VM usage charges while they are stopped. However, resources that the VM is
18836 using, such as persistent disks and static IP addresses, will continue to
18837 be charged until they are deleted. For more information, seeStopping
18838 an instance.
18839
18840 Args:
18841 project: string, Project ID for this request. (required)
18842 zone: string, The name of the zone for this request. (required)
18843 instance: string, Name of the instance resource to stop. (required)
18844 discardLocalSsd: boolean, This property is required if the instance has any attached Local SSD disks.
18845 If false, Local SSD data will be preserved when the instance is suspended.
18846 If true, the contents of any attached Local SSD disks will be discarded.
18847 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
18848 that if you must retry your request, the server will know to ignore the
18849 request if it has already been completed.
18850
18851 For example, consider a situation where you make an initial request and
18852 the request times out. If you make the request again with the same
18853 request ID, the server can check if original operation with the same
18854 request ID was received, and if so, will ignore the second request. This
18855 prevents clients from accidentally creating duplicate commitments.
18856
18857 The request ID must be
18858 a valid UUID with the exception that zero UUID is not supported
18859 (00000000-0000-0000-0000-000000000000).
18860 x__xgafv: string, V1 error format.
18861 Allowed values
18862 1 - v1 error format
18863 2 - v2 error format
18864
18865 Returns:
18866 An object of the form:
18867
18868 { # Represents an Operation resource.
18869 #
18870 # Google Compute Engine has three Operation resources:
18871 #
18872 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
18873 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
18874 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
18875 #
18876 # You can use an operation resource to manage asynchronous API requests.
18877 # For more information, readHandling
18878 # API responses.
18879 #
18880 # Operations can be global, regional or zonal.
18881 #
18882 # - For global operations, use the `globalOperations`
18883 # resource.
18884 # - For regional operations, use the
18885 # `regionOperations` resource.
18886 # - For zonal operations, use
18887 # the `zoneOperations` resource.
18888 #
18889 #
18890 #
18891 # For more information, read
18892 # Global, Regional, and Zonal Resources.
18893 #
18894 # Note that completed Operation resources have a limited
18895 # retention period.
18896 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
18897 # Not present otherwise.
18898 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
18899 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
18900 # set when the operation is created.
18901 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
18902 # text format.
18903 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
18904 # this field will be populated.
18905 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
18906 # operation.
18907 {
18908 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
18909 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
18910 # details. There is a set of defined message types to use for providing
18911 # details.The syntax depends on the error code. For example,
18912 # QuotaExceededInfo will have details when the error code is
18913 # QUOTA_EXCEEDED.
18914 {
18915 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
18916 #
18917 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
18918 # is not enabled:
18919 #
18920 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
18921 # &quot;domain&quot;: &quot;googleapis.com&quot;
18922 # &quot;metadata&quot;: {
18923 # &quot;resource&quot;: &quot;projects/123&quot;,
18924 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
18925 # }
18926 # }
18927 #
18928 # This response indicates that the pubsub.googleapis.com API is not enabled.
18929 #
18930 # Example of an error that is returned when attempting to create a Spanner
18931 # instance in a region that is out of stock:
18932 #
18933 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
18934 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
18935 # &quot;metadata&quot;: {
18936 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
18937 # }
18938 # }
18939 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
18940 # is typically the registered service name of the tool or product that
18941 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
18942 # generated by some common infrastructure, the error domain must be a
18943 # globally unique value that identifies the infrastructure. For Google API
18944 # infrastructure, the error domain is &quot;googleapis.com&quot;.
18945 &quot;metadatas&quot;: { # Additional structured details about this error.
18946 #
18947 # Keys must match a regular expression of `a-z+` but should
18948 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
18949 # length. When identifying the current value of an exceeded limit, the units
18950 # should be contained in the key, not the value. For example, rather than
18951 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
18952 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
18953 # instances that can be created in a single (batch) request.
18954 &quot;a_key&quot;: &quot;A String&quot;,
18955 },
18956 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
18957 # proximate cause of the error. Error reasons are unique within a particular
18958 # domain of errors. This should be at most 63 characters and match a
18959 # regular expression of `A-Z+[A-Z0-9]`, which represents
18960 # UPPER_SNAKE_CASE.
18961 },
18962 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
18963 #
18964 # For example, if a quota check failed with an error indicating the calling
18965 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
18966 # directly to the right place in the developer console to flip the bit.
18967 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
18968 { # Describes a URL link.
18969 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
18970 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
18971 },
18972 ],
18973 },
18974 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
18975 # which can be attached to an RPC error.
18976 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
18977 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
18978 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
18979 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
18980 },
18981 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
18982 &quot;dimensions&quot;: { # The map holding related quota dimensions.
18983 &quot;a_key&quot;: &quot;A String&quot;,
18984 },
18985 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
18986 # type or metric.
18987 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
18988 # or metric.
18989 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
18990 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
18991 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
18992 },
18993 },
18994 ],
18995 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
18996 # This property is optional.
18997 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
18998 },
18999 ],
19000 },
19001 &quot;getVersionOperationMetadata&quot;: {
19002 &quot;inlineSbomInfo&quot;: {
19003 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
19004 # appropriate identifiers.
19005 &quot;a_key&quot;: &quot;A String&quot;,
19006 },
19007 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
19008 # identifiers.
19009 &quot;a_key&quot;: &quot;A String&quot;,
19010 },
19011 },
19012 },
19013 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
19014 # message that was returned, such as `NOT FOUND`.
19015 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
19016 # status code that was returned. For example, a `404` means the
19017 # resource was not found.
19018 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
19019 # defined by the server.
19020 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
19021 # This value is inRFC3339
19022 # text format.
19023 &quot;instancesBulkInsertOperationMetadata&quot;: {
19024 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
19025 # Example key: zones/us-central1-a
19026 &quot;a_key&quot;: {
19027 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
19028 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
19029 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
19030 # error.
19031 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
19032 # if the flow is rolling forward or rolling back.
19033 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
19034 },
19035 },
19036 },
19037 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
19038 # Operation resources.
19039 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
19040 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
19041 # group of operations results from a `bulkInsert` API request.
19042 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
19043 # `update`, or `delete`, and so on.
19044 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
19045 # There is no requirement that this be linear or support any granularity of
19046 # operations. This should not be used to guess when the operation will be
19047 # complete. This number should monotonically increase as the operation
19048 # progresses.
19049 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
19050 # applicable when performing regional operations.
19051 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
19052 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
19053 # this field will contain information on all underlying zonal actions and
19054 # their state.
19055 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
19056 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
19057 # Example key: zones/us-central1-a
19058 &quot;a_key&quot;: {
19059 &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
19060 # populated.
19061 # different programming environments, including REST APIs and RPC APIs. It is
19062 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
19063 # three pieces of data: error code, error message, and error details.
19064 #
19065 # You can find out more about this error model and how to work with it in the
19066 # [API Design Guide](https://cloud.google.com/apis/design/errors).
19067 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
19068 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
19069 # message types for APIs to use.
19070 {
19071 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
19072 },
19073 ],
19074 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
19075 # user-facing error message should be localized and sent in the
19076 # google.rpc.Status.details field, or localized by the client.
19077 },
19078 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
19079 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
19080 },
19081 },
19082 },
19083 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
19084 # This value is inRFC3339
19085 # text format.
19086 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
19087 # following:
19088 # `PENDING`, `RUNNING`, or `DONE`.
19089 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
19090 # operation.
19091 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
19092 # of the target resource.
19093 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
19094 # operations related to creating a snapshot, this points to the disk
19095 # that the snapshot was created from.
19096 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
19097 # `[email protected]` or
19098 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
19099 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
19100 # operation, this field will be populated.
19101 {
19102 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
19103 # Engine returns NO_RESULTS_ON_PAGE if there
19104 # are no results in the response.
19105 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
19106 # value format. For example:
19107 #
19108 # &quot;data&quot;: [
19109 # {
19110 # &quot;key&quot;: &quot;scope&quot;,
19111 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
19112 # }
19113 {
19114 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
19115 # returned. For example, for warnings where there are no results in a list
19116 # request for a particular zone, this key might be scope and
19117 # the key value might be the zone name. Other examples might be a key
19118 # indicating a deprecated resource and a suggested replacement, or a
19119 # warning about invalid network settings (for example, if an instance
19120 # attempts to perform IP forwarding but is not enabled for IP forwarding).
19121 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
19122 },
19123 ],
19124 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
19125 },
19126 ],
19127 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
19128 # applicable when performing per-zone operations.
19129 }</pre>
19130 </div>
19131
19132 <div class="method">
19133 <code class="details" id="suspend">suspend(project, zone, instance, discardLocalSsd=None, requestId=None, x__xgafv=None)</code>
19134 <pre>This method suspends a running instance, saving its state to persistent
19135 storage, and allows you to resume the instance at a later time. Suspended
19136 instances have no compute costs (cores or RAM), and incur only storage
19137 charges for the saved VM memory and localSSD data. Any charged resources
19138 the virtual machine was using, such as persistent disks and static IP
19139 addresses, will continue to be charged while the instance is suspended.
19140 For more information, see
19141 Suspending and resuming an instance.
19142
19143 Args:
19144 project: string, Project ID for this request. (required)
19145 zone: string, The name of the zone for this request. (required)
19146 instance: string, Name of the instance resource to suspend. (required)
19147 discardLocalSsd: boolean, This property is required if the instance has any attached Local SSD disks.
19148 If false, Local SSD data will be preserved when the instance is suspended.
19149 If true, the contents of any attached Local SSD disks will be discarded.
19150 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
19151 that if you must retry your request, the server will know to ignore the
19152 request if it has already been completed.
19153
19154 For example, consider a situation where you make an initial request and
19155 the request times out. If you make the request again with the same
19156 request ID, the server can check if original operation with the same
19157 request ID was received, and if so, will ignore the second request. This
19158 prevents clients from accidentally creating duplicate commitments.
19159
19160 The request ID must be
19161 a valid UUID with the exception that zero UUID is not supported
19162 (00000000-0000-0000-0000-000000000000).
19163 x__xgafv: string, V1 error format.
19164 Allowed values
19165 1 - v1 error format
19166 2 - v2 error format
19167
19168 Returns:
19169 An object of the form:
19170
19171 { # Represents an Operation resource.
19172 #
19173 # Google Compute Engine has three Operation resources:
19174 #
19175 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
19176 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
19177 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
19178 #
19179 # You can use an operation resource to manage asynchronous API requests.
19180 # For more information, readHandling
19181 # API responses.
19182 #
19183 # Operations can be global, regional or zonal.
19184 #
19185 # - For global operations, use the `globalOperations`
19186 # resource.
19187 # - For regional operations, use the
19188 # `regionOperations` resource.
19189 # - For zonal operations, use
19190 # the `zoneOperations` resource.
19191 #
19192 #
19193 #
19194 # For more information, read
19195 # Global, Regional, and Zonal Resources.
19196 #
19197 # Note that completed Operation resources have a limited
19198 # retention period.
19199 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
19200 # Not present otherwise.
19201 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
19202 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
19203 # set when the operation is created.
19204 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
19205 # text format.
19206 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
19207 # this field will be populated.
19208 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
19209 # operation.
19210 {
19211 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
19212 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
19213 # details. There is a set of defined message types to use for providing
19214 # details.The syntax depends on the error code. For example,
19215 # QuotaExceededInfo will have details when the error code is
19216 # QUOTA_EXCEEDED.
19217 {
19218 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
19219 #
19220 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
19221 # is not enabled:
19222 #
19223 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
19224 # &quot;domain&quot;: &quot;googleapis.com&quot;
19225 # &quot;metadata&quot;: {
19226 # &quot;resource&quot;: &quot;projects/123&quot;,
19227 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
19228 # }
19229 # }
19230 #
19231 # This response indicates that the pubsub.googleapis.com API is not enabled.
19232 #
19233 # Example of an error that is returned when attempting to create a Spanner
19234 # instance in a region that is out of stock:
19235 #
19236 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
19237 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
19238 # &quot;metadata&quot;: {
19239 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
19240 # }
19241 # }
19242 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
19243 # is typically the registered service name of the tool or product that
19244 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
19245 # generated by some common infrastructure, the error domain must be a
19246 # globally unique value that identifies the infrastructure. For Google API
19247 # infrastructure, the error domain is &quot;googleapis.com&quot;.
19248 &quot;metadatas&quot;: { # Additional structured details about this error.
19249 #
19250 # Keys must match a regular expression of `a-z+` but should
19251 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
19252 # length. When identifying the current value of an exceeded limit, the units
19253 # should be contained in the key, not the value. For example, rather than
19254 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
19255 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
19256 # instances that can be created in a single (batch) request.
19257 &quot;a_key&quot;: &quot;A String&quot;,
19258 },
19259 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
19260 # proximate cause of the error. Error reasons are unique within a particular
19261 # domain of errors. This should be at most 63 characters and match a
19262 # regular expression of `A-Z+[A-Z0-9]`, which represents
19263 # UPPER_SNAKE_CASE.
19264 },
19265 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
19266 #
19267 # For example, if a quota check failed with an error indicating the calling
19268 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
19269 # directly to the right place in the developer console to flip the bit.
19270 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
19271 { # Describes a URL link.
19272 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
19273 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
19274 },
19275 ],
19276 },
19277 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
19278 # which can be attached to an RPC error.
19279 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
19280 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
19281 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
19282 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
19283 },
19284 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
19285 &quot;dimensions&quot;: { # The map holding related quota dimensions.
19286 &quot;a_key&quot;: &quot;A String&quot;,
19287 },
19288 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
19289 # type or metric.
19290 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
19291 # or metric.
19292 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
19293 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
19294 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
19295 },
19296 },
19297 ],
19298 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
19299 # This property is optional.
19300 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
19301 },
19302 ],
19303 },
19304 &quot;getVersionOperationMetadata&quot;: {
19305 &quot;inlineSbomInfo&quot;: {
19306 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
19307 # appropriate identifiers.
19308 &quot;a_key&quot;: &quot;A String&quot;,
19309 },
19310 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
19311 # identifiers.
19312 &quot;a_key&quot;: &quot;A String&quot;,
19313 },
19314 },
19315 },
19316 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
19317 # message that was returned, such as `NOT FOUND`.
19318 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
19319 # status code that was returned. For example, a `404` means the
19320 # resource was not found.
19321 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
19322 # defined by the server.
19323 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
19324 # This value is inRFC3339
19325 # text format.
19326 &quot;instancesBulkInsertOperationMetadata&quot;: {
19327 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
19328 # Example key: zones/us-central1-a
19329 &quot;a_key&quot;: {
19330 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
19331 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
19332 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
19333 # error.
19334 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
19335 # if the flow is rolling forward or rolling back.
19336 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
19337 },
19338 },
19339 },
19340 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
19341 # Operation resources.
19342 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
19343 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
19344 # group of operations results from a `bulkInsert` API request.
19345 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
19346 # `update`, or `delete`, and so on.
19347 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
19348 # There is no requirement that this be linear or support any granularity of
19349 # operations. This should not be used to guess when the operation will be
19350 # complete. This number should monotonically increase as the operation
19351 # progresses.
19352 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
19353 # applicable when performing regional operations.
19354 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
19355 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
19356 # this field will contain information on all underlying zonal actions and
19357 # their state.
19358 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
19359 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
19360 # Example key: zones/us-central1-a
19361 &quot;a_key&quot;: {
19362 &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
19363 # populated.
19364 # different programming environments, including REST APIs and RPC APIs. It is
19365 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
19366 # three pieces of data: error code, error message, and error details.
19367 #
19368 # You can find out more about this error model and how to work with it in the
19369 # [API Design Guide](https://cloud.google.com/apis/design/errors).
19370 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
19371 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
19372 # message types for APIs to use.
19373 {
19374 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
19375 },
19376 ],
19377 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
19378 # user-facing error message should be localized and sent in the
19379 # google.rpc.Status.details field, or localized by the client.
19380 },
19381 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
19382 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
19383 },
19384 },
19385 },
19386 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
19387 # This value is inRFC3339
19388 # text format.
19389 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
19390 # following:
19391 # `PENDING`, `RUNNING`, or `DONE`.
19392 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
19393 # operation.
19394 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
19395 # of the target resource.
19396 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
19397 # operations related to creating a snapshot, this points to the disk
19398 # that the snapshot was created from.
19399 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
19400 # `[email protected]` or
19401 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
19402 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
19403 # operation, this field will be populated.
19404 {
19405 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
19406 # Engine returns NO_RESULTS_ON_PAGE if there
19407 # are no results in the response.
19408 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
19409 # value format. For example:
19410 #
19411 # &quot;data&quot;: [
19412 # {
19413 # &quot;key&quot;: &quot;scope&quot;,
19414 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
19415 # }
19416 {
19417 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
19418 # returned. For example, for warnings where there are no results in a list
19419 # request for a particular zone, this key might be scope and
19420 # the key value might be the zone name. Other examples might be a key
19421 # indicating a deprecated resource and a suggested replacement, or a
19422 # warning about invalid network settings (for example, if an instance
19423 # attempts to perform IP forwarding but is not enabled for IP forwarding).
19424 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
19425 },
19426 ],
19427 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
19428 },
19429 ],
19430 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
19431 # applicable when performing per-zone operations.
19432 }</pre>
19433 </div>
19434
19435 <div class="method">
19436 <code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body=None, x__xgafv=None)</code>
19437 <pre>Returns permissions that a caller has on the specified resource.
19438
19439 Args:
19440 project: string, Project ID for this request. (required)
19441 zone: string, The name of the zone for this request. (required)
19442 resource: string, Name or id of the resource for this request. (required)
19443 body: object, The request body.
19444 The object takes the form of:
19445
19446 {
19447 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with
19448 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
19449 &quot;A String&quot;,
19450 ],
19451 }
19452
19453 x__xgafv: string, V1 error format.
19454 Allowed values
19455 1 - v1 error format
19456 2 - v2 error format
19457
19458 Returns:
19459 An object of the form:
19460
19461 {
19462 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
19463 # allowed.
19464 &quot;A String&quot;,
19465 ],
19466 }</pre>
19467 </div>
19468
19469 <div class="method">
19470 <code class="details" id="update">update(project, zone, instance, body=None, discardLocalSsd=None, minimalAction=None, mostDisruptiveAllowedAction=None, requestId=None, x__xgafv=None)</code>
19471 <pre>Updates an instance only if the necessary resources are available. This
19472 method can update only a specific set of instance properties. See
19473 Updating a running instance for a list of updatable instance
19474 properties.
19475
19476 Args:
19477 project: string, Project ID for this request. (required)
19478 zone: string, The name of the zone for this request. (required)
19479 instance: string, Name of the instance resource to update. (required)
19480 body: object, The request body.
19481 The object takes the form of:
19482
19483 { # Represents an Instance resource.
19484 #
19485 # An instance is a virtual machine that is hosted on Google Cloud Platform.
19486 # For more information, readVirtual Machine Instances.
19487 &quot;advancedMachineFeatures&quot;: { # Specifies options for controlling advanced machine features. # Controls for advanced machine-related behavior features.
19488 # Options that would traditionally be configured in a BIOS belong
19489 # here. Features that require operating system support may have
19490 # corresponding entries in the GuestOsFeatures of anImage (e.g., whether or not the OS in theImage supports nested virtualization being enabled or
19491 # disabled).
19492 &quot;enableNestedVirtualization&quot;: True or False, # Whether to enable nested virtualization or not (default is false).
19493 &quot;enableUefiNetworking&quot;: True or False, # Whether to enable UEFI networking for instance creation.
19494 &quot;performanceMonitoringUnit&quot;: &quot;A String&quot;, # Type of Performance Monitoring Unit requested on instance.
19495 &quot;threadsPerCore&quot;: 42, # The number of threads per physical core. To disable simultaneous
19496 # multithreading (SMT) set this to 1. If unset, the maximum number
19497 # of threads supported per core by the underlying processor is
19498 # assumed.
19499 &quot;turboMode&quot;: &quot;A String&quot;, # Turbo frequency mode to use for the instance.
19500 # Supported modes include:
19501 # * ALL_CORE_MAX
19502 #
19503 # Using empty string or not setting this field will use the platform-specific
19504 # default turbo mode.
19505 &quot;visibleCoreCount&quot;: 42, # The number of physical cores to expose to an instance. Multiply by
19506 # the number of threads per core to compute the total number of virtual
19507 # CPUs to expose to the instance. If unset, the number of cores is
19508 # inferred from the instance&#x27;s nominal CPU count and the underlying
19509 # platform&#x27;s SMT width.
19510 },
19511 &quot;canIpForward&quot;: True or False, # Allows this instance to send and receive packets with non-matching
19512 # destination or source IPs. This is required if you plan to use this
19513 # instance to forward routes. For more information, seeEnabling IP Forwarding.
19514 &quot;confidentialInstanceConfig&quot;: { # A set of Confidential Instance options.
19515 &quot;confidentialInstanceType&quot;: &quot;A String&quot;, # Defines the type of technology used by the confidential instance.
19516 &quot;enableConfidentialCompute&quot;: True or False, # Defines whether the instance should have confidential compute enabled.
19517 },
19518 &quot;cpuPlatform&quot;: &quot;A String&quot;, # Output only. [Output Only] The CPU platform used by this instance.
19519 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339 text format.
19520 &quot;deletionProtection&quot;: True or False, # Whether the resource should be protected against deletion.
19521 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
19522 # create the resource.
19523 &quot;disks&quot;: [ # Array of disks associated with this instance. Persistent disks must be
19524 # created before you can assign them.
19525 { # An instance-attached disk resource.
19526 &quot;architecture&quot;: &quot;A String&quot;, # Output only. [Output Only] The architecture of the attached disk. Valid values are ARM64
19527 # or X86_64.
19528 &quot;autoDelete&quot;: True or False, # Specifies whether the disk will be auto-deleted when the instance is
19529 # deleted (but not when the disk is detached from the instance).
19530 &quot;boot&quot;: True or False, # Indicates that this is a boot disk. The virtual machine will use the first
19531 # partition of the disk for its root filesystem.
19532 &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
19533 # running within the instance. This name can be used to reference the device
19534 # for mounting, resizing, and so on, from within the instance.
19535 #
19536 # If not specified, the server chooses a default device name to apply to this
19537 # disk, in the form persistent-disk-x, where x is a number
19538 # assigned by Google Compute Engine. This field is only applicable for
19539 # persistent disks.
19540 &quot;diskEncryptionKey&quot;: { # Encrypts or decrypts a disk using acustomer-supplied
19541 # encryption key.
19542 #
19543 # If you are creating a new disk, this field encrypts the new disk using
19544 # an encryption key that you provide. If you are attaching an existing
19545 # disk that is already encrypted, this field decrypts the disk using
19546 # the customer-supplied encryption key.
19547 #
19548 # If you encrypt a disk using a customer-supplied key, you must provide the
19549 # same key again when you attempt to use this resource at a later time. For
19550 # example, you must provide the key when you create a snapshot or an image
19551 # from the disk or when you attach the disk to a virtual machine instance.
19552 #
19553 # If you do not provide an encryption key, then the disk will be encrypted
19554 # using an automatically generated key and you do not need to provide a key
19555 # to use the disk later.
19556 #
19557 # Note:
19558 #
19559 # Instance templates do not storecustomer-supplied
19560 # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
19561 #
19562 # You cannot create VMs that have disks with customer-supplied keys using
19563 # the bulk
19564 # insert method.
19565 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
19566 # For example:
19567 #
19568 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
19569 # key_region/cryptoKeys/key
19570 #
19571 # The fully-qualifed key name may be returned for resource GET requests. For
19572 # example:
19573 #
19574 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
19575 # key_region/cryptoKeys/key
19576 # /cryptoKeyVersions/1
19577 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
19578 # key. If absent, the Compute Engine default service account is used.
19579 # For example:
19580 #
19581 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
19582 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
19583 # encryption key, encoded in RFC
19584 # 4648 base64 to either encrypt or decrypt this resource. You can
19585 # provide either the rawKey or thersaEncryptedKey.
19586 # For example:
19587 #
19588 # &quot;rawKey&quot;:
19589 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
19590 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
19591 # customer-supplied encryption key to either encrypt or decrypt this
19592 # resource. You can provide either the rawKey or thersaEncryptedKey.
19593 # For example:
19594 #
19595 # &quot;rsaEncryptedKey&quot;:
19596 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
19597 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
19598 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
19599 #
19600 # The key must meet the following requirements before you can provide it to
19601 # Compute Engine:
19602 #
19603 # 1. The key is wrapped using a RSA public key certificate provided by
19604 # Google.
19605 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
19606 # encoding.
19607 #
19608 # Gets the RSA public key certificate provided by Google at:
19609 #
19610 #
19611 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
19612 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
19613 # 4648 base64 encoded SHA-256 hash of the customer-supplied
19614 # encryption key that protects this resource.
19615 },
19616 &quot;diskSizeGb&quot;: &quot;A String&quot;, # The size of the disk in GB.
19617 &quot;forceAttach&quot;: True or False, # [Input Only] Whether to force attach the regional disk even if it&#x27;s
19618 # currently attached to another instance. If you try to force attach a zonal
19619 # disk to an instance, you will receive an error.
19620 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
19621 # only for bootable images. Read
19622 # Enabling guest operating system features to see a list of available
19623 # options.
19624 { # Guest OS features.
19625 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
19626 # separate values. Set to one or more of the following values:
19627 #
19628 # - VIRTIO_SCSI_MULTIQUEUE
19629 # - WINDOWS
19630 # - MULTI_IP_SUBNET
19631 # - UEFI_COMPATIBLE
19632 # - GVNIC
19633 # - SEV_CAPABLE
19634 # - SUSPEND_RESUME_COMPATIBLE
19635 # - SEV_LIVE_MIGRATABLE_V2
19636 # - SEV_SNP_CAPABLE
19637 # - TDX_CAPABLE
19638 # - IDPF
19639 # - SNP_SVSM_CAPABLE
19640 # - CCA_CAPABLE
19641 #
19642 #
19643 # For more information, see
19644 # Enabling guest operating system features.
19645 },
19646 ],
19647 &quot;index&quot;: 42, # Output only. [Output Only] A zero-based index to this disk, where 0 is reserved for the
19648 # boot disk. If you have many disks attached to an instance, each
19649 # disk would have a unique index number.
19650 &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
19651 # alongside the new instance. Use initialization parameters to create boot
19652 # disks or local SSDs attached to the new instance.
19653 #
19654 # This property is mutually exclusive with the source property;
19655 # you can only define one or the other, but not both.
19656 # alongside the new instance. Use initialization parameters to create boot
19657 # disks or local SSDs attached to the new instance.
19658 #
19659 # This field is persisted and returned for instanceTemplate and not returned
19660 # in the context of instance.
19661 #
19662 # This property is mutually exclusive with the source property;
19663 # you can only define one or the other, but not both.
19664 &quot;architecture&quot;: &quot;A String&quot;, # The architecture of the attached disk. Valid values are
19665 # arm64 or x86_64.
19666 &quot;description&quot;: &quot;A String&quot;, # An optional description. Provide this property when creating the disk.
19667 &quot;diskName&quot;: &quot;A String&quot;, # Specifies the disk name. If not specified, the default is to use the name
19668 # of the instance. If a disk with the same name already exists in the given
19669 # region, the existing disk is attached to the new instance and the
19670 # new disk is not created.
19671 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB. The size must be at least
19672 # 10 GB. If you specify a sourceImage, which is required for
19673 # boot disks, the default size is the size of the sourceImage.
19674 # If you do not specify a sourceImage, the default disk size
19675 # is 500 GB.
19676 &quot;diskType&quot;: &quot;A String&quot;,
19677 &quot;enableConfidentialCompute&quot;: True or False, # Whether this disk is using confidential compute mode.
19678 &quot;labels&quot;: { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
19679 # persistent disks.
19680 &quot;a_key&quot;: &quot;A String&quot;,
19681 },
19682 &quot;licenses&quot;: [ # A list of publicly visible licenses. Reserved for Google&#x27;s use.
19683 &quot;A String&quot;,
19684 ],
19685 &quot;onUpdateAction&quot;: &quot;A String&quot;, # Specifies which action to take on instance update with this disk. Default
19686 # is to use the existing disk.
19687 &quot;provisionedIops&quot;: &quot;A String&quot;, # Indicates how many IOPS to provision for the disk. This sets the number
19688 # of I/O operations per second that the disk can handle. Values must be
19689 # between 10,000 and 120,000. For more details, see theExtreme persistent
19690 # disk documentation.
19691 &quot;provisionedThroughput&quot;: &quot;A String&quot;, # Indicates how much throughput to provision for the disk. This sets the
19692 # number of throughput mb per second that the disk can handle. Values must
19693 # greater than or equal to 1.
19694 &quot;replicaZones&quot;: [ # Required for each regional disk associated with the instance. Specify
19695 # the URLs of the zones where the disk should be replicated to.
19696 # You must provide exactly two replica zones, and one zone must be the same
19697 # as the instance zone.
19698 &quot;A String&quot;,
19699 ],
19700 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
19701 # have the same definition as resource
19702 # manager tags. Keys and values can be either in numeric format,
19703 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
19704 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
19705 # `{tag_value_short_name}`. The field is ignored (both PUT &amp; PATCH) when
19706 # empty.
19707 &quot;a_key&quot;: &quot;A String&quot;,
19708 },
19709 &quot;resourcePolicies&quot;: [ # Resource policies applied to this disk for automatic snapshot creations.
19710 # Specified using the full or partial URL. For instance template, specify
19711 # only the resource policy name.
19712 &quot;A String&quot;,
19713 ],
19714 &quot;sourceImage&quot;: &quot;A String&quot;, # The source image to create this disk. When creating a new instance boot
19715 # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
19716 # is required.
19717 #
19718 # To create a disk with one of the public operating system
19719 # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
19720 #
19721 # projects/debian-cloud/global/images/family/debian-9
19722 #
19723 #
19724 # Alternatively, use a specific version of a public operating system image:
19725 #
19726 # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
19727 #
19728 #
19729 # To create a disk with a custom image that you created, specify the
19730 # image name in the following format:
19731 #
19732 # global/images/my-custom-image
19733 #
19734 #
19735 # You can also specify a custom image by its image family, which returns
19736 # the latest version of the image in that family. Replace the image name
19737 # with family/family-name:
19738 #
19739 # global/images/family/my-image-family
19740 #
19741 #
19742 # If the source image is deleted later, this field will not be set.
19743 &quot;sourceImageEncryptionKey&quot;: { # Thecustomer-supplied
19744 # encryption key of the source image. Required if the source image is
19745 # protected by a customer-supplied encryption key.
19746 #
19747 # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
19748 # encryption keys, so you cannot create disks for instances in a managed instance group if the
19749 # source images are encrypted with your own keys.
19750 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
19751 # For example:
19752 #
19753 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
19754 # key_region/cryptoKeys/key
19755 #
19756 # The fully-qualifed key name may be returned for resource GET requests. For
19757 # example:
19758 #
19759 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
19760 # key_region/cryptoKeys/key
19761 # /cryptoKeyVersions/1
19762 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
19763 # key. If absent, the Compute Engine default service account is used.
19764 # For example:
19765 #
19766 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
19767 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
19768 # encryption key, encoded in RFC
19769 # 4648 base64 to either encrypt or decrypt this resource. You can
19770 # provide either the rawKey or thersaEncryptedKey.
19771 # For example:
19772 #
19773 # &quot;rawKey&quot;:
19774 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
19775 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
19776 # customer-supplied encryption key to either encrypt or decrypt this
19777 # resource. You can provide either the rawKey or thersaEncryptedKey.
19778 # For example:
19779 #
19780 # &quot;rsaEncryptedKey&quot;:
19781 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
19782 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
19783 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
19784 #
19785 # The key must meet the following requirements before you can provide it to
19786 # Compute Engine:
19787 #
19788 # 1. The key is wrapped using a RSA public key certificate provided by
19789 # Google.
19790 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
19791 # encoding.
19792 #
19793 # Gets the RSA public key certificate provided by Google at:
19794 #
19795 #
19796 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
19797 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
19798 # 4648 base64 encoded SHA-256 hash of the customer-supplied
19799 # encryption key that protects this resource.
19800 },
19801 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # The source snapshot to create this disk. When creating a new instance
19802 # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
19803 # is required.
19804 #
19805 # To create a disk with a snapshot that you created, specify the
19806 # snapshot name in the following format:
19807 #
19808 # global/snapshots/my-backup
19809 #
19810 #
19811 # If the source snapshot is deleted later, this field will not be set.
19812 #
19813 # Note: You cannot create VMs in bulk using a snapshot as the source. Use
19814 # an image instead when you create VMs using
19815 # the bulk
19816 # insert method.
19817 &quot;sourceSnapshotEncryptionKey&quot;: { # Thecustomer-supplied
19818 # encryption key of the source snapshot.
19819 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
19820 # For example:
19821 #
19822 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
19823 # key_region/cryptoKeys/key
19824 #
19825 # The fully-qualifed key name may be returned for resource GET requests. For
19826 # example:
19827 #
19828 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
19829 # key_region/cryptoKeys/key
19830 # /cryptoKeyVersions/1
19831 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
19832 # key. If absent, the Compute Engine default service account is used.
19833 # For example:
19834 #
19835 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
19836 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
19837 # encryption key, encoded in RFC
19838 # 4648 base64 to either encrypt or decrypt this resource. You can
19839 # provide either the rawKey or thersaEncryptedKey.
19840 # For example:
19841 #
19842 # &quot;rawKey&quot;:
19843 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
19844 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
19845 # customer-supplied encryption key to either encrypt or decrypt this
19846 # resource. You can provide either the rawKey or thersaEncryptedKey.
19847 # For example:
19848 #
19849 # &quot;rsaEncryptedKey&quot;:
19850 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
19851 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
19852 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
19853 #
19854 # The key must meet the following requirements before you can provide it to
19855 # Compute Engine:
19856 #
19857 # 1. The key is wrapped using a RSA public key certificate provided by
19858 # Google.
19859 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
19860 # encoding.
19861 #
19862 # Gets the RSA public key certificate provided by Google at:
19863 #
19864 #
19865 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
19866 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
19867 # 4648 base64 encoded SHA-256 hash of the customer-supplied
19868 # encryption key that protects this resource.
19869 },
19870 &quot;storagePool&quot;: &quot;A String&quot;, # The storage pool in which the new disk is created. You can provide
19871 # this as a partial or full URL to the resource. For example, the following
19872 # are valid values:
19873 #
19874 #
19875 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
19876 # - projects/project/zones/zone/storagePools/storagePool
19877 # - zones/zone/storagePools/storagePool
19878 },
19879 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is
19880 # either SCSI or NVME. For most machine types, the
19881 # default is SCSI. Local SSDs can use either NVME or SCSI.
19882 # In certain configurations, persistent disks can use NVMe. For more
19883 # information, seeAbout
19884 # persistent disks.
19885 &quot;kind&quot;: &quot;compute#attachedDisk&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
19886 &quot;licenses&quot;: [ # Output only. [Output Only] Any valid publicly visible licenses.
19887 &quot;A String&quot;,
19888 ],
19889 &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
19890 # in READ_WRITE mode.
19891 &quot;savedState&quot;: &quot;A String&quot;, # Output only. For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
19892 # field is set to PRESERVED if the LocalSSD data has been saved
19893 # to a persistent location by customer request. (see the
19894 # discard_local_ssd option on Stop/Suspend).
19895 # Read-only in the api.
19896 &quot;shieldedInstanceInitialState&quot;: { # Initial State for shielded instance, # Output only. [Output Only] shielded vm initial state stored on disk
19897 # these are public keys which are safe to store in public
19898 &quot;dbs&quot;: [ # The Key Database (db).
19899 {
19900 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
19901 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
19902 },
19903 ],
19904 &quot;dbxs&quot;: [ # The forbidden key database (dbx).
19905 {
19906 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
19907 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
19908 },
19909 ],
19910 &quot;keks&quot;: [ # The Key Exchange Key (KEK).
19911 {
19912 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
19913 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
19914 },
19915 ],
19916 &quot;pk&quot;: { # The Platform Key (PK).
19917 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
19918 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
19919 },
19920 },
19921 &quot;source&quot;: &quot;A String&quot;, # Specifies a valid partial or full URL to an existing Persistent Disk
19922 # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
19923 # is required.
19924 #
19925 # If desired, you can also attach existing non-root persistent disks using
19926 # this property. This field is only applicable for persistent disks.
19927 #
19928 # Note that for InstanceTemplate, specify the disk name for zonal disk,
19929 # and the URL for regional disk.
19930 &quot;type&quot;: &quot;A String&quot;, # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
19931 },
19932 ],
19933 &quot;displayDevice&quot;: { # A set of Display Device options # Enables display device for the instance.
19934 &quot;enableDisplay&quot;: True or False, # Defines whether the instance has Display enabled.
19935 },
19936 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this resource, which is essentially a hash of
19937 # the instance&#x27;s contents and used for optimistic locking. The
19938 # fingerprint is initially generated by Compute Engine and changes after
19939 # every request to modify or update the instance. You must always provide an
19940 # up-to-date fingerprint hash in order to update the instance.
19941 #
19942 # To see the latest fingerprint, make get() request to the
19943 # instance.
19944 &quot;guestAccelerators&quot;: [ # A list of the type and count of accelerator cards attached to the instance.
19945 { # A specification of the type and number of accelerator cards attached to the
19946 # instance.
19947 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
19948 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this
19949 # instance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100
19950 # If you are creating an instance template, specify only the
19951 # accelerator name.
19952 # See GPUs on Compute Engine
19953 # for a full list of accelerator types.
19954 },
19955 ],
19956 &quot;hostname&quot;: &quot;A String&quot;, # Specifies the hostname of the instance. The specified hostname must be
19957 # RFC1035 compliant. If hostname is not specified, the default hostname is
19958 # [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and
19959 # [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.
19960 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
19961 # defined by the server.
19962 &quot;instanceEncryptionKey&quot;: { # Encrypts suspended data for an instance with acustomer-managed
19963 # encryption key.
19964 #
19965 # If you are creating a new instance, this field will encrypt the local SSD
19966 # and in-memory contents of the instance during the suspend operation.
19967 #
19968 # If you do not provide an encryption key when creating the instance, then
19969 # the local SSD and in-memory contents will be encrypted using
19970 # an automatically generated key during the suspend operation.
19971 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
19972 # For example:
19973 #
19974 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
19975 # key_region/cryptoKeys/key
19976 #
19977 # The fully-qualifed key name may be returned for resource GET requests. For
19978 # example:
19979 #
19980 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
19981 # key_region/cryptoKeys/key
19982 # /cryptoKeyVersions/1
19983 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
19984 # key. If absent, the Compute Engine default service account is used.
19985 # For example:
19986 #
19987 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
19988 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
19989 # encryption key, encoded in RFC
19990 # 4648 base64 to either encrypt or decrypt this resource. You can
19991 # provide either the rawKey or thersaEncryptedKey.
19992 # For example:
19993 #
19994 # &quot;rawKey&quot;:
19995 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
19996 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
19997 # customer-supplied encryption key to either encrypt or decrypt this
19998 # resource. You can provide either the rawKey or thersaEncryptedKey.
19999 # For example:
20000 #
20001 # &quot;rsaEncryptedKey&quot;:
20002 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
20003 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
20004 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
20005 #
20006 # The key must meet the following requirements before you can provide it to
20007 # Compute Engine:
20008 #
20009 # 1. The key is wrapped using a RSA public key certificate provided by
20010 # Google.
20011 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
20012 # encoding.
20013 #
20014 # Gets the RSA public key certificate provided by Google at:
20015 #
20016 #
20017 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
20018 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
20019 # 4648 base64 encoded SHA-256 hash of the customer-supplied
20020 # encryption key that protects this resource.
20021 },
20022 &quot;keyRevocationActionType&quot;: &quot;A String&quot;, # KeyRevocationActionType of the instance. Supported options are &quot;STOP&quot; and
20023 # &quot;NONE&quot;. The default value is &quot;NONE&quot; if it is not specified.
20024 &quot;kind&quot;: &quot;compute#instance&quot;, # Output only. [Output Only] Type of the resource. Always compute#instance
20025 # for instances.
20026 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for this request, which is essentially a hash of
20027 # the label&#x27;s contents and used for optimistic locking. The
20028 # fingerprint is initially generated by Compute Engine and changes after
20029 # every request to modify or update labels. You must always provide an
20030 # up-to-date fingerprint hash in order to update or change labels.
20031 #
20032 # To see the latest fingerprint, make get() request to the
20033 # instance.
20034 &quot;labels&quot;: { # Labels to apply to this instance. These can be later modified by
20035 # the setLabels method.
20036 &quot;a_key&quot;: &quot;A String&quot;,
20037 },
20038 &quot;lastStartTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last start timestamp inRFC3339 text format.
20039 &quot;lastStopTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last stop timestamp inRFC3339 text format.
20040 &quot;lastSuspendedTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last suspended timestamp inRFC3339 text format.
20041 &quot;machineType&quot;: &quot;A String&quot;, # Full or partial URL of the machine type resource to use for this instance,
20042 # in the format:zones/zone/machineTypes/machine-type. This is provided by the client
20043 # when the instance is created. For example, the following is a valid partial
20044 # url to a predefined
20045 # machine type:
20046 #
20047 # zones/us-central1-f/machineTypes/n1-standard-1
20048 #
20049 #
20050 # To create acustom
20051 # machine type, provide a URL to a machine type in the following format,
20052 # where CPUS is 1 or an even number up to 32 (2,
20053 # 4, 6, ... 24, etc), and MEMORY is the total
20054 # memory for this instance. Memory must be a multiple of 256 MB and must
20055 # be supplied in MB (e.g. 5 GB of memory is 5120 MB):
20056 #
20057 # zones/zone/machineTypes/custom-CPUS-MEMORY
20058 #
20059 #
20060 # For example: zones/us-central1-f/machineTypes/custom-4-5120
20061 # For a full list of restrictions, read theSpecifications
20062 # for custom machine types.
20063 &quot;metadata&quot;: { # A metadata key/value entry. # The metadata key/value pairs assigned
20064 # to this instance. This includes metadata keys that were explicitly defined
20065 # for the instance.
20066 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
20067 # the metadata&#x27;s contents and used for optimistic locking. The
20068 # fingerprint is initially generated by Compute Engine and changes after
20069 # every request to modify or update metadata. You must always provide an
20070 # up-to-date fingerprint hash in order to update or change metadata,
20071 # otherwise the request will fail with error412 conditionNotMet.
20072 #
20073 # To see the latest fingerprint, make a get() request to
20074 # retrieve the resource.
20075 &quot;items&quot;: [ # Array of key/value pairs. The total size of all keys and values must be
20076 # less than 512 KB.
20077 { # Metadata
20078 &quot;key&quot;: &quot;A String&quot;, # Key for the metadata entry. Keys must conform to the following
20079 # regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length.
20080 # This is reflected as part of a URL in the metadata server. Additionally, to
20081 # avoid ambiguity, keys must not conflict with any other metadata keys
20082 # for the project.
20083 &quot;value&quot;: &quot;A String&quot;, # Value for the metadata entry. These are free-form strings, and only
20084 # have meaning as interpreted by the image running in the instance. The
20085 # only restriction placed on values is that their size must be less than
20086 # or equal to 262144 bytes (256 KiB).
20087 },
20088 ],
20089 &quot;kind&quot;: &quot;compute#metadata&quot;, # Output only. [Output Only] Type of the resource. Always compute#metadata
20090 # for metadata.
20091 },
20092 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Specifies aminimum CPU
20093 # platform for the VM instance. Applicable values are the friendly names
20094 # of CPU platforms, such as minCpuPlatform: &quot;Intel
20095 # Haswell&quot; or minCpuPlatform: &quot;Intel Sandy
20096 # Bridge&quot;.
20097 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating
20098 # the resource. The resource name must be 1-63 characters long, and comply
20099 # withRFC1035.
20100 # Specifically, the name must be 1-63 characters long and match the regular
20101 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
20102 # character must be a lowercase letter, and all following characters must be
20103 # a dash, lowercase letter, or digit, except the last character, which cannot
20104 # be a dash.
20105 &quot;networkInterfaces&quot;: [ # An array of network configurations for this instance. These specify how
20106 # interfaces are configured to interact with other network services, such as
20107 # connecting to the internet. Multiple interfaces are supported
20108 # per instance.
20109 { # A network interface resource attached to an instance.
20110 &quot;accessConfigs&quot;: [ # An array of configurations for this interface. Currently, only one access
20111 # config, ONE_TO_ONE_NAT, is supported. If there are noaccessConfigs specified, then this instance will have
20112 # no external internet access.
20113 { # An access configuration attached to an instance&#x27;s network interface.
20114 # Only one access config per instance is supported.
20115 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
20116 # The first IPv6 address of the external IPv6 range associated
20117 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
20118 # use a static external IP address, it must be unused and in the same region
20119 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
20120 # assign an external IPv6 address from the instance&#x27;s subnetwork.
20121 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
20122 # external IPv6 range.
20123 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
20124 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
20125 # (IPv4), the default and recommended name is External NAT, but
20126 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
20127 # recommend name is External IPv6.
20128 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
20129 # address associated with this instance. Specify an unused static
20130 # external IP address available to the project or leave this field undefined
20131 # to use an IP from a shared ephemeral IP address pool. If you specify a
20132 # static external IP address, it must live in the same region as the zone of
20133 # the instance.
20134 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
20135 # configuration and can only take the following values: PREMIUM,STANDARD.
20136 #
20137 # If an AccessConfig is specified without a valid external IP address, an
20138 # ephemeral IP will be created with this networkTier.
20139 #
20140 # If an AccessConfig with a valid external IP address is specified, it must
20141 # match that of the networkTier associated with the Address resource owning
20142 # that IP.
20143 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
20144 #
20145 # 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
20146 # first IP in associated external IPv6 range.
20147 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
20148 # config.
20149 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
20150 # external IP address of the instance to a DNS domain name.
20151 #
20152 # This field is not used in ipv6AccessConfig. A default PTR
20153 # record will be created if the VM has external IPv6 range associated.
20154 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
20155 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
20156 },
20157 ],
20158 &quot;aliasIpRanges&quot;: [ # An array of alias IP ranges for this network interface.
20159 # You can only specify this field for network interfaces in VPC networks.
20160 { # An alias IP range attached to an instance&#x27;s network interface.
20161 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
20162 # must belong to the specified subnetwork and cannot contain IP addresses
20163 # reserved by system or used by other network interfaces. This range may be
20164 # 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).
20165 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
20166 # alias range. If not specified, the primary range of the subnetwork is used.
20167 },
20168 ],
20169 &quot;aliasIpv6Ranges&quot;: [ # An array of alias IPv6 ranges for this network interface.
20170 # You can only specify this field for network interfaces in VPC networks.
20171 { # An alias IP range attached to an instance&#x27;s network interface.
20172 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
20173 # must belong to the specified subnetwork and cannot contain IP addresses
20174 # reserved by system or used by other network interfaces. This range may be
20175 # 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).
20176 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
20177 # alias range. If not specified, the primary range of the subnetwork is used.
20178 },
20179 ],
20180 &quot;enableVpcScopedDns&quot;: True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
20181 # with network_attachment.
20182 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint hash of contents stored in this network interface.
20183 # This field will be ignored when inserting an Instance or
20184 # adding a NetworkInterface. An up-to-date
20185 # 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.
20186 &quot;igmpQuery&quot;: &quot;A String&quot;, # Indicate whether igmp query is enabled on the network interface
20187 # or not. If enabled, also indicates the version of IGMP supported.
20188 &quot;internalIpv6PrefixLength&quot;: 42, # The prefix length of the primary internal IPv6 range.
20189 &quot;ipv6AccessConfigs&quot;: [ # An array of IPv6 access configurations for this interface. Currently, only
20190 # one IPv6 access config, DIRECT_IPV6, is supported. If there
20191 # is no ipv6AccessConfig specified, then this instance will
20192 # have no external IPv6 Internet access.
20193 { # An access configuration attached to an instance&#x27;s network interface.
20194 # Only one access config per instance is supported.
20195 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
20196 # The first IPv6 address of the external IPv6 range associated
20197 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
20198 # use a static external IP address, it must be unused and in the same region
20199 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
20200 # assign an external IPv6 address from the instance&#x27;s subnetwork.
20201 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
20202 # external IPv6 range.
20203 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
20204 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
20205 # (IPv4), the default and recommended name is External NAT, but
20206 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
20207 # recommend name is External IPv6.
20208 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
20209 # address associated with this instance. Specify an unused static
20210 # external IP address available to the project or leave this field undefined
20211 # to use an IP from a shared ephemeral IP address pool. If you specify a
20212 # static external IP address, it must live in the same region as the zone of
20213 # the instance.
20214 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
20215 # configuration and can only take the following values: PREMIUM,STANDARD.
20216 #
20217 # If an AccessConfig is specified without a valid external IP address, an
20218 # ephemeral IP will be created with this networkTier.
20219 #
20220 # If an AccessConfig with a valid external IP address is specified, it must
20221 # match that of the networkTier associated with the Address resource owning
20222 # that IP.
20223 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
20224 #
20225 # 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
20226 # first IP in associated external IPv6 range.
20227 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
20228 # config.
20229 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
20230 # external IP address of the instance to a DNS domain name.
20231 #
20232 # This field is not used in ipv6AccessConfig. A default PTR
20233 # record will be created if the VM has external IPv6 range associated.
20234 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
20235 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
20236 },
20237 ],
20238 &quot;ipv6AccessType&quot;: &quot;A String&quot;, # Output only. [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be
20239 # accessed from the Internet. This field is always inherited from its
20240 # subnetwork.
20241 #
20242 # Valid only if stackType is IPV4_IPV6.
20243 &quot;ipv6Address&quot;: &quot;A String&quot;, # An IPv6 internal network address for this network interface. To
20244 # use a static internal IP address, it must be unused and in the same region
20245 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
20246 # assign an internal IPv6 address from the instance&#x27;s subnetwork.
20247 &quot;kind&quot;: &quot;compute#networkInterface&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#networkInterface for network interfaces.
20248 &quot;name&quot;: &quot;A String&quot;, # [Output Only] The name of the network interface, which is generated by the
20249 # server. For a VM, the network interface uses the nicN naming
20250 # format. Where N is a value between 0 and7. The default interface value is nic0.
20251 &quot;network&quot;: &quot;A String&quot;, # URL of the VPC network resource for this instance. When creating an
20252 # instance, if neither the network nor the subnetwork is specified, the
20253 # default network global/networks/default is used. If the
20254 # selected project doesn&#x27;t have the default network, you must specify a
20255 # network or subnet. If the network is not specified but the subnetwork is
20256 # specified, the network is inferred.
20257 #
20258 # If you specify this property, you can specify the network as
20259 # a full or partial URL. For example, the following are all valid URLs:
20260 #
20261 #
20262 # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
20263 # - projects/project/global/networks/network
20264 # - global/networks/default
20265 &quot;networkAttachment&quot;: &quot;A String&quot;, # The URL of the network attachment that this interface should connect
20266 # to in the following format:
20267 # projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.
20268 &quot;networkIP&quot;: &quot;A String&quot;, # An IPv4 internal IP address to assign to the instance for this network
20269 # interface. If not specified by the user, an unused internal IP is
20270 # assigned by the system.
20271 &quot;nicType&quot;: &quot;A String&quot;, # The type of vNIC to be used on this interface. This may be gVNIC or
20272 # VirtioNet.
20273 &quot;parentNicName&quot;: &quot;A String&quot;, # Name of the parent network interface of a dynamic network interface.
20274 &quot;queueCount&quot;: 42, # The networking queue count that&#x27;s specified by users for the network
20275 # interface. Both Rx and Tx queues will be set to this number. It&#x27;ll be empty
20276 # if not specified by the users.
20277 &quot;serviceClassId&quot;: &quot;A String&quot;, # Optional. Producer Service&#x27;s Service class Id for the region of this network
20278 # interface. Can only be used with network_attachment. It is not possible to
20279 # use on its own however, network_attachment can be used without
20280 # service_class_id.
20281 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for this network interface. To assign only IPv4 addresses,
20282 # use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, useIPV4_IPV6. If not specified, IPV4_ONLY is used.
20283 #
20284 # This field can be both set at instance creation and update network
20285 # interface operations.
20286 &quot;subnetwork&quot;: &quot;A String&quot;, # The URL of the Subnetwork resource for this instance. If the network
20287 # resource is inlegacy
20288 # mode, do not specify this field. If the network is in auto subnet
20289 # mode, specifying the subnetwork is optional. If the network is in custom
20290 # subnet mode, specifying the subnetwork is required. If you specify this
20291 # field, you can specify the subnetwork as a full or partial URL. For
20292 # example, the following are all valid URLs:
20293 #
20294 #
20295 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
20296 # - regions/region/subnetworks/subnetwork
20297 &quot;vlan&quot;: 42, # VLAN tag of a dynamic network interface, must be an integer in the range
20298 # from 2 to 255 inclusively.
20299 },
20300 ],
20301 &quot;networkPerformanceConfig&quot;: {
20302 &quot;totalEgressBandwidthTier&quot;: &quot;A String&quot;,
20303 },
20304 &quot;params&quot;: { # Additional instance params. # Input only. [Input Only] Additional params passed with the request, but not persisted
20305 # as part of resource payload.
20306 &quot;requestValidForDuration&quot;: { # A Duration represents a fixed-length span of time represented # Relative deadline for waiting for capacity. Relevant only for
20307 # Instances.Insert API.
20308 # as a count of seconds and fractions of seconds at nanosecond
20309 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
20310 # or &quot;month&quot;. Range is approximately 10,000 years.
20311 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
20312 # Durations less than one second are represented with a 0
20313 # `seconds` field and a positive `nanos` field. Must be from 0
20314 # to 999,999,999 inclusive.
20315 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
20316 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
20317 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
20318 },
20319 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the instance. Tag keys and values
20320 # have the same definition as resource
20321 # manager tags. Keys and values can be either in numeric format,
20322 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
20323 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
20324 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
20325 # PATCH) when empty.
20326 &quot;a_key&quot;: &quot;A String&quot;,
20327 },
20328 },
20329 &quot;privateIpv6GoogleAccess&quot;: &quot;A String&quot;, # The private IPv6 google access type for the VM.
20330 # If not specified, use INHERIT_FROM_SUBNETWORK as default.
20331 &quot;reservationAffinity&quot;: { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.
20332 &quot;consumeReservationType&quot;: &quot;A String&quot;, # Specifies the type of reservation from which this instance can consume
20333 # resources: ANY_RESERVATION (default),SPECIFIC_RESERVATION, or NO_RESERVATION. See
20334 # Consuming reserved instances for examples.
20335 &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
20336 # the name of your reservation as its value.
20337 &quot;values&quot;: [ # Corresponds to the label values of a reservation resource. This can be
20338 # either a name to a reservation in the same project or
20339 # &quot;projects/different-project/reservations/some-reservation-name&quot; to target a
20340 # shared reservation in the same zone but in a different project.
20341 &quot;A String&quot;,
20342 ],
20343 },
20344 &quot;resourcePolicies&quot;: [ # Resource policies applied to this instance.
20345 &quot;A String&quot;,
20346 ],
20347 &quot;resourceStatus&quot;: { # Contains output only fields. # Output only. [Output Only] Specifies values set for instance attributes as
20348 # compared to the values requested by user in the corresponding input only
20349 # field.
20350 # Use this sub-message for actual values set on Instance attributes as compared
20351 # to the value requested by the user (intent) in their instance CRUD calls.
20352 &quot;effectiveInstanceMetadata&quot;: { # Effective values of predefined metadata keys for an instance. # Output only. [Output Only] Effective metadata is a field that consolidates project,
20353 # zonal instance settings, and instance-level predefined metadata keys to
20354 # provide the overridden value for those metadata keys at the instance level.
20355 &quot;blockProjectSshKeysMetadataValue&quot;: True or False, # Effective block-project-ssh-keys value at Instance level.
20356 &quot;enableGuestAttributesMetadataValue&quot;: True or False, # Effective enable-guest-attributes value at Instance level.
20357 &quot;enableOsInventoryMetadataValue&quot;: True or False, # Effective enable-os-inventory value at Instance level.
20358 &quot;enableOsconfigMetadataValue&quot;: True or False, # Effective enable-osconfig value at Instance level.
20359 &quot;enableOsloginMetadataValue&quot;: True or False, # Effective enable-oslogin value at Instance level.
20360 &quot;gceContainerDeclarationMetadataValue&quot;: True or False, # Effective gce-container-declaration value at Instance level.
20361 &quot;serialPortEnableMetadataValue&quot;: True or False, # Effective serial-port-enable value at Instance level.
20362 &quot;serialPortLoggingEnableMetadataValue&quot;: True or False, # Effective serial-port-logging-enable value at Instance level.
20363 &quot;vmDnsSettingMetadataValue&quot;: &quot;A String&quot;, # Effective VM DNS setting at Instance level.
20364 },
20365 &quot;physicalHost&quot;: &quot;A String&quot;, # Output only. [Output Only] The precise location of your instance within the zone&#x27;s data
20366 # center, including the block, sub-block, and host. The field is formatted as
20367 # follows: blockId/subBlockId/hostId.
20368 &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
20369 # Engine cluster, as well as the ID of the block, sub-block, and host on
20370 # which the running instance is located.
20371 # running.
20372 &quot;additionalAttributes&quot;: { # Additional location information of the running instance. # Output only. [Output Only] Additional location information of the running instance.
20373 &quot;acceleratorTopologyIds&quot;: { # Output only. The IDs of the accelerator topologies the instance belongs to. For
20374 # example
20375 # The key will be topologies like &quot;4x4&quot;, &quot;2x2x2&quot; and the value will be
20376 # the location ID of the topologies.
20377 &quot;a_key&quot;: &quot;A String&quot;,
20378 },
20379 },
20380 &quot;block&quot;: &quot;A String&quot;, # [Output Only] The ID of the block in which the running instance is
20381 # located. Instances within the same block experience low network latency.
20382 &quot;cluster&quot;: &quot;A String&quot;, # [Output Only] The global name of the Compute Engine cluster where the
20383 # running instance is located.
20384 &quot;host&quot;: &quot;A String&quot;, # [Output Only] The ID of the host on which the running instance is located.
20385 # Instances on the same host experience the lowest possible network
20386 # latency.
20387 &quot;subblock&quot;: &quot;A String&quot;, # [Output Only] The ID of the sub-block in which the running instance is
20388 # located. Instances in the same sub-block experience lower network latency
20389 # than instances in the same block.
20390 },
20391 &quot;reservationConsumptionInfo&quot;: { # Reservation consumption information that the instance is consuming from. # Output only. [Output Only] Reservation information that the instance is consuming from.
20392 &quot;consumedReservation&quot;: &quot;A String&quot;, # Output only. [Output Only] The full resource name of the reservation that this
20393 # instance is consuming from.
20394 },
20395 &quot;scheduling&quot;: {
20396 &quot;availabilityDomain&quot;: 42, # Specifies the availability domain to place the instance in. The value
20397 # must be a number between 1 and the number of availability domains
20398 # specified in the spread placement policy attached to the instance.
20399 },
20400 &quot;upcomingMaintenance&quot;: { # Upcoming Maintenance notification information.
20401 &quot;canReschedule&quot;: True or False, # Indicates if the maintenance can be customer triggered.
20402 &quot;latestWindowStartTime&quot;: &quot;A String&quot;, # The latest time for the planned maintenance window to start.
20403 # This timestamp value is in RFC3339 text format.
20404 &quot;maintenanceOnShutdown&quot;: True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown.
20405 &quot;maintenanceReasons&quot;: [ # The reasons for the maintenance. Only valid for vms.
20406 &quot;A String&quot;,
20407 ],
20408 &quot;maintenanceStatus&quot;: &quot;A String&quot;,
20409 &quot;type&quot;: &quot;A String&quot;, # Defines the type of maintenance.
20410 &quot;windowEndTime&quot;: &quot;A String&quot;, # The time by which the maintenance disruption will be completed.
20411 # This timestamp value is in RFC3339 text format.
20412 &quot;windowStartTime&quot;: &quot;A String&quot;, # The current start time of the maintenance window.
20413 # This timestamp value is in RFC3339 text format.
20414 },
20415 },
20416 &quot;satisfiesPzi&quot;: True or False, # Output only. [Output Only] Reserved for future use.
20417 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
20418 &quot;scheduling&quot;: { # Sets the scheduling options for an Instance. # Sets the scheduling options for this instance.
20419 &quot;automaticRestart&quot;: True or False, # Specifies whether the instance should be automatically restarted if it is
20420 # terminated by Compute Engine (not terminated by a user). You can only set
20421 # the automatic restart option for standard instances.Preemptible instances
20422 # cannot be automatically restarted.
20423 #
20424 # By default, this is set to true so an instance is
20425 # automatically restarted if it is terminated by Compute Engine.
20426 &quot;availabilityDomain&quot;: 42, # Specifies the availability domain to place the instance in. The value
20427 # must be a number between 1 and the number of availability domains
20428 # specified in the spread placement policy attached to the instance.
20429 &quot;hostErrorTimeoutSeconds&quot;: 42, # Specify the time in seconds for host error detection, the value must be
20430 # within the range of [90, 330] with the increment of 30, if unset, the
20431 # default behavior of host error recovery will be used.
20432 &quot;instanceTerminationAction&quot;: &quot;A String&quot;, # Specifies the termination action for the instance.
20433 &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
20434 # recovery of the Local Ssd state is attempted. Its value should be in
20435 # between 0 and 168 hours with hour granularity and the default value being 1
20436 # hour.
20437 # as a count of seconds and fractions of seconds at nanosecond
20438 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
20439 # or &quot;month&quot;. Range is approximately 10,000 years.
20440 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
20441 # Durations less than one second are represented with a 0
20442 # `seconds` field and a positive `nanos` field. Must be from 0
20443 # to 999,999,999 inclusive.
20444 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
20445 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
20446 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
20447 },
20448 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the instance close to other
20449 # resources.
20450 # This field is for use by internal tools that use the public API.
20451 &quot;maxRunDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the max run duration for the given instance. If specified,
20452 # the instance termination action will be performed at the end of the run
20453 # duration.
20454 # as a count of seconds and fractions of seconds at nanosecond
20455 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
20456 # or &quot;month&quot;. Range is approximately 10,000 years.
20457 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
20458 # Durations less than one second are represented with a 0
20459 # `seconds` field and a positive `nanos` field. Must be from 0
20460 # to 999,999,999 inclusive.
20461 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
20462 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
20463 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
20464 },
20465 &quot;minNodeCpus&quot;: 42, # The minimum number of virtual CPUs this instance will consume when running
20466 # on a sole-tenant node.
20467 &quot;nodeAffinities&quot;: [ # A set of node affinity and anti-affinity configurations. Refer toConfiguring node
20468 # affinity for more information.
20469 # Overrides reservationAffinity.
20470 { # Node Affinity: the configuration of desired nodes onto which this Instance
20471 # could be scheduled.
20472 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of Node resource.
20473 &quot;operator&quot;: &quot;A String&quot;, # Defines the operation of node selection. Valid operators areIN for affinity and NOT_IN for anti-affinity.
20474 &quot;values&quot;: [ # Corresponds to the label values of Node resource.
20475 &quot;A String&quot;,
20476 ],
20477 },
20478 ],
20479 &quot;onHostMaintenance&quot;: &quot;A String&quot;, # Defines the maintenance behavior for this instance. For standard instances,
20480 # the default behavior is MIGRATE. Forpreemptible instances,
20481 # the default and only possible behavior is TERMINATE. For more
20482 # information, see
20483 # Set
20484 # VM host maintenance policy.
20485 &quot;onInstanceStopAction&quot;: { # Defines the behaviour for instances with the instance_termination_actionSTOP.
20486 &quot;discardLocalSsd&quot;: True or False, # If true, the contents of any attached Local SSD disks will be discarded
20487 # else, the Local SSD data will be preserved when the instance is stopped
20488 # at the end of the run duration/termination time.
20489 },
20490 &quot;preemptible&quot;: True or False, # Defines whether the instance is preemptible. This can only be set during
20491 # instance creation or while the instance isstopped and
20492 # therefore, in a `TERMINATED` state. SeeInstance Life
20493 # Cycle for more information on the possible instance states.
20494 &quot;provisioningModel&quot;: &quot;A String&quot;, # Specifies the provisioning model of the instance.
20495 &quot;skipGuestOsShutdown&quot;: True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
20496 # Off and ACPI G3 Mechanical
20497 # Off for Standard VMs and 30 seconds for Spot VMs.
20498 &quot;terminationTime&quot;: &quot;A String&quot;, # Specifies the timestamp, when the instance will be terminated, inRFC3339 text format. If specified, the instance
20499 # termination action will be performed at the termination time.
20500 },
20501 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
20502 &quot;serviceAccounts&quot;: [ # A list of service accounts, with their specified scopes, authorized for
20503 # this instance. Only one service account per VM instance is supported.
20504 #
20505 # Service accounts generate access tokens that can be accessed
20506 # through the metadata server and used to authenticate applications on the
20507 # instance. SeeService Accounts
20508 # for more information.
20509 { # A service account.
20510 &quot;email&quot;: &quot;A String&quot;, # Email address of the service account.
20511 &quot;scopes&quot;: [ # The list of scopes to be made available for this service account.
20512 &quot;A String&quot;,
20513 ],
20514 },
20515 ],
20516 &quot;shieldedInstanceConfig&quot;: { # A set of Shielded Instance options.
20517 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.Enabled by
20518 # default.
20519 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.Disabled by
20520 # default.
20521 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.Enabled by
20522 # default.
20523 },
20524 &quot;shieldedInstanceIntegrityPolicy&quot;: { # The policy describes the baseline against which
20525 # Instance boot integrity is measured.
20526 &quot;updateAutoLearnPolicy&quot;: True or False, # Updates the integrity policy baseline using the
20527 # measurements from the VM instance&#x27;s most recent boot.
20528 },
20529 &quot;sourceMachineImage&quot;: &quot;A String&quot;, # Source machine image
20530 &quot;sourceMachineImageEncryptionKey&quot;: { # Source machine image encryption key when creating an instance from a
20531 # machine image.
20532 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
20533 # For example:
20534 #
20535 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
20536 # key_region/cryptoKeys/key
20537 #
20538 # The fully-qualifed key name may be returned for resource GET requests. For
20539 # example:
20540 #
20541 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
20542 # key_region/cryptoKeys/key
20543 # /cryptoKeyVersions/1
20544 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
20545 # key. If absent, the Compute Engine default service account is used.
20546 # For example:
20547 #
20548 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
20549 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
20550 # encryption key, encoded in RFC
20551 # 4648 base64 to either encrypt or decrypt this resource. You can
20552 # provide either the rawKey or thersaEncryptedKey.
20553 # For example:
20554 #
20555 # &quot;rawKey&quot;:
20556 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
20557 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
20558 # customer-supplied encryption key to either encrypt or decrypt this
20559 # resource. You can provide either the rawKey or thersaEncryptedKey.
20560 # For example:
20561 #
20562 # &quot;rsaEncryptedKey&quot;:
20563 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
20564 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
20565 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
20566 #
20567 # The key must meet the following requirements before you can provide it to
20568 # Compute Engine:
20569 #
20570 # 1. The key is wrapped using a RSA public key certificate provided by
20571 # Google.
20572 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
20573 # encoding.
20574 #
20575 # Gets the RSA public key certificate provided by Google at:
20576 #
20577 #
20578 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
20579 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
20580 # 4648 base64 encoded SHA-256 hash of the customer-supplied
20581 # encryption key that protects this resource.
20582 },
20583 &quot;startRestricted&quot;: True or False, # Output only. [Output Only] Whether a VM has been restricted for start because Compute
20584 # Engine has detected suspicious activity.
20585 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the instance. One of the
20586 # following values: PROVISIONING, STAGING,RUNNING, STOPPING, SUSPENDING,SUSPENDED, REPAIRING, andTERMINATED. For more information about the status of the
20587 # instance, see
20588 # Instance life cycle.
20589 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. [Output Only] An optional, human-readable explanation of the status.
20590 &quot;tags&quot;: { # A set of instance tags. # Tags to apply to this instance. Tags are used to identify valid
20591 # sources or targets for network firewalls and are specified by the client
20592 # during instance creation. The tags can be later modified by the setTags
20593 # method. Each tag within the list must comply withRFC1035.
20594 # Multiple tags can be specified via the &#x27;tags.items&#x27; field.
20595 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
20596 # the tags&#x27; contents and used for optimistic locking. The
20597 # fingerprint is initially generated by Compute Engine and changes after
20598 # every request to modify or update tags. You must always provide an
20599 # up-to-date fingerprint hash in order to update or change tags.
20600 #
20601 # To see the latest fingerprint, make get() request to the
20602 # instance.
20603 &quot;items&quot;: [ # An array of tags. Each tag must be 1-63 characters long, and comply
20604 # with RFC1035.
20605 &quot;A String&quot;,
20606 ],
20607 },
20608 &quot;workloadIdentityConfig&quot;: {
20609 &quot;identity&quot;: &quot;A String&quot;,
20610 &quot;identityCertificateEnabled&quot;: True or False,
20611 },
20612 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the zone where the instance resides.
20613 # You must specify this field as part of the HTTP request URL. It is
20614 # not settable as a field in the request body.
20615 }
20616
20617 discardLocalSsd: boolean, Whether to discard local SSDs from the instance during restart
20618 default value is false.
20619 minimalAction: string, Specifies the action to take when updating an instance even if the
20620 updated properties do not require it. If not specified, then
20621 Compute Engine acts based on the minimum action that the updated
20622 properties require.
20623 Allowed values
20624 INVALID -
20625 NO_EFFECT - No changes can be made to the instance.
20626 REFRESH - The instance will not restart.
20627 RESTART - The instance will restart, potentially on a different host.
20628 mostDisruptiveAllowedAction: string, Specifies the most disruptive action that can be taken on the instance
20629 as part of the update. Compute Engine returns an error if the
20630 instance properties require a more disruptive action as part of the
20631 instance update. Valid options from lowest to highest are
20632 NO_EFFECT, REFRESH, and RESTART.
20633 Allowed values
20634 INVALID -
20635 NO_EFFECT - No changes can be made to the instance.
20636 REFRESH - The instance will not restart.
20637 RESTART - The instance will restart, potentially on a different host.
20638 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
20639 that if you must retry your request, the server will know to ignore the
20640 request if it has already been completed.
20641
20642 For example, consider a situation where you make an initial request and
20643 the request times out. If you make the request again with the same
20644 request ID, the server can check if original operation with the same
20645 request ID was received, and if so, will ignore the second request. This
20646 prevents clients from accidentally creating duplicate commitments.
20647
20648 The request ID must be
20649 a valid UUID with the exception that zero UUID is not supported
20650 (00000000-0000-0000-0000-000000000000).
20651 x__xgafv: string, V1 error format.
20652 Allowed values
20653 1 - v1 error format
20654 2 - v2 error format
20655
20656 Returns:
20657 An object of the form:
20658
20659 { # Represents an Operation resource.
20660 #
20661 # Google Compute Engine has three Operation resources:
20662 #
20663 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
20664 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
20665 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
20666 #
20667 # You can use an operation resource to manage asynchronous API requests.
20668 # For more information, readHandling
20669 # API responses.
20670 #
20671 # Operations can be global, regional or zonal.
20672 #
20673 # - For global operations, use the `globalOperations`
20674 # resource.
20675 # - For regional operations, use the
20676 # `regionOperations` resource.
20677 # - For zonal operations, use
20678 # the `zoneOperations` resource.
20679 #
20680 #
20681 #
20682 # For more information, read
20683 # Global, Regional, and Zonal Resources.
20684 #
20685 # Note that completed Operation resources have a limited
20686 # retention period.
20687 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
20688 # Not present otherwise.
20689 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
20690 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
20691 # set when the operation is created.
20692 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
20693 # text format.
20694 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
20695 # this field will be populated.
20696 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
20697 # operation.
20698 {
20699 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
20700 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
20701 # details. There is a set of defined message types to use for providing
20702 # details.The syntax depends on the error code. For example,
20703 # QuotaExceededInfo will have details when the error code is
20704 # QUOTA_EXCEEDED.
20705 {
20706 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
20707 #
20708 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
20709 # is not enabled:
20710 #
20711 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
20712 # &quot;domain&quot;: &quot;googleapis.com&quot;
20713 # &quot;metadata&quot;: {
20714 # &quot;resource&quot;: &quot;projects/123&quot;,
20715 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
20716 # }
20717 # }
20718 #
20719 # This response indicates that the pubsub.googleapis.com API is not enabled.
20720 #
20721 # Example of an error that is returned when attempting to create a Spanner
20722 # instance in a region that is out of stock:
20723 #
20724 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
20725 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
20726 # &quot;metadata&quot;: {
20727 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
20728 # }
20729 # }
20730 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
20731 # is typically the registered service name of the tool or product that
20732 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
20733 # generated by some common infrastructure, the error domain must be a
20734 # globally unique value that identifies the infrastructure. For Google API
20735 # infrastructure, the error domain is &quot;googleapis.com&quot;.
20736 &quot;metadatas&quot;: { # Additional structured details about this error.
20737 #
20738 # Keys must match a regular expression of `a-z+` but should
20739 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
20740 # length. When identifying the current value of an exceeded limit, the units
20741 # should be contained in the key, not the value. For example, rather than
20742 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
20743 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
20744 # instances that can be created in a single (batch) request.
20745 &quot;a_key&quot;: &quot;A String&quot;,
20746 },
20747 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
20748 # proximate cause of the error. Error reasons are unique within a particular
20749 # domain of errors. This should be at most 63 characters and match a
20750 # regular expression of `A-Z+[A-Z0-9]`, which represents
20751 # UPPER_SNAKE_CASE.
20752 },
20753 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
20754 #
20755 # For example, if a quota check failed with an error indicating the calling
20756 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
20757 # directly to the right place in the developer console to flip the bit.
20758 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
20759 { # Describes a URL link.
20760 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
20761 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
20762 },
20763 ],
20764 },
20765 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
20766 # which can be attached to an RPC error.
20767 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
20768 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
20769 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
20770 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
20771 },
20772 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
20773 &quot;dimensions&quot;: { # The map holding related quota dimensions.
20774 &quot;a_key&quot;: &quot;A String&quot;,
20775 },
20776 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
20777 # type or metric.
20778 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
20779 # or metric.
20780 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
20781 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
20782 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
20783 },
20784 },
20785 ],
20786 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
20787 # This property is optional.
20788 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
20789 },
20790 ],
20791 },
20792 &quot;getVersionOperationMetadata&quot;: {
20793 &quot;inlineSbomInfo&quot;: {
20794 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
20795 # appropriate identifiers.
20796 &quot;a_key&quot;: &quot;A String&quot;,
20797 },
20798 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
20799 # identifiers.
20800 &quot;a_key&quot;: &quot;A String&quot;,
20801 },
20802 },
20803 },
20804 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
20805 # message that was returned, such as `NOT FOUND`.
20806 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
20807 # status code that was returned. For example, a `404` means the
20808 # resource was not found.
20809 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
20810 # defined by the server.
20811 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
20812 # This value is inRFC3339
20813 # text format.
20814 &quot;instancesBulkInsertOperationMetadata&quot;: {
20815 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
20816 # Example key: zones/us-central1-a
20817 &quot;a_key&quot;: {
20818 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
20819 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
20820 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
20821 # error.
20822 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
20823 # if the flow is rolling forward or rolling back.
20824 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
20825 },
20826 },
20827 },
20828 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
20829 # Operation resources.
20830 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
20831 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
20832 # group of operations results from a `bulkInsert` API request.
20833 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
20834 # `update`, or `delete`, and so on.
20835 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
20836 # There is no requirement that this be linear or support any granularity of
20837 # operations. This should not be used to guess when the operation will be
20838 # complete. This number should monotonically increase as the operation
20839 # progresses.
20840 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
20841 # applicable when performing regional operations.
20842 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
20843 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
20844 # this field will contain information on all underlying zonal actions and
20845 # their state.
20846 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
20847 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
20848 # Example key: zones/us-central1-a
20849 &quot;a_key&quot;: {
20850 &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
20851 # populated.
20852 # different programming environments, including REST APIs and RPC APIs. It is
20853 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
20854 # three pieces of data: error code, error message, and error details.
20855 #
20856 # You can find out more about this error model and how to work with it in the
20857 # [API Design Guide](https://cloud.google.com/apis/design/errors).
20858 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
20859 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
20860 # message types for APIs to use.
20861 {
20862 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
20863 },
20864 ],
20865 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
20866 # user-facing error message should be localized and sent in the
20867 # google.rpc.Status.details field, or localized by the client.
20868 },
20869 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
20870 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
20871 },
20872 },
20873 },
20874 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
20875 # This value is inRFC3339
20876 # text format.
20877 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
20878 # following:
20879 # `PENDING`, `RUNNING`, or `DONE`.
20880 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
20881 # operation.
20882 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
20883 # of the target resource.
20884 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
20885 # operations related to creating a snapshot, this points to the disk
20886 # that the snapshot was created from.
20887 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
20888 # `[email protected]` or
20889 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
20890 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
20891 # operation, this field will be populated.
20892 {
20893 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
20894 # Engine returns NO_RESULTS_ON_PAGE if there
20895 # are no results in the response.
20896 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
20897 # value format. For example:
20898 #
20899 # &quot;data&quot;: [
20900 # {
20901 # &quot;key&quot;: &quot;scope&quot;,
20902 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
20903 # }
20904 {
20905 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
20906 # returned. For example, for warnings where there are no results in a list
20907 # request for a particular zone, this key might be scope and
20908 # the key value might be the zone name. Other examples might be a key
20909 # indicating a deprecated resource and a suggested replacement, or a
20910 # warning about invalid network settings (for example, if an instance
20911 # attempts to perform IP forwarding but is not enabled for IP forwarding).
20912 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
20913 },
20914 ],
20915 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
20916 },
20917 ],
20918 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
20919 # applicable when performing per-zone operations.
20920 }</pre>
20921 </div>
20922
20923 <div class="method">
20924 <code class="details" id="updateAccessConfig">updateAccessConfig(project, zone, instance, networkInterface, body=None, requestId=None, x__xgafv=None)</code>
20925 <pre>Updates the specified access config from an instance&#x27;s network interface
20926 with the data included in the request. This method supportsPATCH
20927 semantics and uses theJSON merge
20928 patch format and processing rules.
20929
20930 Args:
20931 project: string, Project ID for this request. (required)
20932 zone: string, The name of the zone for this request. (required)
20933 instance: string, The instance name for this request. (required)
20934 networkInterface: string, The name of the network interface where the access config is attached. (required)
20935 body: object, The request body.
20936 The object takes the form of:
20937
20938 { # An access configuration attached to an instance&#x27;s network interface.
20939 # Only one access config per instance is supported.
20940 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
20941 # The first IPv6 address of the external IPv6 range associated
20942 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
20943 # use a static external IP address, it must be unused and in the same region
20944 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
20945 # assign an external IPv6 address from the instance&#x27;s subnetwork.
20946 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
20947 # external IPv6 range.
20948 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
20949 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
20950 # (IPv4), the default and recommended name is External NAT, but
20951 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
20952 # recommend name is External IPv6.
20953 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
20954 # address associated with this instance. Specify an unused static
20955 # external IP address available to the project or leave this field undefined
20956 # to use an IP from a shared ephemeral IP address pool. If you specify a
20957 # static external IP address, it must live in the same region as the zone of
20958 # the instance.
20959 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
20960 # configuration and can only take the following values: PREMIUM,STANDARD.
20961 #
20962 # If an AccessConfig is specified without a valid external IP address, an
20963 # ephemeral IP will be created with this networkTier.
20964 #
20965 # If an AccessConfig with a valid external IP address is specified, it must
20966 # match that of the networkTier associated with the Address resource owning
20967 # that IP.
20968 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
20969 #
20970 # 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
20971 # first IP in associated external IPv6 range.
20972 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
20973 # config.
20974 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
20975 # external IP address of the instance to a DNS domain name.
20976 #
20977 # This field is not used in ipv6AccessConfig. A default PTR
20978 # record will be created if the VM has external IPv6 range associated.
20979 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
20980 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
20981 }
20982
20983 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
20984 that if you must retry your request, the server will know to ignore the
20985 request if it has already been completed.
20986
20987 For example, consider a situation where you make an initial request and
20988 the request times out. If you make the request again with the same
20989 request ID, the server can check if original operation with the same
20990 request ID was received, and if so, will ignore the second request. This
20991 prevents clients from accidentally creating duplicate commitments.
20992
20993 The request ID must be
20994 a valid UUID with the exception that zero UUID is not supported
20995 (00000000-0000-0000-0000-000000000000).
20996 x__xgafv: string, V1 error format.
20997 Allowed values
20998 1 - v1 error format
20999 2 - v2 error format
21000
21001 Returns:
21002 An object of the form:
21003
21004 { # Represents an Operation resource.
21005 #
21006 # Google Compute Engine has three Operation resources:
21007 #
21008 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
21009 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
21010 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
21011 #
21012 # You can use an operation resource to manage asynchronous API requests.
21013 # For more information, readHandling
21014 # API responses.
21015 #
21016 # Operations can be global, regional or zonal.
21017 #
21018 # - For global operations, use the `globalOperations`
21019 # resource.
21020 # - For regional operations, use the
21021 # `regionOperations` resource.
21022 # - For zonal operations, use
21023 # the `zoneOperations` resource.
21024 #
21025 #
21026 #
21027 # For more information, read
21028 # Global, Regional, and Zonal Resources.
21029 #
21030 # Note that completed Operation resources have a limited
21031 # retention period.
21032 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
21033 # Not present otherwise.
21034 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
21035 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
21036 # set when the operation is created.
21037 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
21038 # text format.
21039 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
21040 # this field will be populated.
21041 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
21042 # operation.
21043 {
21044 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
21045 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
21046 # details. There is a set of defined message types to use for providing
21047 # details.The syntax depends on the error code. For example,
21048 # QuotaExceededInfo will have details when the error code is
21049 # QUOTA_EXCEEDED.
21050 {
21051 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
21052 #
21053 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
21054 # is not enabled:
21055 #
21056 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
21057 # &quot;domain&quot;: &quot;googleapis.com&quot;
21058 # &quot;metadata&quot;: {
21059 # &quot;resource&quot;: &quot;projects/123&quot;,
21060 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
21061 # }
21062 # }
21063 #
21064 # This response indicates that the pubsub.googleapis.com API is not enabled.
21065 #
21066 # Example of an error that is returned when attempting to create a Spanner
21067 # instance in a region that is out of stock:
21068 #
21069 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
21070 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
21071 # &quot;metadata&quot;: {
21072 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
21073 # }
21074 # }
21075 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
21076 # is typically the registered service name of the tool or product that
21077 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
21078 # generated by some common infrastructure, the error domain must be a
21079 # globally unique value that identifies the infrastructure. For Google API
21080 # infrastructure, the error domain is &quot;googleapis.com&quot;.
21081 &quot;metadatas&quot;: { # Additional structured details about this error.
21082 #
21083 # Keys must match a regular expression of `a-z+` but should
21084 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
21085 # length. When identifying the current value of an exceeded limit, the units
21086 # should be contained in the key, not the value. For example, rather than
21087 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
21088 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
21089 # instances that can be created in a single (batch) request.
21090 &quot;a_key&quot;: &quot;A String&quot;,
21091 },
21092 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
21093 # proximate cause of the error. Error reasons are unique within a particular
21094 # domain of errors. This should be at most 63 characters and match a
21095 # regular expression of `A-Z+[A-Z0-9]`, which represents
21096 # UPPER_SNAKE_CASE.
21097 },
21098 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
21099 #
21100 # For example, if a quota check failed with an error indicating the calling
21101 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
21102 # directly to the right place in the developer console to flip the bit.
21103 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
21104 { # Describes a URL link.
21105 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
21106 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
21107 },
21108 ],
21109 },
21110 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
21111 # which can be attached to an RPC error.
21112 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
21113 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
21114 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
21115 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
21116 },
21117 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
21118 &quot;dimensions&quot;: { # The map holding related quota dimensions.
21119 &quot;a_key&quot;: &quot;A String&quot;,
21120 },
21121 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
21122 # type or metric.
21123 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
21124 # or metric.
21125 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
21126 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
21127 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
21128 },
21129 },
21130 ],
21131 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
21132 # This property is optional.
21133 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
21134 },
21135 ],
21136 },
21137 &quot;getVersionOperationMetadata&quot;: {
21138 &quot;inlineSbomInfo&quot;: {
21139 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
21140 # appropriate identifiers.
21141 &quot;a_key&quot;: &quot;A String&quot;,
21142 },
21143 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
21144 # identifiers.
21145 &quot;a_key&quot;: &quot;A String&quot;,
21146 },
21147 },
21148 },
21149 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
21150 # message that was returned, such as `NOT FOUND`.
21151 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
21152 # status code that was returned. For example, a `404` means the
21153 # resource was not found.
21154 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
21155 # defined by the server.
21156 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
21157 # This value is inRFC3339
21158 # text format.
21159 &quot;instancesBulkInsertOperationMetadata&quot;: {
21160 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
21161 # Example key: zones/us-central1-a
21162 &quot;a_key&quot;: {
21163 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
21164 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
21165 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
21166 # error.
21167 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
21168 # if the flow is rolling forward or rolling back.
21169 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
21170 },
21171 },
21172 },
21173 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
21174 # Operation resources.
21175 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
21176 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
21177 # group of operations results from a `bulkInsert` API request.
21178 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
21179 # `update`, or `delete`, and so on.
21180 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
21181 # There is no requirement that this be linear or support any granularity of
21182 # operations. This should not be used to guess when the operation will be
21183 # complete. This number should monotonically increase as the operation
21184 # progresses.
21185 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
21186 # applicable when performing regional operations.
21187 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
21188 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
21189 # this field will contain information on all underlying zonal actions and
21190 # their state.
21191 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
21192 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
21193 # Example key: zones/us-central1-a
21194 &quot;a_key&quot;: {
21195 &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
21196 # populated.
21197 # different programming environments, including REST APIs and RPC APIs. It is
21198 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
21199 # three pieces of data: error code, error message, and error details.
21200 #
21201 # You can find out more about this error model and how to work with it in the
21202 # [API Design Guide](https://cloud.google.com/apis/design/errors).
21203 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
21204 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
21205 # message types for APIs to use.
21206 {
21207 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
21208 },
21209 ],
21210 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
21211 # user-facing error message should be localized and sent in the
21212 # google.rpc.Status.details field, or localized by the client.
21213 },
21214 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
21215 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
21216 },
21217 },
21218 },
21219 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
21220 # This value is inRFC3339
21221 # text format.
21222 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
21223 # following:
21224 # `PENDING`, `RUNNING`, or `DONE`.
21225 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
21226 # operation.
21227 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
21228 # of the target resource.
21229 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
21230 # operations related to creating a snapshot, this points to the disk
21231 # that the snapshot was created from.
21232 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
21233 # `[email protected]` or
21234 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
21235 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
21236 # operation, this field will be populated.
21237 {
21238 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
21239 # Engine returns NO_RESULTS_ON_PAGE if there
21240 # are no results in the response.
21241 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
21242 # value format. For example:
21243 #
21244 # &quot;data&quot;: [
21245 # {
21246 # &quot;key&quot;: &quot;scope&quot;,
21247 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
21248 # }
21249 {
21250 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
21251 # returned. For example, for warnings where there are no results in a list
21252 # request for a particular zone, this key might be scope and
21253 # the key value might be the zone name. Other examples might be a key
21254 # indicating a deprecated resource and a suggested replacement, or a
21255 # warning about invalid network settings (for example, if an instance
21256 # attempts to perform IP forwarding but is not enabled for IP forwarding).
21257 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
21258 },
21259 ],
21260 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
21261 },
21262 ],
21263 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
21264 # applicable when performing per-zone operations.
21265 }</pre>
21266 </div>
21267
21268 <div class="method">
21269 <code class="details" id="updateDisplayDevice">updateDisplayDevice(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
21270 <pre>Updates the Display config for a VM instance. You can
21271 only use this method on a stopped VM instance. This method supportsPATCH
21272 semantics and uses theJSON merge
21273 patch format and processing rules.
21274
21275 Args:
21276 project: string, Project ID for this request. (required)
21277 zone: string, The name of the zone for this request. (required)
21278 instance: string, Name of the instance scoping this request. (required)
21279 body: object, The request body.
21280 The object takes the form of:
21281
21282 { # A set of Display Device options
21283 &quot;enableDisplay&quot;: True or False, # Defines whether the instance has Display enabled.
21284 }
21285
21286 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
21287 that if you must retry your request, the server will know to ignore the
21288 request if it has already been completed.
21289
21290 For example, consider a situation where you make an initial request and
21291 the request times out. If you make the request again with the same
21292 request ID, the server can check if original operation with the same
21293 request ID was received, and if so, will ignore the second request. This
21294 prevents clients from accidentally creating duplicate commitments.
21295
21296 The request ID must be
21297 a valid UUID with the exception that zero UUID is not supported
21298 (00000000-0000-0000-0000-000000000000).
21299 x__xgafv: string, V1 error format.
21300 Allowed values
21301 1 - v1 error format
21302 2 - v2 error format
21303
21304 Returns:
21305 An object of the form:
21306
21307 { # Represents an Operation resource.
21308 #
21309 # Google Compute Engine has three Operation resources:
21310 #
21311 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
21312 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
21313 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
21314 #
21315 # You can use an operation resource to manage asynchronous API requests.
21316 # For more information, readHandling
21317 # API responses.
21318 #
21319 # Operations can be global, regional or zonal.
21320 #
21321 # - For global operations, use the `globalOperations`
21322 # resource.
21323 # - For regional operations, use the
21324 # `regionOperations` resource.
21325 # - For zonal operations, use
21326 # the `zoneOperations` resource.
21327 #
21328 #
21329 #
21330 # For more information, read
21331 # Global, Regional, and Zonal Resources.
21332 #
21333 # Note that completed Operation resources have a limited
21334 # retention period.
21335 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
21336 # Not present otherwise.
21337 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
21338 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
21339 # set when the operation is created.
21340 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
21341 # text format.
21342 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
21343 # this field will be populated.
21344 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
21345 # operation.
21346 {
21347 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
21348 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
21349 # details. There is a set of defined message types to use for providing
21350 # details.The syntax depends on the error code. For example,
21351 # QuotaExceededInfo will have details when the error code is
21352 # QUOTA_EXCEEDED.
21353 {
21354 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
21355 #
21356 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
21357 # is not enabled:
21358 #
21359 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
21360 # &quot;domain&quot;: &quot;googleapis.com&quot;
21361 # &quot;metadata&quot;: {
21362 # &quot;resource&quot;: &quot;projects/123&quot;,
21363 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
21364 # }
21365 # }
21366 #
21367 # This response indicates that the pubsub.googleapis.com API is not enabled.
21368 #
21369 # Example of an error that is returned when attempting to create a Spanner
21370 # instance in a region that is out of stock:
21371 #
21372 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
21373 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
21374 # &quot;metadata&quot;: {
21375 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
21376 # }
21377 # }
21378 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
21379 # is typically the registered service name of the tool or product that
21380 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
21381 # generated by some common infrastructure, the error domain must be a
21382 # globally unique value that identifies the infrastructure. For Google API
21383 # infrastructure, the error domain is &quot;googleapis.com&quot;.
21384 &quot;metadatas&quot;: { # Additional structured details about this error.
21385 #
21386 # Keys must match a regular expression of `a-z+` but should
21387 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
21388 # length. When identifying the current value of an exceeded limit, the units
21389 # should be contained in the key, not the value. For example, rather than
21390 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
21391 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
21392 # instances that can be created in a single (batch) request.
21393 &quot;a_key&quot;: &quot;A String&quot;,
21394 },
21395 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
21396 # proximate cause of the error. Error reasons are unique within a particular
21397 # domain of errors. This should be at most 63 characters and match a
21398 # regular expression of `A-Z+[A-Z0-9]`, which represents
21399 # UPPER_SNAKE_CASE.
21400 },
21401 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
21402 #
21403 # For example, if a quota check failed with an error indicating the calling
21404 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
21405 # directly to the right place in the developer console to flip the bit.
21406 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
21407 { # Describes a URL link.
21408 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
21409 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
21410 },
21411 ],
21412 },
21413 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
21414 # which can be attached to an RPC error.
21415 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
21416 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
21417 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
21418 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
21419 },
21420 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
21421 &quot;dimensions&quot;: { # The map holding related quota dimensions.
21422 &quot;a_key&quot;: &quot;A String&quot;,
21423 },
21424 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
21425 # type or metric.
21426 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
21427 # or metric.
21428 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
21429 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
21430 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
21431 },
21432 },
21433 ],
21434 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
21435 # This property is optional.
21436 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
21437 },
21438 ],
21439 },
21440 &quot;getVersionOperationMetadata&quot;: {
21441 &quot;inlineSbomInfo&quot;: {
21442 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
21443 # appropriate identifiers.
21444 &quot;a_key&quot;: &quot;A String&quot;,
21445 },
21446 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
21447 # identifiers.
21448 &quot;a_key&quot;: &quot;A String&quot;,
21449 },
21450 },
21451 },
21452 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
21453 # message that was returned, such as `NOT FOUND`.
21454 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
21455 # status code that was returned. For example, a `404` means the
21456 # resource was not found.
21457 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
21458 # defined by the server.
21459 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
21460 # This value is inRFC3339
21461 # text format.
21462 &quot;instancesBulkInsertOperationMetadata&quot;: {
21463 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
21464 # Example key: zones/us-central1-a
21465 &quot;a_key&quot;: {
21466 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
21467 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
21468 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
21469 # error.
21470 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
21471 # if the flow is rolling forward or rolling back.
21472 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
21473 },
21474 },
21475 },
21476 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
21477 # Operation resources.
21478 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
21479 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
21480 # group of operations results from a `bulkInsert` API request.
21481 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
21482 # `update`, or `delete`, and so on.
21483 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
21484 # There is no requirement that this be linear or support any granularity of
21485 # operations. This should not be used to guess when the operation will be
21486 # complete. This number should monotonically increase as the operation
21487 # progresses.
21488 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
21489 # applicable when performing regional operations.
21490 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
21491 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
21492 # this field will contain information on all underlying zonal actions and
21493 # their state.
21494 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
21495 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
21496 # Example key: zones/us-central1-a
21497 &quot;a_key&quot;: {
21498 &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
21499 # populated.
21500 # different programming environments, including REST APIs and RPC APIs. It is
21501 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
21502 # three pieces of data: error code, error message, and error details.
21503 #
21504 # You can find out more about this error model and how to work with it in the
21505 # [API Design Guide](https://cloud.google.com/apis/design/errors).
21506 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
21507 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
21508 # message types for APIs to use.
21509 {
21510 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
21511 },
21512 ],
21513 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
21514 # user-facing error message should be localized and sent in the
21515 # google.rpc.Status.details field, or localized by the client.
21516 },
21517 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
21518 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
21519 },
21520 },
21521 },
21522 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
21523 # This value is inRFC3339
21524 # text format.
21525 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
21526 # following:
21527 # `PENDING`, `RUNNING`, or `DONE`.
21528 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
21529 # operation.
21530 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
21531 # of the target resource.
21532 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
21533 # operations related to creating a snapshot, this points to the disk
21534 # that the snapshot was created from.
21535 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
21536 # `[email protected]` or
21537 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
21538 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
21539 # operation, this field will be populated.
21540 {
21541 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
21542 # Engine returns NO_RESULTS_ON_PAGE if there
21543 # are no results in the response.
21544 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
21545 # value format. For example:
21546 #
21547 # &quot;data&quot;: [
21548 # {
21549 # &quot;key&quot;: &quot;scope&quot;,
21550 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
21551 # }
21552 {
21553 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
21554 # returned. For example, for warnings where there are no results in a list
21555 # request for a particular zone, this key might be scope and
21556 # the key value might be the zone name. Other examples might be a key
21557 # indicating a deprecated resource and a suggested replacement, or a
21558 # warning about invalid network settings (for example, if an instance
21559 # attempts to perform IP forwarding but is not enabled for IP forwarding).
21560 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
21561 },
21562 ],
21563 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
21564 },
21565 ],
21566 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
21567 # applicable when performing per-zone operations.
21568 }</pre>
21569 </div>
21570
21571 <div class="method">
21572 <code class="details" id="updateNetworkInterface">updateNetworkInterface(project, zone, instance, networkInterface, body=None, requestId=None, x__xgafv=None)</code>
21573 <pre>Updates an instance&#x27;s network interface. This method can only update an
21574 interface&#x27;s alias IP range and attached network. See Modifying
21575 alias IP ranges for an existing instance for instructions on
21576 changing alias IP ranges. See Migrating
21577 a VM between networks for instructions on migrating an interface.
21578 This method follows PATCH semantics.
21579
21580 Args:
21581 project: string, Project ID for this request. (required)
21582 zone: string, The name of the zone for this request. (required)
21583 instance: string, The instance name for this request. (required)
21584 networkInterface: string, The name of the network interface to update. (required)
21585 body: object, The request body.
21586 The object takes the form of:
21587
21588 { # A network interface resource attached to an instance.
21589 &quot;accessConfigs&quot;: [ # An array of configurations for this interface. Currently, only one access
21590 # config, ONE_TO_ONE_NAT, is supported. If there are noaccessConfigs specified, then this instance will have
21591 # no external internet access.
21592 { # An access configuration attached to an instance&#x27;s network interface.
21593 # Only one access config per instance is supported.
21594 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
21595 # The first IPv6 address of the external IPv6 range associated
21596 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
21597 # use a static external IP address, it must be unused and in the same region
21598 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
21599 # assign an external IPv6 address from the instance&#x27;s subnetwork.
21600 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
21601 # external IPv6 range.
21602 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
21603 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
21604 # (IPv4), the default and recommended name is External NAT, but
21605 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
21606 # recommend name is External IPv6.
21607 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
21608 # address associated with this instance. Specify an unused static
21609 # external IP address available to the project or leave this field undefined
21610 # to use an IP from a shared ephemeral IP address pool. If you specify a
21611 # static external IP address, it must live in the same region as the zone of
21612 # the instance.
21613 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
21614 # configuration and can only take the following values: PREMIUM,STANDARD.
21615 #
21616 # If an AccessConfig is specified without a valid external IP address, an
21617 # ephemeral IP will be created with this networkTier.
21618 #
21619 # If an AccessConfig with a valid external IP address is specified, it must
21620 # match that of the networkTier associated with the Address resource owning
21621 # that IP.
21622 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
21623 #
21624 # 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
21625 # first IP in associated external IPv6 range.
21626 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
21627 # config.
21628 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
21629 # external IP address of the instance to a DNS domain name.
21630 #
21631 # This field is not used in ipv6AccessConfig. A default PTR
21632 # record will be created if the VM has external IPv6 range associated.
21633 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
21634 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
21635 },
21636 ],
21637 &quot;aliasIpRanges&quot;: [ # An array of alias IP ranges for this network interface.
21638 # You can only specify this field for network interfaces in VPC networks.
21639 { # An alias IP range attached to an instance&#x27;s network interface.
21640 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
21641 # must belong to the specified subnetwork and cannot contain IP addresses
21642 # reserved by system or used by other network interfaces. This range may be
21643 # 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).
21644 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
21645 # alias range. If not specified, the primary range of the subnetwork is used.
21646 },
21647 ],
21648 &quot;aliasIpv6Ranges&quot;: [ # An array of alias IPv6 ranges for this network interface.
21649 # You can only specify this field for network interfaces in VPC networks.
21650 { # An alias IP range attached to an instance&#x27;s network interface.
21651 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
21652 # must belong to the specified subnetwork and cannot contain IP addresses
21653 # reserved by system or used by other network interfaces. This range may be
21654 # 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).
21655 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
21656 # alias range. If not specified, the primary range of the subnetwork is used.
21657 },
21658 ],
21659 &quot;enableVpcScopedDns&quot;: True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
21660 # with network_attachment.
21661 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint hash of contents stored in this network interface.
21662 # This field will be ignored when inserting an Instance or
21663 # adding a NetworkInterface. An up-to-date
21664 # 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.
21665 &quot;igmpQuery&quot;: &quot;A String&quot;, # Indicate whether igmp query is enabled on the network interface
21666 # or not. If enabled, also indicates the version of IGMP supported.
21667 &quot;internalIpv6PrefixLength&quot;: 42, # The prefix length of the primary internal IPv6 range.
21668 &quot;ipv6AccessConfigs&quot;: [ # An array of IPv6 access configurations for this interface. Currently, only
21669 # one IPv6 access config, DIRECT_IPV6, is supported. If there
21670 # is no ipv6AccessConfig specified, then this instance will
21671 # have no external IPv6 Internet access.
21672 { # An access configuration attached to an instance&#x27;s network interface.
21673 # Only one access config per instance is supported.
21674 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
21675 # The first IPv6 address of the external IPv6 range associated
21676 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
21677 # use a static external IP address, it must be unused and in the same region
21678 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
21679 # assign an external IPv6 address from the instance&#x27;s subnetwork.
21680 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
21681 # external IPv6 range.
21682 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
21683 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
21684 # (IPv4), the default and recommended name is External NAT, but
21685 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
21686 # recommend name is External IPv6.
21687 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
21688 # address associated with this instance. Specify an unused static
21689 # external IP address available to the project or leave this field undefined
21690 # to use an IP from a shared ephemeral IP address pool. If you specify a
21691 # static external IP address, it must live in the same region as the zone of
21692 # the instance.
21693 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
21694 # configuration and can only take the following values: PREMIUM,STANDARD.
21695 #
21696 # If an AccessConfig is specified without a valid external IP address, an
21697 # ephemeral IP will be created with this networkTier.
21698 #
21699 # If an AccessConfig with a valid external IP address is specified, it must
21700 # match that of the networkTier associated with the Address resource owning
21701 # that IP.
21702 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
21703 #
21704 # 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
21705 # first IP in associated external IPv6 range.
21706 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
21707 # config.
21708 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
21709 # external IP address of the instance to a DNS domain name.
21710 #
21711 # This field is not used in ipv6AccessConfig. A default PTR
21712 # record will be created if the VM has external IPv6 range associated.
21713 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
21714 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
21715 },
21716 ],
21717 &quot;ipv6AccessType&quot;: &quot;A String&quot;, # Output only. [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be
21718 # accessed from the Internet. This field is always inherited from its
21719 # subnetwork.
21720 #
21721 # Valid only if stackType is IPV4_IPV6.
21722 &quot;ipv6Address&quot;: &quot;A String&quot;, # An IPv6 internal network address for this network interface. To
21723 # use a static internal IP address, it must be unused and in the same region
21724 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
21725 # assign an internal IPv6 address from the instance&#x27;s subnetwork.
21726 &quot;kind&quot;: &quot;compute#networkInterface&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#networkInterface for network interfaces.
21727 &quot;name&quot;: &quot;A String&quot;, # [Output Only] The name of the network interface, which is generated by the
21728 # server. For a VM, the network interface uses the nicN naming
21729 # format. Where N is a value between 0 and7. The default interface value is nic0.
21730 &quot;network&quot;: &quot;A String&quot;, # URL of the VPC network resource for this instance. When creating an
21731 # instance, if neither the network nor the subnetwork is specified, the
21732 # default network global/networks/default is used. If the
21733 # selected project doesn&#x27;t have the default network, you must specify a
21734 # network or subnet. If the network is not specified but the subnetwork is
21735 # specified, the network is inferred.
21736 #
21737 # If you specify this property, you can specify the network as
21738 # a full or partial URL. For example, the following are all valid URLs:
21739 #
21740 #
21741 # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
21742 # - projects/project/global/networks/network
21743 # - global/networks/default
21744 &quot;networkAttachment&quot;: &quot;A String&quot;, # The URL of the network attachment that this interface should connect
21745 # to in the following format:
21746 # projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.
21747 &quot;networkIP&quot;: &quot;A String&quot;, # An IPv4 internal IP address to assign to the instance for this network
21748 # interface. If not specified by the user, an unused internal IP is
21749 # assigned by the system.
21750 &quot;nicType&quot;: &quot;A String&quot;, # The type of vNIC to be used on this interface. This may be gVNIC or
21751 # VirtioNet.
21752 &quot;parentNicName&quot;: &quot;A String&quot;, # Name of the parent network interface of a dynamic network interface.
21753 &quot;queueCount&quot;: 42, # The networking queue count that&#x27;s specified by users for the network
21754 # interface. Both Rx and Tx queues will be set to this number. It&#x27;ll be empty
21755 # if not specified by the users.
21756 &quot;serviceClassId&quot;: &quot;A String&quot;, # Optional. Producer Service&#x27;s Service class Id for the region of this network
21757 # interface. Can only be used with network_attachment. It is not possible to
21758 # use on its own however, network_attachment can be used without
21759 # service_class_id.
21760 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for this network interface. To assign only IPv4 addresses,
21761 # use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, useIPV4_IPV6. If not specified, IPV4_ONLY is used.
21762 #
21763 # This field can be both set at instance creation and update network
21764 # interface operations.
21765 &quot;subnetwork&quot;: &quot;A String&quot;, # The URL of the Subnetwork resource for this instance. If the network
21766 # resource is inlegacy
21767 # mode, do not specify this field. If the network is in auto subnet
21768 # mode, specifying the subnetwork is optional. If the network is in custom
21769 # subnet mode, specifying the subnetwork is required. If you specify this
21770 # field, you can specify the subnetwork as a full or partial URL. For
21771 # example, the following are all valid URLs:
21772 #
21773 #
21774 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
21775 # - regions/region/subnetworks/subnetwork
21776 &quot;vlan&quot;: 42, # VLAN tag of a dynamic network interface, must be an integer in the range
21777 # from 2 to 255 inclusively.
21778 }
21779
21780 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
21781 that if you must retry your request, the server will know to ignore the
21782 request if it has already been completed.
21783
21784 For example, consider a situation where you make an initial request and
21785 the request times out. If you make the request again with the same
21786 request ID, the server can check if original operation with the same
21787 request ID was received, and if so, will ignore the second request. This
21788 prevents clients from accidentally creating duplicate commitments.
21789
21790 The request ID must be
21791 a valid UUID with the exception that zero UUID is not supported
21792 (00000000-0000-0000-0000-000000000000).
21793 x__xgafv: string, V1 error format.
21794 Allowed values
21795 1 - v1 error format
21796 2 - v2 error format
21797
21798 Returns:
21799 An object of the form:
21800
21801 { # Represents an Operation resource.
21802 #
21803 # Google Compute Engine has three Operation resources:
21804 #
21805 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
21806 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
21807 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
21808 #
21809 # You can use an operation resource to manage asynchronous API requests.
21810 # For more information, readHandling
21811 # API responses.
21812 #
21813 # Operations can be global, regional or zonal.
21814 #
21815 # - For global operations, use the `globalOperations`
21816 # resource.
21817 # - For regional operations, use the
21818 # `regionOperations` resource.
21819 # - For zonal operations, use
21820 # the `zoneOperations` resource.
21821 #
21822 #
21823 #
21824 # For more information, read
21825 # Global, Regional, and Zonal Resources.
21826 #
21827 # Note that completed Operation resources have a limited
21828 # retention period.
21829 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
21830 # Not present otherwise.
21831 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
21832 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
21833 # set when the operation is created.
21834 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
21835 # text format.
21836 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
21837 # this field will be populated.
21838 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
21839 # operation.
21840 {
21841 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
21842 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
21843 # details. There is a set of defined message types to use for providing
21844 # details.The syntax depends on the error code. For example,
21845 # QuotaExceededInfo will have details when the error code is
21846 # QUOTA_EXCEEDED.
21847 {
21848 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
21849 #
21850 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
21851 # is not enabled:
21852 #
21853 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
21854 # &quot;domain&quot;: &quot;googleapis.com&quot;
21855 # &quot;metadata&quot;: {
21856 # &quot;resource&quot;: &quot;projects/123&quot;,
21857 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
21858 # }
21859 # }
21860 #
21861 # This response indicates that the pubsub.googleapis.com API is not enabled.
21862 #
21863 # Example of an error that is returned when attempting to create a Spanner
21864 # instance in a region that is out of stock:
21865 #
21866 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
21867 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
21868 # &quot;metadata&quot;: {
21869 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
21870 # }
21871 # }
21872 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
21873 # is typically the registered service name of the tool or product that
21874 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
21875 # generated by some common infrastructure, the error domain must be a
21876 # globally unique value that identifies the infrastructure. For Google API
21877 # infrastructure, the error domain is &quot;googleapis.com&quot;.
21878 &quot;metadatas&quot;: { # Additional structured details about this error.
21879 #
21880 # Keys must match a regular expression of `a-z+` but should
21881 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
21882 # length. When identifying the current value of an exceeded limit, the units
21883 # should be contained in the key, not the value. For example, rather than
21884 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
21885 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
21886 # instances that can be created in a single (batch) request.
21887 &quot;a_key&quot;: &quot;A String&quot;,
21888 },
21889 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
21890 # proximate cause of the error. Error reasons are unique within a particular
21891 # domain of errors. This should be at most 63 characters and match a
21892 # regular expression of `A-Z+[A-Z0-9]`, which represents
21893 # UPPER_SNAKE_CASE.
21894 },
21895 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
21896 #
21897 # For example, if a quota check failed with an error indicating the calling
21898 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
21899 # directly to the right place in the developer console to flip the bit.
21900 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
21901 { # Describes a URL link.
21902 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
21903 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
21904 },
21905 ],
21906 },
21907 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
21908 # which can be attached to an RPC error.
21909 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
21910 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
21911 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
21912 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
21913 },
21914 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
21915 &quot;dimensions&quot;: { # The map holding related quota dimensions.
21916 &quot;a_key&quot;: &quot;A String&quot;,
21917 },
21918 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
21919 # type or metric.
21920 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
21921 # or metric.
21922 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
21923 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
21924 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
21925 },
21926 },
21927 ],
21928 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
21929 # This property is optional.
21930 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
21931 },
21932 ],
21933 },
21934 &quot;getVersionOperationMetadata&quot;: {
21935 &quot;inlineSbomInfo&quot;: {
21936 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
21937 # appropriate identifiers.
21938 &quot;a_key&quot;: &quot;A String&quot;,
21939 },
21940 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
21941 # identifiers.
21942 &quot;a_key&quot;: &quot;A String&quot;,
21943 },
21944 },
21945 },
21946 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
21947 # message that was returned, such as `NOT FOUND`.
21948 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
21949 # status code that was returned. For example, a `404` means the
21950 # resource was not found.
21951 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
21952 # defined by the server.
21953 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
21954 # This value is inRFC3339
21955 # text format.
21956 &quot;instancesBulkInsertOperationMetadata&quot;: {
21957 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
21958 # Example key: zones/us-central1-a
21959 &quot;a_key&quot;: {
21960 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
21961 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
21962 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
21963 # error.
21964 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
21965 # if the flow is rolling forward or rolling back.
21966 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
21967 },
21968 },
21969 },
21970 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
21971 # Operation resources.
21972 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
21973 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
21974 # group of operations results from a `bulkInsert` API request.
21975 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
21976 # `update`, or `delete`, and so on.
21977 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
21978 # There is no requirement that this be linear or support any granularity of
21979 # operations. This should not be used to guess when the operation will be
21980 # complete. This number should monotonically increase as the operation
21981 # progresses.
21982 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
21983 # applicable when performing regional operations.
21984 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
21985 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
21986 # this field will contain information on all underlying zonal actions and
21987 # their state.
21988 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
21989 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
21990 # Example key: zones/us-central1-a
21991 &quot;a_key&quot;: {
21992 &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
21993 # populated.
21994 # different programming environments, including REST APIs and RPC APIs. It is
21995 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
21996 # three pieces of data: error code, error message, and error details.
21997 #
21998 # You can find out more about this error model and how to work with it in the
21999 # [API Design Guide](https://cloud.google.com/apis/design/errors).
22000 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
22001 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
22002 # message types for APIs to use.
22003 {
22004 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
22005 },
22006 ],
22007 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
22008 # user-facing error message should be localized and sent in the
22009 # google.rpc.Status.details field, or localized by the client.
22010 },
22011 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
22012 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
22013 },
22014 },
22015 },
22016 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
22017 # This value is inRFC3339
22018 # text format.
22019 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
22020 # following:
22021 # `PENDING`, `RUNNING`, or `DONE`.
22022 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
22023 # operation.
22024 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
22025 # of the target resource.
22026 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
22027 # operations related to creating a snapshot, this points to the disk
22028 # that the snapshot was created from.
22029 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
22030 # `[email protected]` or
22031 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
22032 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
22033 # operation, this field will be populated.
22034 {
22035 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
22036 # Engine returns NO_RESULTS_ON_PAGE if there
22037 # are no results in the response.
22038 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
22039 # value format. For example:
22040 #
22041 # &quot;data&quot;: [
22042 # {
22043 # &quot;key&quot;: &quot;scope&quot;,
22044 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
22045 # }
22046 {
22047 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
22048 # returned. For example, for warnings where there are no results in a list
22049 # request for a particular zone, this key might be scope and
22050 # the key value might be the zone name. Other examples might be a key
22051 # indicating a deprecated resource and a suggested replacement, or a
22052 # warning about invalid network settings (for example, if an instance
22053 # attempts to perform IP forwarding but is not enabled for IP forwarding).
22054 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
22055 },
22056 ],
22057 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
22058 },
22059 ],
22060 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
22061 # applicable when performing per-zone operations.
22062 }</pre>
22063 </div>
22064
22065 <div class="method">
22066 <code class="details" id="updateShieldedInstanceConfig">updateShieldedInstanceConfig(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>
22067 <pre>Updates the Shielded Instance config for an instance. You can
22068 only use this method on a stopped instance. This method supportsPATCH
22069 semantics and uses theJSON merge
22070 patch format and processing rules.
22071
22072 Args:
22073 project: string, Project ID for this request. (required)
22074 zone: string, The name of the zone for this request. (required)
22075 instance: string, Name or id of the instance scoping this request. (required)
22076 body: object, The request body.
22077 The object takes the form of:
22078
22079 { # A set of Shielded Instance options.
22080 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.Enabled by
22081 # default.
22082 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.Disabled by
22083 # default.
22084 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.Enabled by
22085 # default.
22086 }
22087
22088 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
22089 that if you must retry your request, the server will know to ignore the
22090 request if it has already been completed.
22091
22092 For example, consider a situation where you make an initial request and
22093 the request times out. If you make the request again with the same
22094 request ID, the server can check if original operation with the same
22095 request ID was received, and if so, will ignore the second request. This
22096 prevents clients from accidentally creating duplicate commitments.
22097
22098 The request ID must be
22099 a valid UUID with the exception that zero UUID is not supported
22100 (00000000-0000-0000-0000-000000000000).
22101 x__xgafv: string, V1 error format.
22102 Allowed values
22103 1 - v1 error format
22104 2 - v2 error format
22105
22106 Returns:
22107 An object of the form:
22108
22109 { # Represents an Operation resource.
22110 #
22111 # Google Compute Engine has three Operation resources:
22112 #
22113 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
22114 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
22115 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
22116 #
22117 # You can use an operation resource to manage asynchronous API requests.
22118 # For more information, readHandling
22119 # API responses.
22120 #
22121 # Operations can be global, regional or zonal.
22122 #
22123 # - For global operations, use the `globalOperations`
22124 # resource.
22125 # - For regional operations, use the
22126 # `regionOperations` resource.
22127 # - For zonal operations, use
22128 # the `zoneOperations` resource.
22129 #
22130 #
22131 #
22132 # For more information, read
22133 # Global, Regional, and Zonal Resources.
22134 #
22135 # Note that completed Operation resources have a limited
22136 # retention period.
22137 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
22138 # Not present otherwise.
22139 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
22140 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
22141 # set when the operation is created.
22142 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
22143 # text format.
22144 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
22145 # this field will be populated.
22146 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
22147 # operation.
22148 {
22149 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
22150 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
22151 # details. There is a set of defined message types to use for providing
22152 # details.The syntax depends on the error code. For example,
22153 # QuotaExceededInfo will have details when the error code is
22154 # QUOTA_EXCEEDED.
22155 {
22156 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
22157 #
22158 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
22159 # is not enabled:
22160 #
22161 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
22162 # &quot;domain&quot;: &quot;googleapis.com&quot;
22163 # &quot;metadata&quot;: {
22164 # &quot;resource&quot;: &quot;projects/123&quot;,
22165 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
22166 # }
22167 # }
22168 #
22169 # This response indicates that the pubsub.googleapis.com API is not enabled.
22170 #
22171 # Example of an error that is returned when attempting to create a Spanner
22172 # instance in a region that is out of stock:
22173 #
22174 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
22175 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
22176 # &quot;metadata&quot;: {
22177 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
22178 # }
22179 # }
22180 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
22181 # is typically the registered service name of the tool or product that
22182 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
22183 # generated by some common infrastructure, the error domain must be a
22184 # globally unique value that identifies the infrastructure. For Google API
22185 # infrastructure, the error domain is &quot;googleapis.com&quot;.
22186 &quot;metadatas&quot;: { # Additional structured details about this error.
22187 #
22188 # Keys must match a regular expression of `a-z+` but should
22189 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
22190 # length. When identifying the current value of an exceeded limit, the units
22191 # should be contained in the key, not the value. For example, rather than
22192 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
22193 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
22194 # instances that can be created in a single (batch) request.
22195 &quot;a_key&quot;: &quot;A String&quot;,
22196 },
22197 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
22198 # proximate cause of the error. Error reasons are unique within a particular
22199 # domain of errors. This should be at most 63 characters and match a
22200 # regular expression of `A-Z+[A-Z0-9]`, which represents
22201 # UPPER_SNAKE_CASE.
22202 },
22203 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
22204 #
22205 # For example, if a quota check failed with an error indicating the calling
22206 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
22207 # directly to the right place in the developer console to flip the bit.
22208 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
22209 { # Describes a URL link.
22210 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
22211 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
22212 },
22213 ],
22214 },
22215 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
22216 # which can be attached to an RPC error.
22217 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
22218 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
22219 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
22220 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
22221 },
22222 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
22223 &quot;dimensions&quot;: { # The map holding related quota dimensions.
22224 &quot;a_key&quot;: &quot;A String&quot;,
22225 },
22226 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
22227 # type or metric.
22228 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
22229 # or metric.
22230 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
22231 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
22232 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
22233 },
22234 },
22235 ],
22236 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
22237 # This property is optional.
22238 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
22239 },
22240 ],
22241 },
22242 &quot;getVersionOperationMetadata&quot;: {
22243 &quot;inlineSbomInfo&quot;: {
22244 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
22245 # appropriate identifiers.
22246 &quot;a_key&quot;: &quot;A String&quot;,
22247 },
22248 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
22249 # identifiers.
22250 &quot;a_key&quot;: &quot;A String&quot;,
22251 },
22252 },
22253 },
22254 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
22255 # message that was returned, such as `NOT FOUND`.
22256 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
22257 # status code that was returned. For example, a `404` means the
22258 # resource was not found.
22259 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
22260 # defined by the server.
22261 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
22262 # This value is inRFC3339
22263 # text format.
22264 &quot;instancesBulkInsertOperationMetadata&quot;: {
22265 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
22266 # Example key: zones/us-central1-a
22267 &quot;a_key&quot;: {
22268 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
22269 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
22270 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
22271 # error.
22272 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
22273 # if the flow is rolling forward or rolling back.
22274 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
22275 },
22276 },
22277 },
22278 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
22279 # Operation resources.
22280 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
22281 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
22282 # group of operations results from a `bulkInsert` API request.
22283 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
22284 # `update`, or `delete`, and so on.
22285 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
22286 # There is no requirement that this be linear or support any granularity of
22287 # operations. This should not be used to guess when the operation will be
22288 # complete. This number should monotonically increase as the operation
22289 # progresses.
22290 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
22291 # applicable when performing regional operations.
22292 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
22293 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
22294 # this field will contain information on all underlying zonal actions and
22295 # their state.
22296 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
22297 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
22298 # Example key: zones/us-central1-a
22299 &quot;a_key&quot;: {
22300 &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
22301 # populated.
22302 # different programming environments, including REST APIs and RPC APIs. It is
22303 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
22304 # three pieces of data: error code, error message, and error details.
22305 #
22306 # You can find out more about this error model and how to work with it in the
22307 # [API Design Guide](https://cloud.google.com/apis/design/errors).
22308 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
22309 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
22310 # message types for APIs to use.
22311 {
22312 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
22313 },
22314 ],
22315 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
22316 # user-facing error message should be localized and sent in the
22317 # google.rpc.Status.details field, or localized by the client.
22318 },
22319 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
22320 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
22321 },
22322 },
22323 },
22324 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
22325 # This value is inRFC3339
22326 # text format.
22327 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
22328 # following:
22329 # `PENDING`, `RUNNING`, or `DONE`.
22330 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
22331 # operation.
22332 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
22333 # of the target resource.
22334 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
22335 # operations related to creating a snapshot, this points to the disk
22336 # that the snapshot was created from.
22337 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
22338 # `[email protected]` or
22339 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
22340 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
22341 # operation, this field will be populated.
22342 {
22343 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
22344 # Engine returns NO_RESULTS_ON_PAGE if there
22345 # are no results in the response.
22346 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
22347 # value format. For example:
22348 #
22349 # &quot;data&quot;: [
22350 # {
22351 # &quot;key&quot;: &quot;scope&quot;,
22352 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
22353 # }
22354 {
22355 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
22356 # returned. For example, for warnings where there are no results in a list
22357 # request for a particular zone, this key might be scope and
22358 # the key value might be the zone name. Other examples might be a key
22359 # indicating a deprecated resource and a suggested replacement, or a
22360 # warning about invalid network settings (for example, if an instance
22361 # attempts to perform IP forwarding but is not enabled for IP forwarding).
22362 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
22363 },
22364 ],
22365 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
22366 },
22367 ],
22368 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
22369 # applicable when performing per-zone operations.
22370 }</pre>
22371 </div>
22372
22373 </body></html>