Debian Codegraph @

docs/dyn/compute_alpha.regionInstances.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.regionInstances.html">regionInstances</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#bulkInsert">bulkInsert(project, region, body=None, requestId=None, x__xgafv=None)</a></code></p>
79 <p class="firstline">Creates multiple instances in a given region. Count specifies the number of</p>
80 <p class="toc_element">
81 <code><a href="#close">close()</a></code></p>
82 <p class="firstline">Close httplib2 connections.</p>
83 <h3>Method Details</h3>
84 <div class="method">
85 <code class="details" id="bulkInsert">bulkInsert(project, region, body=None, requestId=None, x__xgafv=None)</code>
86 <pre>Creates multiple instances in a given region. Count specifies the number of
87 instances to create.
88
89 Args:
90 project: string, Project ID for this request. (required)
91 region: string, The name of the region for this request. (required)
92 body: object, The request body.
93 The object takes the form of:
94
95 { # A transient resource used in compute.instances.bulkInsert and
96 # compute.regionInstances.bulkInsert . This resource is not persisted
97 # anywhere, it is used only for processing the requests.
98 &quot;count&quot;: &quot;A String&quot;, # The maximum number of instances to create.
99 &quot;instanceFlexibilityPolicy&quot;: { # A flexible specification of machine types for instances to create. # A flexible specification of machine type of instances to create.
100 &quot;instanceSelections&quot;: { # Specification of alternative, flexible instance subsets.
101 # One of them will be selected to create the instances
102 # based on various criteria, like:
103 # - ranks,
104 # - location policy,
105 # - current capacity,
106 # - available reservations (you can specify affinity in
107 # InstanceProperties),
108 # - SWAN/GOOSE limitations.
109 # Key is an arbitrary, unique RFC1035 string that identifies the instance
110 # selection.
111 &quot;a_key&quot;: { # Specification of machine type to use. Every position inside this message
112 # is an alternative.
113 # The count specified in the shape flexibility must not exceed the number
114 # of entries in per_instance_properties or the capacity of the
115 # name_pattern, if used.
116 &quot;disks&quot;: [ # Disks to be attached to the instances created from in this selection.
117 # They override the disks specified in the instance properties.
118 { # An instance-attached disk resource.
119 &quot;architecture&quot;: &quot;A String&quot;, # Output only. [Output Only] The architecture of the attached disk. Valid values are ARM64
120 # or X86_64.
121 &quot;autoDelete&quot;: True or False, # Specifies whether the disk will be auto-deleted when the instance is
122 # deleted (but not when the disk is detached from the instance).
123 &quot;boot&quot;: True or False, # Indicates that this is a boot disk. The virtual machine will use the first
124 # partition of the disk for its root filesystem.
125 &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
126 # running within the instance. This name can be used to reference the device
127 # for mounting, resizing, and so on, from within the instance.
128 #
129 # If not specified, the server chooses a default device name to apply to this
130 # disk, in the form persistent-disk-x, where x is a number
131 # assigned by Google Compute Engine. This field is only applicable for
132 # persistent disks.
133 &quot;diskEncryptionKey&quot;: { # Encrypts or decrypts a disk using acustomer-supplied
134 # encryption key.
135 #
136 # If you are creating a new disk, this field encrypts the new disk using
137 # an encryption key that you provide. If you are attaching an existing
138 # disk that is already encrypted, this field decrypts the disk using
139 # the customer-supplied encryption key.
140 #
141 # If you encrypt a disk using a customer-supplied key, you must provide the
142 # same key again when you attempt to use this resource at a later time. For
143 # example, you must provide the key when you create a snapshot or an image
144 # from the disk or when you attach the disk to a virtual machine instance.
145 #
146 # If you do not provide an encryption key, then the disk will be encrypted
147 # using an automatically generated key and you do not need to provide a key
148 # to use the disk later.
149 #
150 # Note:
151 #
152 # Instance templates do not storecustomer-supplied
153 # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
154 #
155 # You cannot create VMs that have disks with customer-supplied keys using
156 # the bulk
157 # insert method.
158 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
159 # For example:
160 #
161 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
162 # key_region/cryptoKeys/key
163 #
164 # The fully-qualifed key name may be returned for resource GET requests. For
165 # example:
166 #
167 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
168 # key_region/cryptoKeys/key
169 # /cryptoKeyVersions/1
170 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
171 # key. If absent, the Compute Engine default service account is used.
172 # For example:
173 #
174 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
175 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
176 # encryption key, encoded in RFC
177 # 4648 base64 to either encrypt or decrypt this resource. You can
178 # provide either the rawKey or thersaEncryptedKey.
179 # For example:
180 #
181 # &quot;rawKey&quot;:
182 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
183 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
184 # customer-supplied encryption key to either encrypt or decrypt this
185 # resource. You can provide either the rawKey or thersaEncryptedKey.
186 # For example:
187 #
188 # &quot;rsaEncryptedKey&quot;:
189 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
190 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
191 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
192 #
193 # The key must meet the following requirements before you can provide it to
194 # Compute Engine:
195 #
196 # 1. The key is wrapped using a RSA public key certificate provided by
197 # Google.
198 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
199 # encoding.
200 #
201 # Gets the RSA public key certificate provided by Google at:
202 #
203 #
204 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
205 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
206 # 4648 base64 encoded SHA-256 hash of the customer-supplied
207 # encryption key that protects this resource.
208 },
209 &quot;diskSizeGb&quot;: &quot;A String&quot;, # The size of the disk in GB.
210 &quot;forceAttach&quot;: True or False, # [Input Only] Whether to force attach the regional disk even if it&#x27;s
211 # currently attached to another instance. If you try to force attach a zonal
212 # disk to an instance, you will receive an error.
213 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
214 # only for bootable images. Read
215 # Enabling guest operating system features to see a list of available
216 # options.
217 { # Guest OS features.
218 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
219 # separate values. Set to one or more of the following values:
220 #
221 # - VIRTIO_SCSI_MULTIQUEUE
222 # - WINDOWS
223 # - MULTI_IP_SUBNET
224 # - UEFI_COMPATIBLE
225 # - GVNIC
226 # - SEV_CAPABLE
227 # - SUSPEND_RESUME_COMPATIBLE
228 # - SEV_LIVE_MIGRATABLE_V2
229 # - SEV_SNP_CAPABLE
230 # - TDX_CAPABLE
231 # - IDPF
232 # - SNP_SVSM_CAPABLE
233 # - CCA_CAPABLE
234 #
235 #
236 # For more information, see
237 # Enabling guest operating system features.
238 },
239 ],
240 &quot;index&quot;: 42, # Output only. [Output Only] A zero-based index to this disk, where 0 is reserved for the
241 # boot disk. If you have many disks attached to an instance, each
242 # disk would have a unique index number.
243 &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
244 # alongside the new instance. Use initialization parameters to create boot
245 # disks or local SSDs attached to the new instance.
246 #
247 # This property is mutually exclusive with the source property;
248 # you can only define one or the other, but not both.
249 # alongside the new instance. Use initialization parameters to create boot
250 # disks or local SSDs attached to the new instance.
251 #
252 # This field is persisted and returned for instanceTemplate and not returned
253 # in the context of instance.
254 #
255 # This property is mutually exclusive with the source property;
256 # you can only define one or the other, but not both.
257 &quot;architecture&quot;: &quot;A String&quot;, # The architecture of the attached disk. Valid values are
258 # arm64 or x86_64.
259 &quot;description&quot;: &quot;A String&quot;, # An optional description. Provide this property when creating the disk.
260 &quot;diskName&quot;: &quot;A String&quot;, # Specifies the disk name. If not specified, the default is to use the name
261 # of the instance. If a disk with the same name already exists in the given
262 # region, the existing disk is attached to the new instance and the
263 # new disk is not created.
264 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB. The size must be at least
265 # 10 GB. If you specify a sourceImage, which is required for
266 # boot disks, the default size is the size of the sourceImage.
267 # If you do not specify a sourceImage, the default disk size
268 # is 500 GB.
269 &quot;diskType&quot;: &quot;A String&quot;,
270 &quot;enableConfidentialCompute&quot;: True or False, # Whether this disk is using confidential compute mode.
271 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
272 # only for bootable images. Read
273 # Enabling guest operating system features to see a list of available
274 # options.
275 #
276 # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
277 { # Guest OS features.
278 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
279 # separate values. Set to one or more of the following values:
280 #
281 # - VIRTIO_SCSI_MULTIQUEUE
282 # - WINDOWS
283 # - MULTI_IP_SUBNET
284 # - UEFI_COMPATIBLE
285 # - GVNIC
286 # - SEV_CAPABLE
287 # - SUSPEND_RESUME_COMPATIBLE
288 # - SEV_LIVE_MIGRATABLE_V2
289 # - SEV_SNP_CAPABLE
290 # - TDX_CAPABLE
291 # - IDPF
292 # - SNP_SVSM_CAPABLE
293 # - CCA_CAPABLE
294 #
295 #
296 # For more information, see
297 # Enabling guest operating system features.
298 },
299 ],
300 &quot;interface&quot;: &quot;A String&quot;, # [Deprecated] Specifies the disk interface to use for attaching this disk,
301 # which is either SCSI or NVME. The default isSCSI.
302 &quot;labels&quot;: { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
303 # persistent disks.
304 &quot;a_key&quot;: &quot;A String&quot;,
305 },
306 &quot;licenseCodes&quot;: [ # Integer license codes indicating which licenses are attached to this
307 # disk.
308 &quot;A String&quot;,
309 ],
310 &quot;licenses&quot;: [ # A list of publicly visible licenses. Reserved for Google&#x27;s use.
311 &quot;A String&quot;,
312 ],
313 &quot;multiWriter&quot;: True or False, # Indicates whether or not the disk can be read/write attached to
314 # more than one instance.
315 &quot;onUpdateAction&quot;: &quot;A String&quot;, # Specifies which action to take on instance update with this disk. Default
316 # is to use the existing disk.
317 &quot;provisionedIops&quot;: &quot;A String&quot;, # Indicates how many IOPS to provision for the disk. This sets the number
318 # of I/O operations per second that the disk can handle. Values must be
319 # between 10,000 and 120,000. For more details, see theExtreme persistent
320 # disk documentation.
321 &quot;provisionedThroughput&quot;: &quot;A String&quot;, # Indicates how much throughput to provision for the disk. This sets the
322 # number of throughput mb per second that the disk can handle. Values must
323 # greater than or equal to 1.
324 &quot;replicaZones&quot;: [ # Required for each regional disk associated with the instance. Specify
325 # the URLs of the zones where the disk should be replicated to.
326 # You must provide exactly two replica zones, and one zone must be the same
327 # as the instance zone.
328 &quot;A String&quot;,
329 ],
330 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
331 # have the same definition as resource
332 # manager tags. Keys and values can be either in numeric format,
333 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
334 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
335 # `{tag_value_short_name}`. The field is ignored (both PUT &amp; PATCH) when
336 # empty.
337 &quot;a_key&quot;: &quot;A String&quot;,
338 },
339 &quot;resourcePolicies&quot;: [ # Resource policies applied to this disk for automatic snapshot creations.
340 # Specified using the full or partial URL. For instance template, specify
341 # only the resource policy name.
342 &quot;A String&quot;,
343 ],
344 &quot;sourceImage&quot;: &quot;A String&quot;, # The source image to create this disk. When creating a new instance boot
345 # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
346 # is required.
347 #
348 # To create a disk with one of the public operating system
349 # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
350 #
351 # projects/debian-cloud/global/images/family/debian-9
352 #
353 #
354 # Alternatively, use a specific version of a public operating system image:
355 #
356 # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
357 #
358 #
359 # To create a disk with a custom image that you created, specify the
360 # image name in the following format:
361 #
362 # global/images/my-custom-image
363 #
364 #
365 # You can also specify a custom image by its image family, which returns
366 # the latest version of the image in that family. Replace the image name
367 # with family/family-name:
368 #
369 # global/images/family/my-image-family
370 #
371 #
372 # If the source image is deleted later, this field will not be set.
373 &quot;sourceImageEncryptionKey&quot;: { # Thecustomer-supplied
374 # encryption key of the source image. Required if the source image is
375 # protected by a customer-supplied encryption key.
376 #
377 # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
378 # encryption keys, so you cannot create disks for instances in a managed instance group if the
379 # source images are encrypted with your own keys.
380 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
381 # For example:
382 #
383 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
384 # key_region/cryptoKeys/key
385 #
386 # The fully-qualifed key name may be returned for resource GET requests. For
387 # example:
388 #
389 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
390 # key_region/cryptoKeys/key
391 # /cryptoKeyVersions/1
392 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
393 # key. If absent, the Compute Engine default service account is used.
394 # For example:
395 #
396 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
397 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
398 # encryption key, encoded in RFC
399 # 4648 base64 to either encrypt or decrypt this resource. You can
400 # provide either the rawKey or thersaEncryptedKey.
401 # For example:
402 #
403 # &quot;rawKey&quot;:
404 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
405 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
406 # customer-supplied encryption key to either encrypt or decrypt this
407 # resource. You can provide either the rawKey or thersaEncryptedKey.
408 # For example:
409 #
410 # &quot;rsaEncryptedKey&quot;:
411 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
412 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
413 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
414 #
415 # The key must meet the following requirements before you can provide it to
416 # Compute Engine:
417 #
418 # 1. The key is wrapped using a RSA public key certificate provided by
419 # Google.
420 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
421 # encoding.
422 #
423 # Gets the RSA public key certificate provided by Google at:
424 #
425 #
426 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
427 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
428 # 4648 base64 encoded SHA-256 hash of the customer-supplied
429 # encryption key that protects this resource.
430 },
431 &quot;sourceInstantSnapshot&quot;: &quot;A String&quot;, # The source instant-snapshot to create this disk. When creating a new
432 # instance boot disk, one of initializeParams.sourceSnapshot
433 # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
434 # is required.
435 #
436 # To create a disk with a snapshot that you created, specify the
437 # snapshot name in the following format:
438 #
439 # us-central1-a/instantSnapshots/my-backup
440 #
441 #
442 # If the source instant-snapshot is deleted later, this field will not be
443 # set.
444 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # The source snapshot to create this disk. When creating a new instance
445 # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
446 # is required.
447 #
448 # To create a disk with a snapshot that you created, specify the
449 # snapshot name in the following format:
450 #
451 # global/snapshots/my-backup
452 #
453 #
454 # If the source snapshot is deleted later, this field will not be set.
455 #
456 # Note: You cannot create VMs in bulk using a snapshot as the source. Use
457 # an image instead when you create VMs using
458 # the bulk
459 # insert method.
460 &quot;sourceSnapshotEncryptionKey&quot;: { # Thecustomer-supplied
461 # encryption key of the source snapshot.
462 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
463 # For example:
464 #
465 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
466 # key_region/cryptoKeys/key
467 #
468 # The fully-qualifed key name may be returned for resource GET requests. For
469 # example:
470 #
471 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
472 # key_region/cryptoKeys/key
473 # /cryptoKeyVersions/1
474 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
475 # key. If absent, the Compute Engine default service account is used.
476 # For example:
477 #
478 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
479 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
480 # encryption key, encoded in RFC
481 # 4648 base64 to either encrypt or decrypt this resource. You can
482 # provide either the rawKey or thersaEncryptedKey.
483 # For example:
484 #
485 # &quot;rawKey&quot;:
486 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
487 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
488 # customer-supplied encryption key to either encrypt or decrypt this
489 # resource. You can provide either the rawKey or thersaEncryptedKey.
490 # For example:
491 #
492 # &quot;rsaEncryptedKey&quot;:
493 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
494 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
495 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
496 #
497 # The key must meet the following requirements before you can provide it to
498 # Compute Engine:
499 #
500 # 1. The key is wrapped using a RSA public key certificate provided by
501 # Google.
502 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
503 # encoding.
504 #
505 # Gets the RSA public key certificate provided by Google at:
506 #
507 #
508 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
509 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
510 # 4648 base64 encoded SHA-256 hash of the customer-supplied
511 # encryption key that protects this resource.
512 },
513 &quot;storagePool&quot;: &quot;A String&quot;, # The storage pool in which the new disk is created. You can provide
514 # this as a partial or full URL to the resource. For example, the following
515 # are valid values:
516 #
517 #
518 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
519 # - projects/project/zones/zone/storagePools/storagePool
520 # - zones/zone/storagePools/storagePool
521 },
522 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is
523 # either SCSI or NVME. For most machine types, the
524 # default is SCSI. Local SSDs can use either NVME or SCSI.
525 # In certain configurations, persistent disks can use NVMe. For more
526 # information, seeAbout
527 # persistent disks.
528 &quot;kind&quot;: &quot;compute#attachedDisk&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
529 &quot;licenses&quot;: [ # Output only. [Output Only] Any valid publicly visible licenses.
530 &quot;A String&quot;,
531 ],
532 &quot;locked&quot;: True or False, # Output only. [Output Only] Whether to indicate the attached disk is locked. The locked
533 # disk is not allowed to be detached from the instance, or to be used as the
534 # source of the snapshot creation, and the image creation. The instance with
535 # at least one locked attached disk is not allow to be used as source of
536 # machine image creation, instant snapshot creation, and not allowed to be
537 # deleted with --keep-disk parameter set to true for locked disks.
538 &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
539 # in READ_WRITE mode.
540 &quot;savedState&quot;: &quot;A String&quot;, # Output only. For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
541 # field is set to PRESERVED if the LocalSSD data has been saved
542 # to a persistent location by customer request. (see the
543 # discard_local_ssd option on Stop/Suspend).
544 # Read-only in the api.
545 &quot;shieldedInstanceInitialState&quot;: { # Initial State for shielded instance, # Output only. [Output Only] shielded vm initial state stored on disk
546 # these are public keys which are safe to store in public
547 &quot;dbs&quot;: [ # The Key Database (db).
548 {
549 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
550 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
551 },
552 ],
553 &quot;dbxs&quot;: [ # The forbidden key database (dbx).
554 {
555 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
556 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
557 },
558 ],
559 &quot;keks&quot;: [ # The Key Exchange Key (KEK).
560 {
561 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
562 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
563 },
564 ],
565 &quot;pk&quot;: { # The Platform Key (PK).
566 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
567 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
568 },
569 },
570 &quot;source&quot;: &quot;A String&quot;, # Specifies a valid partial or full URL to an existing Persistent Disk
571 # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
572 # is required.
573 #
574 # If desired, you can also attach existing non-root persistent disks using
575 # this property. This field is only applicable for persistent disks.
576 #
577 # Note that for InstanceTemplate, specify the disk name for zonal disk,
578 # and the URL for regional disk.
579 &quot;type&quot;: &quot;A String&quot;, # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
580 },
581 ],
582 &quot;machineTypes&quot;: [ # Alternative machine types to use for instances that are created from
583 # these properties. This field only accepts a machine type names, for
584 # example `n2-standard-4` and not URLs or partial URLs.
585 &quot;A String&quot;,
586 ],
587 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Name of the minimum CPU platform to be used by this instance selection.
588 # e.g. &#x27;Intel Ice Lake&#x27;.
589 &quot;rank&quot;: &quot;A String&quot;, # Rank when prioritizing the shape flexibilities.
590 # The instance selections with rank are considered
591 # first, in the ascending order of the rank.
592 # If not set, defaults to 0.
593 },
594 },
595 },
596 &quot;instanceProperties&quot;: { # The instance properties defining the VM instances to be created. Required
597 # if sourceInstanceTemplate is not provided.
598 &quot;advancedMachineFeatures&quot;: { # Specifies options for controlling advanced machine features. # Controls for advanced machine-related behavior features.
599 # Note that for MachineImage, this is not supported yet.
600 # Options that would traditionally be configured in a BIOS belong
601 # here. Features that require operating system support may have
602 # corresponding entries in the GuestOsFeatures of anImage (e.g., whether or not the OS in theImage supports nested virtualization being enabled or
603 # disabled).
604 &quot;enableNestedVirtualization&quot;: True or False, # Whether to enable nested virtualization or not (default is false).
605 &quot;enableUefiNetworking&quot;: True or False, # Whether to enable UEFI networking for instance creation.
606 &quot;enableWatchdogTimer&quot;: True or False, # Whether to enable the watchdog timer.
607 &quot;numaNodeCount&quot;: 42, # The number of vNUMA nodes.
608 &quot;performanceMonitoringUnit&quot;: &quot;A String&quot;, # Type of Performance Monitoring Unit requested on instance.
609 &quot;threadsPerCore&quot;: 42, # The number of threads per physical core. To disable simultaneous
610 # multithreading (SMT) set this to 1. If unset, the maximum number
611 # of threads supported per core by the underlying processor is
612 # assumed.
613 &quot;turboMode&quot;: &quot;A String&quot;, # Turbo frequency mode to use for the instance.
614 # Supported modes include:
615 # * ALL_CORE_MAX
616 #
617 # Using empty string or not setting this field will use the platform-specific
618 # default turbo mode.
619 &quot;visibleCoreCount&quot;: 42, # The number of physical cores to expose to an instance. Multiply by
620 # the number of threads per core to compute the total number of virtual
621 # CPUs to expose to the instance. If unset, the number of cores is
622 # inferred from the instance&#x27;s nominal CPU count and the underlying
623 # platform&#x27;s SMT width.
624 },
625 &quot;canIpForward&quot;: True or False, # Enables instances created based on these properties to send packets with
626 # source IP addresses other than their own and receive packets with
627 # destination IP addresses other than their own. If these instances will be
628 # used as an IP gateway or it will be set as the next-hop in a Route
629 # resource, specify true. If unsure, leave this set tofalse. See theEnable IP forwarding
630 # documentation for more information.
631 &quot;confidentialInstanceConfig&quot;: { # A set of Confidential Instance options. # Specifies the Confidential Instance options.
632 # Note that for MachineImage, this is not supported yet.
633 &quot;confidentialInstanceType&quot;: &quot;A String&quot;, # Defines the type of technology used by the confidential instance.
634 &quot;confidentialParavisorConfig&quot;: { # A set of Confidential Paravisor (SVSM) options. # Defines a set of Confidential Paravisor (SVSM) options.
635 &quot;confidentialTpmType&quot;: &quot;A String&quot;,
636 &quot;sevSnpIrqMode&quot;: &quot;A String&quot;,
637 },
638 &quot;enableConfidentialCompute&quot;: True or False, # Defines whether the instance should have confidential compute enabled.
639 },
640 &quot;description&quot;: &quot;A String&quot;, # An optional text description for the instances that are created from these
641 # properties.
642 &quot;disks&quot;: [ # An array of disks that are associated with the instances that are created
643 # from these properties.
644 { # An instance-attached disk resource.
645 &quot;architecture&quot;: &quot;A String&quot;, # Output only. [Output Only] The architecture of the attached disk. Valid values are ARM64
646 # or X86_64.
647 &quot;autoDelete&quot;: True or False, # Specifies whether the disk will be auto-deleted when the instance is
648 # deleted (but not when the disk is detached from the instance).
649 &quot;boot&quot;: True or False, # Indicates that this is a boot disk. The virtual machine will use the first
650 # partition of the disk for its root filesystem.
651 &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
652 # running within the instance. This name can be used to reference the device
653 # for mounting, resizing, and so on, from within the instance.
654 #
655 # If not specified, the server chooses a default device name to apply to this
656 # disk, in the form persistent-disk-x, where x is a number
657 # assigned by Google Compute Engine. This field is only applicable for
658 # persistent disks.
659 &quot;diskEncryptionKey&quot;: { # Encrypts or decrypts a disk using acustomer-supplied
660 # encryption key.
661 #
662 # If you are creating a new disk, this field encrypts the new disk using
663 # an encryption key that you provide. If you are attaching an existing
664 # disk that is already encrypted, this field decrypts the disk using
665 # the customer-supplied encryption key.
666 #
667 # If you encrypt a disk using a customer-supplied key, you must provide the
668 # same key again when you attempt to use this resource at a later time. For
669 # example, you must provide the key when you create a snapshot or an image
670 # from the disk or when you attach the disk to a virtual machine instance.
671 #
672 # If you do not provide an encryption key, then the disk will be encrypted
673 # using an automatically generated key and you do not need to provide a key
674 # to use the disk later.
675 #
676 # Note:
677 #
678 # Instance templates do not storecustomer-supplied
679 # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
680 #
681 # You cannot create VMs that have disks with customer-supplied keys using
682 # the bulk
683 # insert method.
684 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
685 # For example:
686 #
687 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
688 # key_region/cryptoKeys/key
689 #
690 # The fully-qualifed key name may be returned for resource GET requests. For
691 # example:
692 #
693 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
694 # key_region/cryptoKeys/key
695 # /cryptoKeyVersions/1
696 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
697 # key. If absent, the Compute Engine default service account is used.
698 # For example:
699 #
700 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
701 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
702 # encryption key, encoded in RFC
703 # 4648 base64 to either encrypt or decrypt this resource. You can
704 # provide either the rawKey or thersaEncryptedKey.
705 # For example:
706 #
707 # &quot;rawKey&quot;:
708 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
709 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
710 # customer-supplied encryption key to either encrypt or decrypt this
711 # resource. You can provide either the rawKey or thersaEncryptedKey.
712 # For example:
713 #
714 # &quot;rsaEncryptedKey&quot;:
715 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
716 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
717 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
718 #
719 # The key must meet the following requirements before you can provide it to
720 # Compute Engine:
721 #
722 # 1. The key is wrapped using a RSA public key certificate provided by
723 # Google.
724 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
725 # encoding.
726 #
727 # Gets the RSA public key certificate provided by Google at:
728 #
729 #
730 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
731 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
732 # 4648 base64 encoded SHA-256 hash of the customer-supplied
733 # encryption key that protects this resource.
734 },
735 &quot;diskSizeGb&quot;: &quot;A String&quot;, # The size of the disk in GB.
736 &quot;forceAttach&quot;: True or False, # [Input Only] Whether to force attach the regional disk even if it&#x27;s
737 # currently attached to another instance. If you try to force attach a zonal
738 # disk to an instance, you will receive an error.
739 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
740 # only for bootable images. Read
741 # Enabling guest operating system features to see a list of available
742 # options.
743 { # Guest OS features.
744 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
745 # separate values. Set to one or more of the following values:
746 #
747 # - VIRTIO_SCSI_MULTIQUEUE
748 # - WINDOWS
749 # - MULTI_IP_SUBNET
750 # - UEFI_COMPATIBLE
751 # - GVNIC
752 # - SEV_CAPABLE
753 # - SUSPEND_RESUME_COMPATIBLE
754 # - SEV_LIVE_MIGRATABLE_V2
755 # - SEV_SNP_CAPABLE
756 # - TDX_CAPABLE
757 # - IDPF
758 # - SNP_SVSM_CAPABLE
759 # - CCA_CAPABLE
760 #
761 #
762 # For more information, see
763 # Enabling guest operating system features.
764 },
765 ],
766 &quot;index&quot;: 42, # Output only. [Output Only] A zero-based index to this disk, where 0 is reserved for the
767 # boot disk. If you have many disks attached to an instance, each
768 # disk would have a unique index number.
769 &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
770 # alongside the new instance. Use initialization parameters to create boot
771 # disks or local SSDs attached to the new instance.
772 #
773 # This property is mutually exclusive with the source property;
774 # you can only define one or the other, but not both.
775 # alongside the new instance. Use initialization parameters to create boot
776 # disks or local SSDs attached to the new instance.
777 #
778 # This field is persisted and returned for instanceTemplate and not returned
779 # in the context of instance.
780 #
781 # This property is mutually exclusive with the source property;
782 # you can only define one or the other, but not both.
783 &quot;architecture&quot;: &quot;A String&quot;, # The architecture of the attached disk. Valid values are
784 # arm64 or x86_64.
785 &quot;description&quot;: &quot;A String&quot;, # An optional description. Provide this property when creating the disk.
786 &quot;diskName&quot;: &quot;A String&quot;, # Specifies the disk name. If not specified, the default is to use the name
787 # of the instance. If a disk with the same name already exists in the given
788 # region, the existing disk is attached to the new instance and the
789 # new disk is not created.
790 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB. The size must be at least
791 # 10 GB. If you specify a sourceImage, which is required for
792 # boot disks, the default size is the size of the sourceImage.
793 # If you do not specify a sourceImage, the default disk size
794 # is 500 GB.
795 &quot;diskType&quot;: &quot;A String&quot;,
796 &quot;enableConfidentialCompute&quot;: True or False, # Whether this disk is using confidential compute mode.
797 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
798 # only for bootable images. Read
799 # Enabling guest operating system features to see a list of available
800 # options.
801 #
802 # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
803 { # Guest OS features.
804 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
805 # separate values. Set to one or more of the following values:
806 #
807 # - VIRTIO_SCSI_MULTIQUEUE
808 # - WINDOWS
809 # - MULTI_IP_SUBNET
810 # - UEFI_COMPATIBLE
811 # - GVNIC
812 # - SEV_CAPABLE
813 # - SUSPEND_RESUME_COMPATIBLE
814 # - SEV_LIVE_MIGRATABLE_V2
815 # - SEV_SNP_CAPABLE
816 # - TDX_CAPABLE
817 # - IDPF
818 # - SNP_SVSM_CAPABLE
819 # - CCA_CAPABLE
820 #
821 #
822 # For more information, see
823 # Enabling guest operating system features.
824 },
825 ],
826 &quot;interface&quot;: &quot;A String&quot;, # [Deprecated] Specifies the disk interface to use for attaching this disk,
827 # which is either SCSI or NVME. The default isSCSI.
828 &quot;labels&quot;: { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
829 # persistent disks.
830 &quot;a_key&quot;: &quot;A String&quot;,
831 },
832 &quot;licenseCodes&quot;: [ # Integer license codes indicating which licenses are attached to this
833 # disk.
834 &quot;A String&quot;,
835 ],
836 &quot;licenses&quot;: [ # A list of publicly visible licenses. Reserved for Google&#x27;s use.
837 &quot;A String&quot;,
838 ],
839 &quot;multiWriter&quot;: True or False, # Indicates whether or not the disk can be read/write attached to
840 # more than one instance.
841 &quot;onUpdateAction&quot;: &quot;A String&quot;, # Specifies which action to take on instance update with this disk. Default
842 # is to use the existing disk.
843 &quot;provisionedIops&quot;: &quot;A String&quot;, # Indicates how many IOPS to provision for the disk. This sets the number
844 # of I/O operations per second that the disk can handle. Values must be
845 # between 10,000 and 120,000. For more details, see theExtreme persistent
846 # disk documentation.
847 &quot;provisionedThroughput&quot;: &quot;A String&quot;, # Indicates how much throughput to provision for the disk. This sets the
848 # number of throughput mb per second that the disk can handle. Values must
849 # greater than or equal to 1.
850 &quot;replicaZones&quot;: [ # Required for each regional disk associated with the instance. Specify
851 # the URLs of the zones where the disk should be replicated to.
852 # You must provide exactly two replica zones, and one zone must be the same
853 # as the instance zone.
854 &quot;A String&quot;,
855 ],
856 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
857 # have the same definition as resource
858 # manager tags. Keys and values can be either in numeric format,
859 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
860 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
861 # `{tag_value_short_name}`. The field is ignored (both PUT &amp; PATCH) when
862 # empty.
863 &quot;a_key&quot;: &quot;A String&quot;,
864 },
865 &quot;resourcePolicies&quot;: [ # Resource policies applied to this disk for automatic snapshot creations.
866 # Specified using the full or partial URL. For instance template, specify
867 # only the resource policy name.
868 &quot;A String&quot;,
869 ],
870 &quot;sourceImage&quot;: &quot;A String&quot;, # The source image to create this disk. When creating a new instance boot
871 # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
872 # is required.
873 #
874 # To create a disk with one of the public operating system
875 # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
876 #
877 # projects/debian-cloud/global/images/family/debian-9
878 #
879 #
880 # Alternatively, use a specific version of a public operating system image:
881 #
882 # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
883 #
884 #
885 # To create a disk with a custom image that you created, specify the
886 # image name in the following format:
887 #
888 # global/images/my-custom-image
889 #
890 #
891 # You can also specify a custom image by its image family, which returns
892 # the latest version of the image in that family. Replace the image name
893 # with family/family-name:
894 #
895 # global/images/family/my-image-family
896 #
897 #
898 # If the source image is deleted later, this field will not be set.
899 &quot;sourceImageEncryptionKey&quot;: { # Thecustomer-supplied
900 # encryption key of the source image. Required if the source image is
901 # protected by a customer-supplied encryption key.
902 #
903 # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
904 # encryption keys, so you cannot create disks for instances in a managed instance group if the
905 # source images are encrypted with your own keys.
906 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
907 # For example:
908 #
909 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
910 # key_region/cryptoKeys/key
911 #
912 # The fully-qualifed key name may be returned for resource GET requests. For
913 # example:
914 #
915 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
916 # key_region/cryptoKeys/key
917 # /cryptoKeyVersions/1
918 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
919 # key. If absent, the Compute Engine default service account is used.
920 # For example:
921 #
922 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
923 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
924 # encryption key, encoded in RFC
925 # 4648 base64 to either encrypt or decrypt this resource. You can
926 # provide either the rawKey or thersaEncryptedKey.
927 # For example:
928 #
929 # &quot;rawKey&quot;:
930 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
931 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
932 # customer-supplied encryption key to either encrypt or decrypt this
933 # resource. You can provide either the rawKey or thersaEncryptedKey.
934 # For example:
935 #
936 # &quot;rsaEncryptedKey&quot;:
937 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
938 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
939 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
940 #
941 # The key must meet the following requirements before you can provide it to
942 # Compute Engine:
943 #
944 # 1. The key is wrapped using a RSA public key certificate provided by
945 # Google.
946 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
947 # encoding.
948 #
949 # Gets the RSA public key certificate provided by Google at:
950 #
951 #
952 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
953 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
954 # 4648 base64 encoded SHA-256 hash of the customer-supplied
955 # encryption key that protects this resource.
956 },
957 &quot;sourceInstantSnapshot&quot;: &quot;A String&quot;, # The source instant-snapshot to create this disk. When creating a new
958 # instance boot disk, one of initializeParams.sourceSnapshot
959 # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
960 # is required.
961 #
962 # To create a disk with a snapshot that you created, specify the
963 # snapshot name in the following format:
964 #
965 # us-central1-a/instantSnapshots/my-backup
966 #
967 #
968 # If the source instant-snapshot is deleted later, this field will not be
969 # set.
970 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # The source snapshot to create this disk. When creating a new instance
971 # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
972 # is required.
973 #
974 # To create a disk with a snapshot that you created, specify the
975 # snapshot name in the following format:
976 #
977 # global/snapshots/my-backup
978 #
979 #
980 # If the source snapshot is deleted later, this field will not be set.
981 #
982 # Note: You cannot create VMs in bulk using a snapshot as the source. Use
983 # an image instead when you create VMs using
984 # the bulk
985 # insert method.
986 &quot;sourceSnapshotEncryptionKey&quot;: { # Thecustomer-supplied
987 # encryption key of the source snapshot.
988 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
989 # For example:
990 #
991 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
992 # key_region/cryptoKeys/key
993 #
994 # The fully-qualifed key name may be returned for resource GET requests. For
995 # example:
996 #
997 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
998 # key_region/cryptoKeys/key
999 # /cryptoKeyVersions/1
1000 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
1001 # key. If absent, the Compute Engine default service account is used.
1002 # For example:
1003 #
1004 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
1005 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
1006 # encryption key, encoded in RFC
1007 # 4648 base64 to either encrypt or decrypt this resource. You can
1008 # provide either the rawKey or thersaEncryptedKey.
1009 # For example:
1010 #
1011 # &quot;rawKey&quot;:
1012 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
1013 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
1014 # customer-supplied encryption key to either encrypt or decrypt this
1015 # resource. You can provide either the rawKey or thersaEncryptedKey.
1016 # For example:
1017 #
1018 # &quot;rsaEncryptedKey&quot;:
1019 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
1020 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
1021 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
1022 #
1023 # The key must meet the following requirements before you can provide it to
1024 # Compute Engine:
1025 #
1026 # 1. The key is wrapped using a RSA public key certificate provided by
1027 # Google.
1028 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
1029 # encoding.
1030 #
1031 # Gets the RSA public key certificate provided by Google at:
1032 #
1033 #
1034 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
1035 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
1036 # 4648 base64 encoded SHA-256 hash of the customer-supplied
1037 # encryption key that protects this resource.
1038 },
1039 &quot;storagePool&quot;: &quot;A String&quot;, # The storage pool in which the new disk is created. You can provide
1040 # this as a partial or full URL to the resource. For example, the following
1041 # are valid values:
1042 #
1043 #
1044 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
1045 # - projects/project/zones/zone/storagePools/storagePool
1046 # - zones/zone/storagePools/storagePool
1047 },
1048 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is
1049 # either SCSI or NVME. For most machine types, the
1050 # default is SCSI. Local SSDs can use either NVME or SCSI.
1051 # In certain configurations, persistent disks can use NVMe. For more
1052 # information, seeAbout
1053 # persistent disks.
1054 &quot;kind&quot;: &quot;compute#attachedDisk&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
1055 &quot;licenses&quot;: [ # Output only. [Output Only] Any valid publicly visible licenses.
1056 &quot;A String&quot;,
1057 ],
1058 &quot;locked&quot;: True or False, # Output only. [Output Only] Whether to indicate the attached disk is locked. The locked
1059 # disk is not allowed to be detached from the instance, or to be used as the
1060 # source of the snapshot creation, and the image creation. The instance with
1061 # at least one locked attached disk is not allow to be used as source of
1062 # machine image creation, instant snapshot creation, and not allowed to be
1063 # deleted with --keep-disk parameter set to true for locked disks.
1064 &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
1065 # in READ_WRITE mode.
1066 &quot;savedState&quot;: &quot;A String&quot;, # Output only. For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
1067 # field is set to PRESERVED if the LocalSSD data has been saved
1068 # to a persistent location by customer request. (see the
1069 # discard_local_ssd option on Stop/Suspend).
1070 # Read-only in the api.
1071 &quot;shieldedInstanceInitialState&quot;: { # Initial State for shielded instance, # Output only. [Output Only] shielded vm initial state stored on disk
1072 # these are public keys which are safe to store in public
1073 &quot;dbs&quot;: [ # The Key Database (db).
1074 {
1075 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
1076 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
1077 },
1078 ],
1079 &quot;dbxs&quot;: [ # The forbidden key database (dbx).
1080 {
1081 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
1082 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
1083 },
1084 ],
1085 &quot;keks&quot;: [ # The Key Exchange Key (KEK).
1086 {
1087 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
1088 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
1089 },
1090 ],
1091 &quot;pk&quot;: { # The Platform Key (PK).
1092 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
1093 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
1094 },
1095 },
1096 &quot;source&quot;: &quot;A String&quot;, # Specifies a valid partial or full URL to an existing Persistent Disk
1097 # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
1098 # is required.
1099 #
1100 # If desired, you can also attach existing non-root persistent disks using
1101 # this property. This field is only applicable for persistent disks.
1102 #
1103 # Note that for InstanceTemplate, specify the disk name for zonal disk,
1104 # and the URL for regional disk.
1105 &quot;type&quot;: &quot;A String&quot;, # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
1106 },
1107 ],
1108 &quot;displayDevice&quot;: { # A set of Display Device options # Display Device properties to enable support
1109 # for remote display products like: Teradici,
1110 # VNC and TeamViewer
1111 # Note that for MachineImage, this is not supported yet.
1112 &quot;enableDisplay&quot;: True or False, # Defines whether the instance has Display enabled.
1113 },
1114 &quot;guestAccelerators&quot;: [ # A list of guest accelerator cards&#x27; type and count to use for instances
1115 # created from these properties.
1116 { # A specification of the type and number of accelerator cards attached to the
1117 # instance.
1118 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
1119 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this
1120 # instance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100
1121 # If you are creating an instance template, specify only the
1122 # accelerator name.
1123 # See GPUs on Compute Engine
1124 # for a full list of accelerator types.
1125 },
1126 ],
1127 &quot;identity&quot;: &quot;A String&quot;,
1128 &quot;identityCertificate&quot;: True or False,
1129 &quot;keyRevocationActionType&quot;: &quot;A String&quot;, # KeyRevocationActionType of the instance. Supported options are &quot;STOP&quot; and
1130 # &quot;NONE&quot;. The default value is &quot;NONE&quot; if it is not specified.
1131 &quot;labels&quot;: { # Labels to apply to instances that are created from these properties.
1132 &quot;a_key&quot;: &quot;A String&quot;,
1133 },
1134 &quot;machineType&quot;: &quot;A String&quot;, # The machine type to use for instances that are created from these
1135 # properties.
1136 # This field only accepts a machine type name, for example `n2-standard-4`.
1137 # If you use the machine type full or partial URL, for example
1138 # `projects/my-l7ilb-project/zones/us-central1-a/machineTypes/n2-standard-4`,
1139 # the request will result in an `INTERNAL_ERROR`.
1140 &quot;metadata&quot;: { # A metadata key/value entry. # The metadata key/value pairs to assign to instances that are created from
1141 # these properties. These pairs can consist of custom metadata or predefined
1142 # keys. SeeProject and
1143 # instance metadata for more information.
1144 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
1145 # the metadata&#x27;s contents and used for optimistic locking. The
1146 # fingerprint is initially generated by Compute Engine and changes after
1147 # every request to modify or update metadata. You must always provide an
1148 # up-to-date fingerprint hash in order to update or change metadata,
1149 # otherwise the request will fail with error412 conditionNotMet.
1150 #
1151 # To see the latest fingerprint, make a get() request to
1152 # retrieve the resource.
1153 &quot;items&quot;: [ # Array of key/value pairs. The total size of all keys and values must be
1154 # less than 512 KB.
1155 { # Metadata
1156 &quot;key&quot;: &quot;A String&quot;, # Key for the metadata entry. Keys must conform to the following
1157 # regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length.
1158 # This is reflected as part of a URL in the metadata server. Additionally, to
1159 # avoid ambiguity, keys must not conflict with any other metadata keys
1160 # for the project.
1161 &quot;value&quot;: &quot;A String&quot;, # Value for the metadata entry. These are free-form strings, and only
1162 # have meaning as interpreted by the image running in the instance. The
1163 # only restriction placed on values is that their size must be less than
1164 # or equal to 262144 bytes (256 KiB).
1165 },
1166 ],
1167 &quot;kind&quot;: &quot;compute#metadata&quot;, # Output only. [Output Only] Type of the resource. Always compute#metadata
1168 # for metadata.
1169 },
1170 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Minimum cpu/platform to be used by instances. The instance may be
1171 # scheduled on the specified or newer cpu/platform. Applicable values are the
1172 # friendly names of CPU platforms, such asminCpuPlatform: &quot;Intel Haswell&quot; orminCpuPlatform: &quot;Intel Sandy Bridge&quot;. For more
1173 # information, read Specifying a
1174 # Minimum CPU Platform.
1175 &quot;networkInterfaces&quot;: [ # An array of network access configurations for this interface.
1176 { # A network interface resource attached to an instance.
1177 &quot;accessConfigs&quot;: [ # An array of configurations for this interface. Currently, only one access
1178 # config, ONE_TO_ONE_NAT, is supported. If there are noaccessConfigs specified, then this instance will have
1179 # no external internet access.
1180 { # An access configuration attached to an instance&#x27;s network interface.
1181 # Only one access config per instance is supported.
1182 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
1183 # The first IPv6 address of the external IPv6 range associated
1184 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
1185 # use a static external IP address, it must be unused and in the same region
1186 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
1187 # assign an external IPv6 address from the instance&#x27;s subnetwork.
1188 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
1189 # external IPv6 range.
1190 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
1191 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
1192 # (IPv4), the default and recommended name is External NAT, but
1193 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
1194 # recommend name is External IPv6.
1195 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
1196 # address associated with this instance. Specify an unused static
1197 # external IP address available to the project or leave this field undefined
1198 # to use an IP from a shared ephemeral IP address pool. If you specify a
1199 # static external IP address, it must live in the same region as the zone of
1200 # the instance.
1201 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
1202 # configuration and can only take the following values: PREMIUM,STANDARD.
1203 #
1204 # If an AccessConfig is specified without a valid external IP address, an
1205 # ephemeral IP will be created with this networkTier.
1206 #
1207 # If an AccessConfig with a valid external IP address is specified, it must
1208 # match that of the networkTier associated with the Address resource owning
1209 # that IP.
1210 &quot;publicDnsName&quot;: &quot;A String&quot;, # Output only. [Output Only] The public DNS domain name for the instance.
1211 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
1212 #
1213 # 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
1214 # first IP in associated external IPv6 range.
1215 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
1216 # config.
1217 &quot;setPublicDns&quot;: True or False, # Specifies whether a public DNS &#x27;A&#x27; record should be created for the
1218 # external IP address of this access configuration.
1219 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
1220 # external IP address of the instance to a DNS domain name.
1221 #
1222 # This field is not used in ipv6AccessConfig. A default PTR
1223 # record will be created if the VM has external IPv6 range associated.
1224 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
1225 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
1226 },
1227 ],
1228 &quot;aliasIpRanges&quot;: [ # An array of alias IP ranges for this network interface.
1229 # You can only specify this field for network interfaces in VPC networks.
1230 { # An alias IP range attached to an instance&#x27;s network interface.
1231 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
1232 # must belong to the specified subnetwork and cannot contain IP addresses
1233 # reserved by system or used by other network interfaces. This range may be
1234 # 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).
1235 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
1236 # alias range. If not specified, the primary range of the subnetwork is used.
1237 },
1238 ],
1239 &quot;aliasIpv6Ranges&quot;: [ # An array of alias IPv6 ranges for this network interface.
1240 # You can only specify this field for network interfaces in VPC networks.
1241 { # An alias IP range attached to an instance&#x27;s network interface.
1242 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
1243 # must belong to the specified subnetwork and cannot contain IP addresses
1244 # reserved by system or used by other network interfaces. This range may be
1245 # 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).
1246 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
1247 # alias range. If not specified, the primary range of the subnetwork is used.
1248 },
1249 ],
1250 &quot;dns64Eligible&quot;: True or False, # If true, this network interface is eligible for DNS64.
1251 # This field is only supported for dual-stack (IPV4_IPV6) network interfaces.
1252 &quot;enableVpcScopedDns&quot;: True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
1253 # with network_attachment.
1254 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint hash of contents stored in this network interface.
1255 # This field will be ignored when inserting an Instance or
1256 # adding a NetworkInterface. An up-to-date
1257 # 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.
1258 &quot;igmpQuery&quot;: &quot;A String&quot;, # Indicate whether igmp query is enabled on the network interface
1259 # or not. If enabled, also indicates the version of IGMP supported.
1260 &quot;internalIpv6PrefixLength&quot;: 42, # The prefix length of the primary internal IPv6 range.
1261 &quot;ipv6AccessConfigs&quot;: [ # An array of IPv6 access configurations for this interface. Currently, only
1262 # one IPv6 access config, DIRECT_IPV6, is supported. If there
1263 # is no ipv6AccessConfig specified, then this instance will
1264 # have no external IPv6 Internet access.
1265 { # An access configuration attached to an instance&#x27;s network interface.
1266 # Only one access config per instance is supported.
1267 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
1268 # The first IPv6 address of the external IPv6 range associated
1269 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
1270 # use a static external IP address, it must be unused and in the same region
1271 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
1272 # assign an external IPv6 address from the instance&#x27;s subnetwork.
1273 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
1274 # external IPv6 range.
1275 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
1276 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
1277 # (IPv4), the default and recommended name is External NAT, but
1278 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
1279 # recommend name is External IPv6.
1280 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
1281 # address associated with this instance. Specify an unused static
1282 # external IP address available to the project or leave this field undefined
1283 # to use an IP from a shared ephemeral IP address pool. If you specify a
1284 # static external IP address, it must live in the same region as the zone of
1285 # the instance.
1286 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
1287 # configuration and can only take the following values: PREMIUM,STANDARD.
1288 #
1289 # If an AccessConfig is specified without a valid external IP address, an
1290 # ephemeral IP will be created with this networkTier.
1291 #
1292 # If an AccessConfig with a valid external IP address is specified, it must
1293 # match that of the networkTier associated with the Address resource owning
1294 # that IP.
1295 &quot;publicDnsName&quot;: &quot;A String&quot;, # Output only. [Output Only] The public DNS domain name for the instance.
1296 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
1297 #
1298 # 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
1299 # first IP in associated external IPv6 range.
1300 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
1301 # config.
1302 &quot;setPublicDns&quot;: True or False, # Specifies whether a public DNS &#x27;A&#x27; record should be created for the
1303 # external IP address of this access configuration.
1304 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
1305 # external IP address of the instance to a DNS domain name.
1306 #
1307 # This field is not used in ipv6AccessConfig. A default PTR
1308 # record will be created if the VM has external IPv6 range associated.
1309 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
1310 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
1311 },
1312 ],
1313 &quot;ipv6AccessType&quot;: &quot;A String&quot;, # Output only. [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be
1314 # accessed from the Internet. This field is always inherited from its
1315 # subnetwork.
1316 #
1317 # Valid only if stackType is IPV4_IPV6.
1318 &quot;ipv6Address&quot;: &quot;A String&quot;, # An IPv6 internal network address for this network interface. To
1319 # use a static internal IP address, it must be unused and in the same region
1320 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
1321 # assign an internal IPv6 address from the instance&#x27;s subnetwork.
1322 &quot;kind&quot;: &quot;compute#networkInterface&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#networkInterface for network interfaces.
1323 &quot;macAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] MAC address assigned to this network interface.
1324 &quot;name&quot;: &quot;A String&quot;, # [Output Only] The name of the network interface, which is generated by the
1325 # server. For a VM, the network interface uses the nicN naming
1326 # format. Where N is a value between 0 and7. The default interface value is nic0.
1327 &quot;nat64Eligible&quot;: True or False, # If true, this network interface is eligible for NAT64.
1328 # This field is only supported for dual-stack (IPV4_IPV6) network interfaces.
1329 &quot;network&quot;: &quot;A String&quot;, # URL of the VPC network resource for this instance. When creating an
1330 # instance, if neither the network nor the subnetwork is specified, the
1331 # default network global/networks/default is used. If the
1332 # selected project doesn&#x27;t have the default network, you must specify a
1333 # network or subnet. If the network is not specified but the subnetwork is
1334 # specified, the network is inferred.
1335 #
1336 # If you specify this property, you can specify the network as
1337 # a full or partial URL. For example, the following are all valid URLs:
1338 #
1339 #
1340 # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
1341 # - projects/project/global/networks/network
1342 # - global/networks/default
1343 &quot;networkAttachment&quot;: &quot;A String&quot;, # The URL of the network attachment that this interface should connect
1344 # to in the following format:
1345 # projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.
1346 &quot;networkIP&quot;: &quot;A String&quot;, # An IPv4 internal IP address to assign to the instance for this network
1347 # interface. If not specified by the user, an unused internal IP is
1348 # assigned by the system.
1349 &quot;nicType&quot;: &quot;A String&quot;, # The type of vNIC to be used on this interface. This may be gVNIC or
1350 # VirtioNet.
1351 &quot;parentNicName&quot;: &quot;A String&quot;, # Name of the parent network interface of a dynamic network interface.
1352 &quot;queueCount&quot;: 42, # The networking queue count that&#x27;s specified by users for the network
1353 # interface. Both Rx and Tx queues will be set to this number. It&#x27;ll be empty
1354 # if not specified by the users.
1355 &quot;serviceClassId&quot;: &quot;A String&quot;, # Optional. Producer Service&#x27;s Service class Id for the region of this network
1356 # interface. Can only be used with network_attachment. It is not possible to
1357 # use on its own however, network_attachment can be used without
1358 # service_class_id.
1359 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for this network interface. To assign only IPv4 addresses,
1360 # use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, useIPV4_IPV6. If not specified, IPV4_ONLY is used.
1361 #
1362 # This field can be both set at instance creation and update network
1363 # interface operations.
1364 &quot;subinterfaces&quot;: [ # SubInterfaces help enable L2 communication for the instance over
1365 # subnetworks that support L2. Every network interface will get a default
1366 # untagged (vlan not specified) subinterface. Users can specify additional
1367 # tagged subinterfaces which are sub-fields to the Network Interface.
1368 {
1369 &quot;ipAddress&quot;: &quot;A String&quot;, # An IPv4 internal IP address to assign to the instance for this
1370 # subinterface. If specified, ip_allocation_mode should be set to
1371 # ALLOCATE_IP.
1372 &quot;ipAllocationMode&quot;: &quot;A String&quot;,
1373 &quot;subnetwork&quot;: &quot;A String&quot;, # If specified, this subnetwork must belong to the same network
1374 # as that of the network interface.
1375 # If not specified the subnet of network interface will be used.
1376 # If you specify this property, you can specify the subnetwork as a full
1377 # or partial URL. For example, the following are all valid URLs:
1378 #
1379 #
1380 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
1381 # - regions/region/subnetworks/subnetwork
1382 &quot;vlan&quot;: 42, # VLAN tag. Should match the VLAN(s) supported by the subnetwork to which
1383 # this subinterface is connecting.
1384 },
1385 ],
1386 &quot;subnetwork&quot;: &quot;A String&quot;, # The URL of the Subnetwork resource for this instance. If the network
1387 # resource is inlegacy
1388 # mode, do not specify this field. If the network is in auto subnet
1389 # mode, specifying the subnetwork is optional. If the network is in custom
1390 # subnet mode, specifying the subnetwork is required. If you specify this
1391 # field, you can specify the subnetwork as a full or partial URL. For
1392 # example, the following are all valid URLs:
1393 #
1394 #
1395 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
1396 # - regions/region/subnetworks/subnetwork
1397 &quot;vlan&quot;: 42, # VLAN tag of a dynamic network interface, must be an integer in the range
1398 # from 2 to 255 inclusively.
1399 },
1400 ],
1401 &quot;networkPerformanceConfig&quot;: { # Note that for MachineImage, this is not supported yet.
1402 &quot;externalIpEgressBandwidthTier&quot;: &quot;A String&quot;,
1403 &quot;totalEgressBandwidthTier&quot;: &quot;A String&quot;,
1404 },
1405 &quot;partnerMetadata&quot;: { # Partner Metadata assigned to the instance properties. A map from a
1406 # subdomain (namespace) to entries map.
1407 &quot;a_key&quot;: {
1408 &quot;entries&quot;: { # Map of a partner metadata that belong to the same subdomain.
1409 # It accepts any value including google.protobuf.Struct.
1410 &quot;a_key&quot;: &quot;&quot;,
1411 },
1412 },
1413 },
1414 &quot;postKeyRevocationActionType&quot;: &quot;A String&quot;, # PostKeyRevocationActionType of the instance.
1415 &quot;privateIpv6GoogleAccess&quot;: &quot;A String&quot;, # The private IPv6 google access type for VMs.
1416 # If not specified, use INHERIT_FROM_SUBNETWORK as default.
1417 # Note that for MachineImage, this is not supported yet.
1418 &quot;reservationAffinity&quot;: { # Specifies the reservations that this instance can consume from. # Specifies the reservations that instances can consume from.
1419 # Note that for MachineImage, this is not supported yet.
1420 &quot;consumeReservationType&quot;: &quot;A String&quot;, # Specifies the type of reservation from which this instance can consume
1421 # resources: ANY_RESERVATION (default),SPECIFIC_RESERVATION, or NO_RESERVATION. See
1422 # Consuming reserved instances for examples.
1423 &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
1424 # the name of your reservation as its value.
1425 &quot;values&quot;: [ # Corresponds to the label values of a reservation resource. This can be
1426 # either a name to a reservation in the same project or
1427 # &quot;projects/different-project/reservations/some-reservation-name&quot; to target a
1428 # shared reservation in the same zone but in a different project.
1429 &quot;A String&quot;,
1430 ],
1431 },
1432 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the instance. Tag keys and values
1433 # have the same definition as resource
1434 # manager tags. Keys and values can be either in numeric format,
1435 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
1436 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
1437 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
1438 # PATCH) when empty.
1439 &quot;a_key&quot;: &quot;A String&quot;,
1440 },
1441 &quot;resourcePolicies&quot;: [ # Resource policies (names, not URLs) applied to instances created from
1442 # these properties.
1443 # Note that for MachineImage, this is not supported yet.
1444 &quot;A String&quot;,
1445 ],
1446 &quot;scheduling&quot;: { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from
1447 # these properties.
1448 &quot;automaticRestart&quot;: True or False, # Specifies whether the instance should be automatically restarted if it is
1449 # terminated by Compute Engine (not terminated by a user). You can only set
1450 # the automatic restart option for standard instances.Preemptible instances
1451 # cannot be automatically restarted.
1452 #
1453 # By default, this is set to true so an instance is
1454 # automatically restarted if it is terminated by Compute Engine.
1455 &quot;availabilityDomain&quot;: 42, # Specifies the availability domain to place the instance in. The value
1456 # must be a number between 1 and the number of availability domains
1457 # specified in the spread placement policy attached to the instance.
1458 &quot;currentCpus&quot;: 42, # Current number of vCPUs available for VM.
1459 # 0 or unset means default vCPUs of the current machine type.
1460 &quot;currentMemoryMb&quot;: &quot;A String&quot;, # Current amount of memory (in MB) available for VM.
1461 # 0 or unset means default amount of memory of the current machine type.
1462 &quot;gracefulShutdown&quot;: { # The configuration for gracefully shutting down the instance.
1463 &quot;enabled&quot;: True or False, # Opts-in for graceful shutdown.
1464 &quot;maxDuration&quot;: { # A Duration represents a fixed-length span of time represented # The time allotted for the instance to gracefully shut down. If the
1465 # graceful shutdown isn&#x27;t complete after this time, then the instance
1466 # transitions to the STOPPING state.
1467 # as a count of seconds and fractions of seconds at nanosecond
1468 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
1469 # or &quot;month&quot;. Range is approximately 10,000 years.
1470 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
1471 # Durations less than one second are represented with a 0
1472 # `seconds` field and a positive `nanos` field. Must be from 0
1473 # to 999,999,999 inclusive.
1474 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
1475 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
1476 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
1477 },
1478 },
1479 &quot;hostErrorTimeoutSeconds&quot;: 42, # Specify the time in seconds for host error detection, the value must be
1480 # within the range of [90, 330] with the increment of 30, if unset, the
1481 # default behavior of host error recovery will be used.
1482 &quot;instanceTerminationAction&quot;: &quot;A String&quot;, # Specifies the termination action for the instance.
1483 &quot;latencyTolerant&quot;: True or False, # Defines whether the instance is tolerant of higher cpu latency. This can
1484 # only be set during instance creation, or when the instance is not currently
1485 # running. It must not be set if thepreemptible option is
1486 # also set.
1487 &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
1488 # recovery of the Local Ssd state is attempted. Its value should be in
1489 # between 0 and 168 hours with hour granularity and the default value being 1
1490 # hour.
1491 # as a count of seconds and fractions of seconds at nanosecond
1492 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
1493 # or &quot;month&quot;. Range is approximately 10,000 years.
1494 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
1495 # Durations less than one second are represented with a 0
1496 # `seconds` field and a positive `nanos` field. Must be from 0
1497 # to 999,999,999 inclusive.
1498 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
1499 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
1500 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
1501 },
1502 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the instance close to other
1503 # resources.
1504 # This field is for use by internal tools that use the public API.
1505 &quot;maintenanceFreezeDurationHours&quot;: 42, # Specifies the number of hours after VM instance creation where the VM won&#x27;t
1506 # be scheduled for maintenance.
1507 &quot;maintenanceInterval&quot;: &quot;A String&quot;, # Specifies the frequency of planned maintenance events. The accepted values
1508 # are: `PERIODIC`.
1509 &quot;maxRunDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the max run duration for the given instance. If specified,
1510 # the instance termination action will be performed at the end of the run
1511 # duration.
1512 # as a count of seconds and fractions of seconds at nanosecond
1513 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
1514 # or &quot;month&quot;. Range is approximately 10,000 years.
1515 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
1516 # Durations less than one second are represented with a 0
1517 # `seconds` field and a positive `nanos` field. Must be from 0
1518 # to 999,999,999 inclusive.
1519 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
1520 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
1521 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
1522 },
1523 &quot;minNodeCpus&quot;: 42, # The minimum number of virtual CPUs this instance will consume when running
1524 # on a sole-tenant node.
1525 &quot;nodeAffinities&quot;: [ # A set of node affinity and anti-affinity configurations. Refer toConfiguring node
1526 # affinity for more information.
1527 # Overrides reservationAffinity.
1528 { # Node Affinity: the configuration of desired nodes onto which this Instance
1529 # could be scheduled.
1530 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of Node resource.
1531 &quot;operator&quot;: &quot;A String&quot;, # Defines the operation of node selection. Valid operators areIN for affinity and NOT_IN for anti-affinity.
1532 &quot;values&quot;: [ # Corresponds to the label values of Node resource.
1533 &quot;A String&quot;,
1534 ],
1535 },
1536 ],
1537 &quot;onHostMaintenance&quot;: &quot;A String&quot;, # Defines the maintenance behavior for this instance. For standard instances,
1538 # the default behavior is MIGRATE. Forpreemptible instances,
1539 # the default and only possible behavior is TERMINATE. For more
1540 # information, see
1541 # Set
1542 # VM host maintenance policy.
1543 &quot;onInstanceStopAction&quot;: { # Defines the behaviour for instances with the instance_termination_actionSTOP.
1544 &quot;discardLocalSsd&quot;: True or False, # If true, the contents of any attached Local SSD disks will be discarded
1545 # else, the Local SSD data will be preserved when the instance is stopped
1546 # at the end of the run duration/termination time.
1547 },
1548 &quot;preemptible&quot;: True or False, # Defines whether the instance is preemptible. This can only be set during
1549 # instance creation or while the instance isstopped and
1550 # therefore, in a `TERMINATED` state. SeeInstance Life
1551 # Cycle for more information on the possible instance states.
1552 &quot;preemptionNoticeDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft
1553 # Off signal is triggered for Spot
1554 # VMs only. If not specified, there will be no wait before the G2 Soft
1555 # Off signal is triggered.
1556 # as a count of seconds and fractions of seconds at nanosecond
1557 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
1558 # or &quot;month&quot;. Range is approximately 10,000 years.
1559 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
1560 # Durations less than one second are represented with a 0
1561 # `seconds` field and a positive `nanos` field. Must be from 0
1562 # to 999,999,999 inclusive.
1563 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
1564 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
1565 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
1566 },
1567 &quot;provisioningModel&quot;: &quot;A String&quot;, # Specifies the provisioning model of the instance.
1568 &quot;shutdownTimeout&quot;: { # A Duration represents a fixed-length span of time represented # DEPRECATED: please use skipGuestOsShutdown.
1569 # Timeout between GCE ACPI G2 Soft
1570 # Off and ACPI G3 Mechanical
1571 # Off during shutdown operation of VM.
1572 #
1573 # For Standard VMs values between 0s and 120s are allowed. For Spot and
1574 # Preemptible VMs supported values are between 0s and 30s.
1575 #
1576 # If no value is specified for shutdownDuration, default values are 90s for
1577 # Standard VMs and 30s for Spot/Preemptible VMs.
1578 # as a count of seconds and fractions of seconds at nanosecond
1579 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
1580 # or &quot;month&quot;. Range is approximately 10,000 years.
1581 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
1582 # Durations less than one second are represented with a 0
1583 # `seconds` field and a positive `nanos` field. Must be from 0
1584 # to 999,999,999 inclusive.
1585 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
1586 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
1587 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
1588 },
1589 &quot;skipGuestOsShutdown&quot;: True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
1590 # Off and ACPI G3 Mechanical
1591 # Off for Standard VMs and 30 seconds for Spot VMs.
1592 &quot;terminationTime&quot;: &quot;A String&quot;, # Specifies the timestamp, when the instance will be terminated, inRFC3339 text format. If specified, the instance
1593 # termination action will be performed at the termination time.
1594 &quot;vsockMode&quot;: { # Message to control the enablement of the vsock device. # The vsock mode of the instance.
1595 &quot;mode&quot;: &quot;A String&quot;,
1596 },
1597 &quot;windowsLicenseOptimizationMode&quot;: &quot;A String&quot;, # Represents the Windows Server License Optimization Mode of the VM. If
1598 # unspecified, the default mode is `OFF`.
1599 },
1600 &quot;secureTags&quot;: [ # [Input Only] Secure tags to apply to this instance.
1601 # Maximum number of secure tags allowed is 50.
1602 # Note that for MachineImage, this is not supported yet.
1603 &quot;A String&quot;,
1604 ],
1605 &quot;serviceAccounts&quot;: [ # A list of service accounts with specified scopes. Access tokens for these
1606 # service accounts are available to the instances that are created from
1607 # these properties. Use metadata queries to obtain the access tokens for
1608 # these instances.
1609 { # A service account.
1610 &quot;email&quot;: &quot;A String&quot;, # Email address of the service account.
1611 &quot;scopes&quot;: [ # The list of scopes to be made available for this service account.
1612 &quot;A String&quot;,
1613 ],
1614 },
1615 ],
1616 &quot;serviceIntegrationSpecs&quot;: { # Mapping of user defined keys to ServiceIntegrationSpec.
1617 &quot;a_key&quot;: { # Specifies the parameters to configure an integration with instances.
1618 &quot;backupDr&quot;: { # Specifies parameters to Backup and DR to attach a BackupPlan to a compute
1619 # instance for managed VM backup.
1620 &quot;plan&quot;: &quot;A String&quot;, # The BackupPlan resource to attach to the instance. Specified as a
1621 # resource reference in instances, and regional instance templates, and as
1622 # just the plan name in global instance templates
1623 },
1624 },
1625 },
1626 &quot;shieldedInstanceConfig&quot;: { # A set of Shielded Instance options. # Note that for MachineImage, this is not supported yet.
1627 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.Enabled by
1628 # default.
1629 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.Disabled by
1630 # default.
1631 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.Enabled by
1632 # default.
1633 },
1634 &quot;shieldedVmConfig&quot;: { # A set of Shielded VM options. # Specifies the Shielded VM options for the instances that are created from
1635 # these properties.
1636 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.
1637 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.
1638 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.
1639 },
1640 &quot;tags&quot;: { # A set of instance tags. # A list of tags to apply to the instances that are created from these
1641 # properties. The tags identify valid sources or targets for network
1642 # firewalls. The setTags method can modify this list of tags. Each tag within
1643 # the list must comply with RFC1035.
1644 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
1645 # the tags&#x27; contents and used for optimistic locking. The
1646 # fingerprint is initially generated by Compute Engine and changes after
1647 # every request to modify or update tags. You must always provide an
1648 # up-to-date fingerprint hash in order to update or change tags.
1649 #
1650 # To see the latest fingerprint, make get() request to the
1651 # instance.
1652 &quot;items&quot;: [ # An array of tags. Each tag must be 1-63 characters long, and comply
1653 # with RFC1035.
1654 &quot;A String&quot;,
1655 ],
1656 },
1657 &quot;workloadIdentityConfig&quot;: {
1658 &quot;identity&quot;: &quot;A String&quot;,
1659 &quot;identityCertificateEnabled&quot;: True or False,
1660 },
1661 },
1662 &quot;locationPolicy&quot;: { # Configuration for location policy among multiple possible locations # Policy for choosing target zone. For more information, seeCreate VMs in
1663 # bulk.
1664 # (e.g. preferences for zone selection among zones in a single region).
1665 &quot;locations&quot;: { # Location configurations mapped by location name.
1666 # Currently only zone names are supported and must be represented as valid
1667 # internal URLs, such as zones/us-central1-a.
1668 # The bulkInsert operation doesn&#x27;t create instances in an AI zone, even if
1669 # an AI zone is available in the specified region. For example, if you set a
1670 # DENY preference for us-central1-a, Compute Engine will consider
1671 # us-central1-b and us-central1-c for instance creation, but not
1672 # us-central1-ai1a. Also, you can&#x27;t use the locations[] configuration to
1673 # allow instance creation in an AI zone. To include an AI zone in bulkInsert
1674 # operations, use the locationPolicy.zones[] field.
1675 &quot;a_key&quot;: {
1676 &quot;constraints&quot;: { # Per-zone constraints on location policy for this zone. # Constraints that the caller requires on the result distribution
1677 # in this zone.
1678 &quot;maxCount&quot;: 42, # Maximum number of items that are allowed to be placed in this zone.
1679 # The value must be non-negative.
1680 },
1681 &quot;names&quot;: [ # Names of resources to be put in the location.
1682 # Must contain unique, correct resource names.
1683 # If used, targetShape must be left unset.
1684 &quot;A String&quot;,
1685 ],
1686 &quot;preference&quot;: &quot;A String&quot;, # Preference for a given location. Set to either ALLOW orDENY.
1687 },
1688 },
1689 &quot;targetShape&quot;: &quot;A String&quot;, # Strategy for distributing VMs across zones in a region.
1690 &quot;zones&quot;: [ # The bulkInsert operation applies any preferences set in the locations
1691 # field to the specific zones listed in the zones field if the same zones
1692 # are specified in both fields.
1693 {
1694 &quot;zone&quot;: &quot;A String&quot;, # The URL of the zone.
1695 # The zone must exist in the region where the request is called.
1696 # Zones must be represented as valid partial URLs,
1697 # such as zones/us-central1-a.
1698 },
1699 ],
1700 },
1701 &quot;minCount&quot;: &quot;A String&quot;, # The minimum number of instances to create. If no min_count is
1702 # specified then count is used as the default value. Ifmin_count instances cannot be created, then no instances will
1703 # be created and instances already created will be deleted.
1704 &quot;namePattern&quot;: &quot;A String&quot;, # The string pattern used for the names of the VMs.
1705 # Either name_pattern or per_instance_properties
1706 # must be set. The pattern must contain one continuous sequence of
1707 # placeholder hash characters (#) with each character corresponding to one
1708 # digit of the generated instance name. Example: a name_pattern
1709 # of inst-#### generates instance names such asinst-0001 and inst-0002. If existing instances
1710 # in the same project and zone have names that match the name pattern
1711 # then the generated instance numbers start after the biggest
1712 # 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
1713 # placeholder #...# can contain up to 18 characters.
1714 &quot;perInstanceProperties&quot;: { # Per-instance properties to be set on individual instances.
1715 # Keys of this map specify requested instance names.
1716 # Can be empty if name_pattern is used.
1717 &quot;a_key&quot;: { # Per-instance properties to be set on individual instances.
1718 # To be extended in the future.
1719 &quot;hostname&quot;: &quot;A String&quot;, # Specifies the hostname of the instance. More details in:
1720 # https://cloud.google.com/compute/docs/instances/custom-hostname-vm#naming_convention
1721 &quot;name&quot;: &quot;A String&quot;, # Output only. This field is only temporary. It will be removed. Do not use it.
1722 },
1723 },
1724 &quot;sourceInstanceTemplate&quot;: &quot;A String&quot;, # Specifies the instance template from which to create instances. You may
1725 # combine sourceInstanceTemplate withinstanceProperties to override specific values from an
1726 # existing instance template. Bulk API follows the semantics of JSON Merge
1727 # Patch described by RFC
1728 # 7396.
1729 #
1730 # It can be a full or partial URL. For example, the following are
1731 # all valid URLs to an instance template:
1732 #
1733 #
1734 # - https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate
1735 # - projects/project/global/instanceTemplates/instanceTemplate
1736 # - global/instanceTemplates/instanceTemplate
1737 #
1738 #
1739 #
1740 # This field is optional.
1741 }
1742
1743 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1744 that if you must retry your request, the server will know to ignore the
1745 request if it has already been completed.
1746
1747 For example, consider a situation where you make an initial request and
1748 the request times out. If you make the request again with the same
1749 request ID, the server can check if original operation with the same
1750 request ID was received, and if so, will ignore the second request. This
1751 prevents clients from accidentally creating duplicate commitments.
1752
1753 The request ID must be
1754 a valid UUID with the exception that zero UUID is not supported
1755 (00000000-0000-0000-0000-000000000000).
1756 x__xgafv: string, V1 error format.
1757 Allowed values
1758 1 - v1 error format
1759 2 - v2 error format
1760
1761 Returns:
1762 An object of the form:
1763
1764 { # Represents an Operation resource.
1765 #
1766 # Google Compute Engine has three Operation resources:
1767 #
1768 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
1769 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
1770 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
1771 #
1772 # You can use an operation resource to manage asynchronous API requests.
1773 # For more information, readHandling
1774 # API responses.
1775 #
1776 # Operations can be global, regional or zonal.
1777 #
1778 # - For global operations, use the `globalOperations`
1779 # resource.
1780 # - For regional operations, use the
1781 # `regionOperations` resource.
1782 # - For zonal operations, use
1783 # the `zoneOperations` resource.
1784 #
1785 #
1786 #
1787 # For more information, read
1788 # Global, Regional, and Zonal Resources.
1789 #
1790 # Note that completed Operation resources have a limited
1791 # retention period.
1792 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1793 # Not present otherwise.
1794 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1795 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1796 # set when the operation is created.
1797 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1798 # text format.
1799 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1800 # this field will be populated.
1801 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1802 # operation.
1803 {
1804 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1805 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1806 # details. There is a set of defined message types to use for providing
1807 # details.The syntax depends on the error code. For example,
1808 # QuotaExceededInfo will have details when the error code is
1809 # QUOTA_EXCEEDED.
1810 {
1811 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1812 #
1813 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1814 # is not enabled:
1815 #
1816 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1817 # &quot;domain&quot;: &quot;googleapis.com&quot;
1818 # &quot;metadata&quot;: {
1819 # &quot;resource&quot;: &quot;projects/123&quot;,
1820 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1821 # }
1822 # }
1823 #
1824 # This response indicates that the pubsub.googleapis.com API is not enabled.
1825 #
1826 # Example of an error that is returned when attempting to create a Spanner
1827 # instance in a region that is out of stock:
1828 #
1829 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1830 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1831 # &quot;metadata&quot;: {
1832 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1833 # }
1834 # }
1835 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1836 # is typically the registered service name of the tool or product that
1837 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1838 # generated by some common infrastructure, the error domain must be a
1839 # globally unique value that identifies the infrastructure. For Google API
1840 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1841 &quot;metadatas&quot;: { # Additional structured details about this error.
1842 #
1843 # Keys must match a regular expression of `a-z+` but should
1844 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1845 # length. When identifying the current value of an exceeded limit, the units
1846 # should be contained in the key, not the value. For example, rather than
1847 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1848 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1849 # instances that can be created in a single (batch) request.
1850 &quot;a_key&quot;: &quot;A String&quot;,
1851 },
1852 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1853 # proximate cause of the error. Error reasons are unique within a particular
1854 # domain of errors. This should be at most 63 characters and match a
1855 # regular expression of `A-Z+[A-Z0-9]`, which represents
1856 # UPPER_SNAKE_CASE.
1857 },
1858 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1859 #
1860 # For example, if a quota check failed with an error indicating the calling
1861 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1862 # directly to the right place in the developer console to flip the bit.
1863 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1864 { # Describes a URL link.
1865 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1866 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1867 },
1868 ],
1869 },
1870 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1871 # which can be attached to an RPC error.
1872 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1873 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1874 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1875 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1876 },
1877 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1878 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1879 &quot;a_key&quot;: &quot;A String&quot;,
1880 },
1881 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1882 # type or metric.
1883 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1884 # or metric.
1885 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1886 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1887 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1888 },
1889 },
1890 ],
1891 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1892 # This property is optional.
1893 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1894 },
1895 ],
1896 },
1897 &quot;getVersionOperationMetadata&quot;: {
1898 &quot;inlineSbomInfo&quot;: {
1899 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1900 # appropriate identifiers.
1901 &quot;a_key&quot;: &quot;A String&quot;,
1902 },
1903 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1904 # identifiers.
1905 &quot;a_key&quot;: &quot;A String&quot;,
1906 },
1907 },
1908 },
1909 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1910 # message that was returned, such as `NOT FOUND`.
1911 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1912 # status code that was returned. For example, a `404` means the
1913 # resource was not found.
1914 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1915 # defined by the server.
1916 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1917 # This value is inRFC3339
1918 # text format.
1919 &quot;instancesBulkInsertOperationMetadata&quot;: {
1920 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1921 # Example key: zones/us-central1-a
1922 &quot;a_key&quot;: {
1923 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1924 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1925 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1926 # error.
1927 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1928 # if the flow is rolling forward or rolling back.
1929 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1930 },
1931 },
1932 },
1933 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1934 # Operation resources.
1935 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1936 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1937 # group of operations results from a `bulkInsert` API request.
1938 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1939 # `update`, or `delete`, and so on.
1940 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1941 # There is no requirement that this be linear or support any granularity of
1942 # operations. This should not be used to guess when the operation will be
1943 # complete. This number should monotonically increase as the operation
1944 # progresses.
1945 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1946 # applicable when performing regional operations.
1947 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1948 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1949 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1950 # this field will contain information on all underlying zonal actions and
1951 # their state.
1952 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1953 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1954 # Example key: zones/us-central1-a
1955 &quot;a_key&quot;: {
1956 &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
1957 # populated.
1958 # different programming environments, including REST APIs and RPC APIs. It is
1959 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1960 # three pieces of data: error code, error message, and error details.
1961 #
1962 # You can find out more about this error model and how to work with it in the
1963 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1964 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1965 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1966 # message types for APIs to use.
1967 {
1968 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1969 },
1970 ],
1971 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1972 # user-facing error message should be localized and sent in the
1973 # google.rpc.Status.details field, or localized by the client.
1974 },
1975 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1976 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1977 },
1978 },
1979 },
1980 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1981 # This value is inRFC3339
1982 # text format.
1983 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1984 # following:
1985 # `PENDING`, `RUNNING`, or `DONE`.
1986 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1987 # operation.
1988 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1989 # of the target resource.
1990 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1991 # operations related to creating a snapshot, this points to the disk
1992 # that the snapshot was created from.
1993 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1994 # `[email protected]` or
1995 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1996 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1997 # operation, this field will be populated.
1998 {
1999 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2000 # Engine returns NO_RESULTS_ON_PAGE if there
2001 # are no results in the response.
2002 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2003 # value format. For example:
2004 #
2005 # &quot;data&quot;: [
2006 # {
2007 # &quot;key&quot;: &quot;scope&quot;,
2008 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2009 # }
2010 {
2011 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2012 # returned. For example, for warnings where there are no results in a list
2013 # request for a particular zone, this key might be scope and
2014 # the key value might be the zone name. Other examples might be a key
2015 # indicating a deprecated resource and a suggested replacement, or a
2016 # warning about invalid network settings (for example, if an instance
2017 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2018 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2019 },
2020 ],
2021 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2022 },
2023 ],
2024 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2025 # applicable when performing per-zone operations.
2026 }</pre>
2027 </div>
2028
2029 <div class="method">
2030 <code class="details" id="close">close()</code>
2031 <pre>Close httplib2 connections.</pre>
2032 </div>
2033
2034 </body></html>