Debian Codegraph @

docs/dyn/compute_beta.instanceTemplates.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="compute_beta.html">Compute Engine API</a> . <a href="compute_beta.instanceTemplates.html">instanceTemplates</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)</a></code></p>
79 <p class="firstline">Retrieves the list of all InstanceTemplates resources, regional and global,</p>
80 <p class="toc_element">
81 <code><a href="#aggregatedList_next">aggregatedList_next()</a></code></p>
82 <p class="firstline">Retrieves the next page of results.</p>
83 <p class="toc_element">
84 <code><a href="#close">close()</a></code></p>
85 <p class="firstline">Close httplib2 connections.</p>
86 <p class="toc_element">
87 <code><a href="#delete">delete(project, instanceTemplate, requestId=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Deletes the specified instance template. Deleting an instance template is</p>
89 <p class="toc_element">
90 <code><a href="#get">get(project, instanceTemplate, view=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Returns the specified instance template.</p>
92 <p class="toc_element">
93 <code><a href="#getIamPolicy">getIamPolicy(project, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Gets the access control policy for a resource. May be empty if no such</p>
95 <p class="toc_element">
96 <code><a href="#insert">insert(project, body=None, requestId=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Creates an instance template in the specified project using the</p>
98 <p class="toc_element">
99 <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, view=None, x__xgafv=None)</a></code></p>
100 <p class="firstline">Retrieves a list of instance templates that are contained within</p>
101 <p class="toc_element">
102 <code><a href="#list_next">list_next()</a></code></p>
103 <p class="firstline">Retrieves the next page of results.</p>
104 <p class="toc_element">
105 <code><a href="#setIamPolicy">setIamPolicy(project, resource, body=None, x__xgafv=None)</a></code></p>
106 <p class="firstline">Sets the access control policy on the specified resource.</p>
107 <p class="toc_element">
108 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</a></code></p>
109 <p class="firstline">Returns permissions that a caller has on the specified resource.</p>
110 <h3>Method Details</h3>
111 <div class="method">
112 <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)</code>
113 <pre>Retrieves the list of all InstanceTemplates resources, regional and global,
114 available to the specified project.
115
116 To prevent failure, Google recommends that you set the
117 `returnPartialSuccess` parameter to `true`.
118
119 Args:
120 project: string, Name of the project scoping this request. (required)
121 filter: string, A filter expression that filters resources listed in the response. Most
122 Compute resources support two types of filter expressions:
123 expressions that support regular expressions and expressions that follow
124 API improvement proposal AIP-160.
125 These two types of filter expressions cannot be mixed in one request.
126
127 If you want to use AIP-160, your expression must specify the field name, an
128 operator, and the value that you want to use for filtering. The value
129 must be a string, a number, or a boolean. The operator
130 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
131
132 For example, if you are filtering Compute Engine instances, you can
133 exclude instances named `example-instance` by specifying
134 `name != example-instance`.
135
136 The `:*` comparison can be used to test whether a key has been defined.
137 For example, to find all objects with `owner` label use:
138 ```
139 labels.owner:*
140 ```
141
142 You can also filter nested fields. For example, you could specify
143 `scheduling.automaticRestart = false` to include instances only
144 if they are not scheduled for automatic restarts. You can use filtering
145 on nested fields to filter based onresource labels.
146
147 To filter on multiple expressions, provide each separate expression within
148 parentheses. For example:
149 ```
150 (scheduling.automaticRestart = true)
151 (cpuPlatform = &quot;Intel Skylake&quot;)
152 ```
153 By default, each expression is an `AND` expression. However, you
154 can include `AND` and `OR` expressions explicitly.
155 For example:
156 ```
157 (cpuPlatform = &quot;Intel Skylake&quot;) OR
158 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
159 (scheduling.automaticRestart = true)
160 ```
161
162 If you want to use a regular expression, use the `eq` (equal) or `ne`
163 (not equal) operator against a single un-parenthesized expression with or
164 without quotes or against multiple parenthesized expressions. Examples:
165
166 `fieldname eq unquoted literal`
167 `fieldname eq &#x27;single quoted literal&#x27;`
168 `fieldname eq &quot;double quoted literal&quot;`
169 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
170
171 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
172 The literal value must match the entire field.
173
174 For example, to filter for instances that do not end with name &quot;instance&quot;,
175 you would use `name ne .*instance`.
176
177 You cannot combine constraints on multiple fields using regular
178 expressions.
179 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region,
180 global) should be included in the response. For new resource types added
181 after this field, the flag has no effect as new resource types will always
182 include every visible scope for each scope type in response. For resource
183 types which predate this field, if this flag is omitted or false, only
184 scopes of the scope types where the resource type is expected to be found
185 will be included.
186 maxResults: integer, The maximum number of results per page that should be returned.
187 If the number of available results is larger than `maxResults`,
188 Compute Engine returns a `nextPageToken` that can be used to get
189 the next page of results in subsequent list requests. Acceptable values are
190 `0` to `500`, inclusive. (Default: `500`)
191 orderBy: string, Sorts list results by a certain order. By default, results
192 are returned in alphanumerical order based on the resource name.
193
194 You can also sort results in descending order based on the creation
195 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
196 results based on the `creationTimestamp` field in
197 reverse chronological order (newest result first). Use this to sort
198 resources like operations so that the newest operation is returned first.
199
200 Currently, only sorting by `name` or
201 `creationTimestamp desc` is supported.
202 pageToken: string, Specifies a page token to use. Set `pageToken` to the
203 `nextPageToken` returned by a previous list request to get
204 the next page of results.
205 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
206 of failure. The default value is false.
207
208 For example, when partial success behavior is enabled, aggregatedList for a
209 single zone scope either returns all resources in the zone or no resources,
210 with an error code.
211 serviceProjectNumber: string, The Shared VPC service project id or service project number for which
212 aggregated list request is invoked for subnetworks list-usable api.
213 x__xgafv: string, V1 error format.
214 Allowed values
215 1 - v1 error format
216 2 - v2 error format
217
218 Returns:
219 An object of the form:
220
221 { # Contains a list of InstanceTemplatesScopedList.
222 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
223 &quot;items&quot;: { # A list of InstanceTemplatesScopedList resources.
224 &quot;a_key&quot;: { # The name of the scope that contains this set of instance templates.
225 &quot;instanceTemplates&quot;: [ # [Output Only] A list of instance templates that are contained within
226 # the specified project and zone.
227 { # Represents an Instance Template resource.
228 #
229 # Google Compute Engine has two Instance Template resources:
230 #
231 # * [Global](/compute/docs/reference/rest/beta/instanceTemplates)
232 # * [Regional](/compute/docs/reference/rest/beta/regionInstanceTemplates)
233 #
234 # You can reuse a global instance template in
235 # different regions whereas you can use a regional instance template in a
236 # specified region only. If you want to reduce cross-region dependency or
237 # achieve data residency, use a regional instance template.
238 #
239 # To create VMs, managed instance groups, and reservations, you can use either
240 # global or regional instance templates.
241 #
242 # For more information, readInstance Templates.
243 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] The creation timestamp for this instance template inRFC3339
244 # text format.
245 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
246 # create the resource.
247 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] A unique identifier for this instance template. The server
248 # defines this identifier.
249 &quot;kind&quot;: &quot;compute#instanceTemplate&quot;, # Output only. [Output Only] The resource type, which is alwayscompute#instanceTemplate for instance templates.
250 &quot;name&quot;: &quot;A String&quot;, # Name of the resource; provided by the client when the resource is created.
251 # The name must be 1-63 characters long, and comply withRFC1035.
252 # Specifically, the name must be 1-63 characters long and match the regular
253 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
254 # character must be a lowercase letter, and all following characters must be
255 # a dash, lowercase letter, or digit, except the last character, which cannot
256 # be a dash.
257 &quot;properties&quot;: { # The instance properties for this instance template.
258 &quot;advancedMachineFeatures&quot;: { # Specifies options for controlling advanced machine features. # Controls for advanced machine-related behavior features.
259 # Note that for MachineImage, this is not supported yet.
260 # Options that would traditionally be configured in a BIOS belong
261 # here. Features that require operating system support may have
262 # corresponding entries in the GuestOsFeatures of anImage (e.g., whether or not the OS in theImage supports nested virtualization being enabled or
263 # disabled).
264 &quot;enableNestedVirtualization&quot;: True or False, # Whether to enable nested virtualization or not (default is false).
265 &quot;enableUefiNetworking&quot;: True or False, # Whether to enable UEFI networking for instance creation.
266 &quot;performanceMonitoringUnit&quot;: &quot;A String&quot;, # Type of Performance Monitoring Unit requested on instance.
267 &quot;threadsPerCore&quot;: 42, # The number of threads per physical core. To disable simultaneous
268 # multithreading (SMT) set this to 1. If unset, the maximum number
269 # of threads supported per core by the underlying processor is
270 # assumed.
271 &quot;turboMode&quot;: &quot;A String&quot;, # Turbo frequency mode to use for the instance.
272 # Supported modes include:
273 # * ALL_CORE_MAX
274 #
275 # Using empty string or not setting this field will use the platform-specific
276 # default turbo mode.
277 &quot;visibleCoreCount&quot;: 42, # The number of physical cores to expose to an instance. Multiply by
278 # the number of threads per core to compute the total number of virtual
279 # CPUs to expose to the instance. If unset, the number of cores is
280 # inferred from the instance&#x27;s nominal CPU count and the underlying
281 # platform&#x27;s SMT width.
282 },
283 &quot;canIpForward&quot;: True or False, # Enables instances created based on these properties to send packets with
284 # source IP addresses other than their own and receive packets with
285 # destination IP addresses other than their own. If these instances will be
286 # used as an IP gateway or it will be set as the next-hop in a Route
287 # resource, specify true. If unsure, leave this set tofalse. See theEnable IP forwarding
288 # documentation for more information.
289 &quot;confidentialInstanceConfig&quot;: { # A set of Confidential Instance options. # Specifies the Confidential Instance options.
290 # Note that for MachineImage, this is not supported yet.
291 &quot;confidentialInstanceType&quot;: &quot;A String&quot;, # Defines the type of technology used by the confidential instance.
292 &quot;enableConfidentialCompute&quot;: True or False, # Defines whether the instance should have confidential compute enabled.
293 },
294 &quot;description&quot;: &quot;A String&quot;, # An optional text description for the instances that are created from these
295 # properties.
296 &quot;disks&quot;: [ # An array of disks that are associated with the instances that are created
297 # from these properties.
298 { # An instance-attached disk resource.
299 &quot;architecture&quot;: &quot;A String&quot;, # Output only. [Output Only] The architecture of the attached disk. Valid values are ARM64
300 # or X86_64.
301 &quot;autoDelete&quot;: True or False, # Specifies whether the disk will be auto-deleted when the instance is
302 # deleted (but not when the disk is detached from the instance).
303 &quot;boot&quot;: True or False, # Indicates that this is a boot disk. The virtual machine will use the first
304 # partition of the disk for its root filesystem.
305 &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
306 # running within the instance. This name can be used to reference the device
307 # for mounting, resizing, and so on, from within the instance.
308 #
309 # If not specified, the server chooses a default device name to apply to this
310 # disk, in the form persistent-disk-x, where x is a number
311 # assigned by Google Compute Engine. This field is only applicable for
312 # persistent disks.
313 &quot;diskEncryptionKey&quot;: { # Encrypts or decrypts a disk using acustomer-supplied
314 # encryption key.
315 #
316 # If you are creating a new disk, this field encrypts the new disk using
317 # an encryption key that you provide. If you are attaching an existing
318 # disk that is already encrypted, this field decrypts the disk using
319 # the customer-supplied encryption key.
320 #
321 # If you encrypt a disk using a customer-supplied key, you must provide the
322 # same key again when you attempt to use this resource at a later time. For
323 # example, you must provide the key when you create a snapshot or an image
324 # from the disk or when you attach the disk to a virtual machine instance.
325 #
326 # If you do not provide an encryption key, then the disk will be encrypted
327 # using an automatically generated key and you do not need to provide a key
328 # to use the disk later.
329 #
330 # Note:
331 #
332 # Instance templates do not storecustomer-supplied
333 # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
334 #
335 # You cannot create VMs that have disks with customer-supplied keys using
336 # the bulk
337 # insert method.
338 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
339 # For example:
340 #
341 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
342 # key_region/cryptoKeys/key
343 #
344 # The fully-qualifed key name may be returned for resource GET requests. For
345 # example:
346 #
347 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
348 # key_region/cryptoKeys/key
349 # /cryptoKeyVersions/1
350 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
351 # key. If absent, the Compute Engine default service account is used.
352 # For example:
353 #
354 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
355 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
356 # encryption key, encoded in RFC
357 # 4648 base64 to either encrypt or decrypt this resource. You can
358 # provide either the rawKey or thersaEncryptedKey.
359 # For example:
360 #
361 # &quot;rawKey&quot;:
362 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
363 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
364 # customer-supplied encryption key to either encrypt or decrypt this
365 # resource. You can provide either the rawKey or thersaEncryptedKey.
366 # For example:
367 #
368 # &quot;rsaEncryptedKey&quot;:
369 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
370 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
371 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
372 #
373 # The key must meet the following requirements before you can provide it to
374 # Compute Engine:
375 #
376 # 1. The key is wrapped using a RSA public key certificate provided by
377 # Google.
378 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
379 # encoding.
380 #
381 # Gets the RSA public key certificate provided by Google at:
382 #
383 #
384 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
385 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
386 # 4648 base64 encoded SHA-256 hash of the customer-supplied
387 # encryption key that protects this resource.
388 },
389 &quot;diskSizeGb&quot;: &quot;A String&quot;, # The size of the disk in GB.
390 &quot;forceAttach&quot;: True or False, # [Input Only] Whether to force attach the regional disk even if it&#x27;s
391 # currently attached to another instance. If you try to force attach a zonal
392 # disk to an instance, you will receive an error.
393 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
394 # only for bootable images. Read
395 # Enabling guest operating system features to see a list of available
396 # options.
397 { # Guest OS features.
398 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
399 # separate values. Set to one or more of the following values:
400 #
401 # - VIRTIO_SCSI_MULTIQUEUE
402 # - WINDOWS
403 # - MULTI_IP_SUBNET
404 # - UEFI_COMPATIBLE
405 # - GVNIC
406 # - SEV_CAPABLE
407 # - SUSPEND_RESUME_COMPATIBLE
408 # - SEV_LIVE_MIGRATABLE_V2
409 # - SEV_SNP_CAPABLE
410 # - TDX_CAPABLE
411 # - IDPF
412 # - SNP_SVSM_CAPABLE
413 # - CCA_CAPABLE
414 #
415 #
416 # For more information, see
417 # Enabling guest operating system features.
418 },
419 ],
420 &quot;index&quot;: 42, # Output only. [Output Only] A zero-based index to this disk, where 0 is reserved for the
421 # boot disk. If you have many disks attached to an instance, each
422 # disk would have a unique index number.
423 &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
424 # alongside the new instance. Use initialization parameters to create boot
425 # disks or local SSDs attached to the new instance.
426 #
427 # This property is mutually exclusive with the source property;
428 # you can only define one or the other, but not both.
429 # alongside the new instance. Use initialization parameters to create boot
430 # disks or local SSDs attached to the new instance.
431 #
432 # This field is persisted and returned for instanceTemplate and not returned
433 # in the context of instance.
434 #
435 # This property is mutually exclusive with the source property;
436 # you can only define one or the other, but not both.
437 &quot;architecture&quot;: &quot;A String&quot;, # The architecture of the attached disk. Valid values are
438 # arm64 or x86_64.
439 &quot;description&quot;: &quot;A String&quot;, # An optional description. Provide this property when creating the disk.
440 &quot;diskName&quot;: &quot;A String&quot;, # Specifies the disk name. If not specified, the default is to use the name
441 # of the instance. If a disk with the same name already exists in the given
442 # region, the existing disk is attached to the new instance and the
443 # new disk is not created.
444 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB. The size must be at least
445 # 10 GB. If you specify a sourceImage, which is required for
446 # boot disks, the default size is the size of the sourceImage.
447 # If you do not specify a sourceImage, the default disk size
448 # is 500 GB.
449 &quot;diskType&quot;: &quot;A String&quot;,
450 &quot;enableConfidentialCompute&quot;: True or False, # Whether this disk is using confidential compute mode.
451 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
452 # only for bootable images. Read
453 # Enabling guest operating system features to see a list of available
454 # options.
455 #
456 # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
457 { # Guest OS features.
458 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
459 # separate values. Set to one or more of the following values:
460 #
461 # - VIRTIO_SCSI_MULTIQUEUE
462 # - WINDOWS
463 # - MULTI_IP_SUBNET
464 # - UEFI_COMPATIBLE
465 # - GVNIC
466 # - SEV_CAPABLE
467 # - SUSPEND_RESUME_COMPATIBLE
468 # - SEV_LIVE_MIGRATABLE_V2
469 # - SEV_SNP_CAPABLE
470 # - TDX_CAPABLE
471 # - IDPF
472 # - SNP_SVSM_CAPABLE
473 # - CCA_CAPABLE
474 #
475 #
476 # For more information, see
477 # Enabling guest operating system features.
478 },
479 ],
480 &quot;labels&quot;: { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
481 # persistent disks.
482 &quot;a_key&quot;: &quot;A String&quot;,
483 },
484 &quot;licenses&quot;: [ # A list of publicly visible licenses. Reserved for Google&#x27;s use.
485 &quot;A String&quot;,
486 ],
487 &quot;multiWriter&quot;: True or False, # Indicates whether or not the disk can be read/write attached to
488 # more than one instance.
489 &quot;onUpdateAction&quot;: &quot;A String&quot;, # Specifies which action to take on instance update with this disk. Default
490 # is to use the existing disk.
491 &quot;provisionedIops&quot;: &quot;A String&quot;, # Indicates how many IOPS to provision for the disk. This sets the number
492 # of I/O operations per second that the disk can handle. Values must be
493 # between 10,000 and 120,000. For more details, see theExtreme persistent
494 # disk documentation.
495 &quot;provisionedThroughput&quot;: &quot;A String&quot;, # Indicates how much throughput to provision for the disk. This sets the
496 # number of throughput mb per second that the disk can handle. Values must
497 # greater than or equal to 1.
498 &quot;replicaZones&quot;: [ # Required for each regional disk associated with the instance. Specify
499 # the URLs of the zones where the disk should be replicated to.
500 # You must provide exactly two replica zones, and one zone must be the same
501 # as the instance zone.
502 &quot;A String&quot;,
503 ],
504 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
505 # have the same definition as resource
506 # manager tags. Keys and values can be either in numeric format,
507 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
508 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
509 # `{tag_value_short_name}`. The field is ignored (both PUT &amp; PATCH) when
510 # empty.
511 &quot;a_key&quot;: &quot;A String&quot;,
512 },
513 &quot;resourcePolicies&quot;: [ # Resource policies applied to this disk for automatic snapshot creations.
514 # Specified using the full or partial URL. For instance template, specify
515 # only the resource policy name.
516 &quot;A String&quot;,
517 ],
518 &quot;sourceImage&quot;: &quot;A String&quot;, # The source image to create this disk. When creating a new instance boot
519 # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
520 # is required.
521 #
522 # To create a disk with one of the public operating system
523 # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
524 #
525 # projects/debian-cloud/global/images/family/debian-9
526 #
527 #
528 # Alternatively, use a specific version of a public operating system image:
529 #
530 # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
531 #
532 #
533 # To create a disk with a custom image that you created, specify the
534 # image name in the following format:
535 #
536 # global/images/my-custom-image
537 #
538 #
539 # You can also specify a custom image by its image family, which returns
540 # the latest version of the image in that family. Replace the image name
541 # with family/family-name:
542 #
543 # global/images/family/my-image-family
544 #
545 #
546 # If the source image is deleted later, this field will not be set.
547 &quot;sourceImageEncryptionKey&quot;: { # Thecustomer-supplied
548 # encryption key of the source image. Required if the source image is
549 # protected by a customer-supplied encryption key.
550 #
551 # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
552 # encryption keys, so you cannot create disks for instances in a managed instance group if the
553 # source images are encrypted with your own keys.
554 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
555 # For example:
556 #
557 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
558 # key_region/cryptoKeys/key
559 #
560 # The fully-qualifed key name may be returned for resource GET requests. For
561 # example:
562 #
563 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
564 # key_region/cryptoKeys/key
565 # /cryptoKeyVersions/1
566 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
567 # key. If absent, the Compute Engine default service account is used.
568 # For example:
569 #
570 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
571 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
572 # encryption key, encoded in RFC
573 # 4648 base64 to either encrypt or decrypt this resource. You can
574 # provide either the rawKey or thersaEncryptedKey.
575 # For example:
576 #
577 # &quot;rawKey&quot;:
578 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
579 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
580 # customer-supplied encryption key to either encrypt or decrypt this
581 # resource. You can provide either the rawKey or thersaEncryptedKey.
582 # For example:
583 #
584 # &quot;rsaEncryptedKey&quot;:
585 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
586 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
587 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
588 #
589 # The key must meet the following requirements before you can provide it to
590 # Compute Engine:
591 #
592 # 1. The key is wrapped using a RSA public key certificate provided by
593 # Google.
594 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
595 # encoding.
596 #
597 # Gets the RSA public key certificate provided by Google at:
598 #
599 #
600 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
601 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
602 # 4648 base64 encoded SHA-256 hash of the customer-supplied
603 # encryption key that protects this resource.
604 },
605 &quot;sourceInstantSnapshot&quot;: &quot;A String&quot;, # The source instant-snapshot to create this disk. When creating a new
606 # instance boot disk, one of initializeParams.sourceSnapshot
607 # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
608 # is required.
609 #
610 # To create a disk with a snapshot that you created, specify the
611 # snapshot name in the following format:
612 #
613 # us-central1-a/instantSnapshots/my-backup
614 #
615 #
616 # If the source instant-snapshot is deleted later, this field will not be
617 # set.
618 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # The source snapshot to create this disk. When creating a new instance
619 # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
620 # is required.
621 #
622 # To create a disk with a snapshot that you created, specify the
623 # snapshot name in the following format:
624 #
625 # global/snapshots/my-backup
626 #
627 #
628 # If the source snapshot is deleted later, this field will not be set.
629 #
630 # Note: You cannot create VMs in bulk using a snapshot as the source. Use
631 # an image instead when you create VMs using
632 # the bulk
633 # insert method.
634 &quot;sourceSnapshotEncryptionKey&quot;: { # Thecustomer-supplied
635 # encryption key of the source snapshot.
636 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
637 # For example:
638 #
639 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
640 # key_region/cryptoKeys/key
641 #
642 # The fully-qualifed key name may be returned for resource GET requests. For
643 # example:
644 #
645 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
646 # key_region/cryptoKeys/key
647 # /cryptoKeyVersions/1
648 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
649 # key. If absent, the Compute Engine default service account is used.
650 # For example:
651 #
652 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
653 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
654 # encryption key, encoded in RFC
655 # 4648 base64 to either encrypt or decrypt this resource. You can
656 # provide either the rawKey or thersaEncryptedKey.
657 # For example:
658 #
659 # &quot;rawKey&quot;:
660 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
661 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
662 # customer-supplied encryption key to either encrypt or decrypt this
663 # resource. You can provide either the rawKey or thersaEncryptedKey.
664 # For example:
665 #
666 # &quot;rsaEncryptedKey&quot;:
667 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
668 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
669 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
670 #
671 # The key must meet the following requirements before you can provide it to
672 # Compute Engine:
673 #
674 # 1. The key is wrapped using a RSA public key certificate provided by
675 # Google.
676 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
677 # encoding.
678 #
679 # Gets the RSA public key certificate provided by Google at:
680 #
681 #
682 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
683 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
684 # 4648 base64 encoded SHA-256 hash of the customer-supplied
685 # encryption key that protects this resource.
686 },
687 &quot;storagePool&quot;: &quot;A String&quot;, # The storage pool in which the new disk is created. You can provide
688 # this as a partial or full URL to the resource. For example, the following
689 # are valid values:
690 #
691 #
692 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
693 # - projects/project/zones/zone/storagePools/storagePool
694 # - zones/zone/storagePools/storagePool
695 },
696 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is
697 # either SCSI or NVME. For most machine types, the
698 # default is SCSI. Local SSDs can use either NVME or SCSI.
699 # In certain configurations, persistent disks can use NVMe. For more
700 # information, seeAbout
701 # persistent disks.
702 &quot;kind&quot;: &quot;compute#attachedDisk&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
703 &quot;licenses&quot;: [ # Output only. [Output Only] Any valid publicly visible licenses.
704 &quot;A String&quot;,
705 ],
706 &quot;locked&quot;: True or False, # Output only. [Output Only] Whether to indicate the attached disk is locked. The locked
707 # disk is not allowed to be detached from the instance, or to be used as the
708 # source of the snapshot creation, and the image creation. The instance with
709 # at least one locked attached disk is not allow to be used as source of
710 # machine image creation, instant snapshot creation, and not allowed to be
711 # deleted with --keep-disk parameter set to true for locked disks.
712 &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
713 # in READ_WRITE mode.
714 &quot;savedState&quot;: &quot;A String&quot;, # Output only. For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
715 # field is set to PRESERVED if the LocalSSD data has been saved
716 # to a persistent location by customer request. (see the
717 # discard_local_ssd option on Stop/Suspend).
718 # Read-only in the api.
719 &quot;shieldedInstanceInitialState&quot;: { # Initial State for shielded instance, # Output only. [Output Only] shielded vm initial state stored on disk
720 # these are public keys which are safe to store in public
721 &quot;dbs&quot;: [ # The Key Database (db).
722 {
723 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
724 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
725 },
726 ],
727 &quot;dbxs&quot;: [ # The forbidden key database (dbx).
728 {
729 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
730 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
731 },
732 ],
733 &quot;keks&quot;: [ # The Key Exchange Key (KEK).
734 {
735 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
736 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
737 },
738 ],
739 &quot;pk&quot;: { # The Platform Key (PK).
740 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
741 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
742 },
743 },
744 &quot;source&quot;: &quot;A String&quot;, # Specifies a valid partial or full URL to an existing Persistent Disk
745 # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
746 # is required.
747 #
748 # If desired, you can also attach existing non-root persistent disks using
749 # this property. This field is only applicable for persistent disks.
750 #
751 # Note that for InstanceTemplate, specify the disk name for zonal disk,
752 # and the URL for regional disk.
753 &quot;type&quot;: &quot;A String&quot;, # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
754 },
755 ],
756 &quot;displayDevice&quot;: { # A set of Display Device options # Display Device properties to enable support
757 # for remote display products like: Teradici,
758 # VNC and TeamViewer
759 # Note that for MachineImage, this is not supported yet.
760 &quot;enableDisplay&quot;: True or False, # Defines whether the instance has Display enabled.
761 },
762 &quot;guestAccelerators&quot;: [ # A list of guest accelerator cards&#x27; type and count to use for instances
763 # created from these properties.
764 { # A specification of the type and number of accelerator cards attached to the
765 # instance.
766 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
767 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this
768 # instance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100
769 # If you are creating an instance template, specify only the
770 # accelerator name.
771 # See GPUs on Compute Engine
772 # for a full list of accelerator types.
773 },
774 ],
775 &quot;keyRevocationActionType&quot;: &quot;A String&quot;, # KeyRevocationActionType of the instance. Supported options are &quot;STOP&quot; and
776 # &quot;NONE&quot;. The default value is &quot;NONE&quot; if it is not specified.
777 &quot;labels&quot;: { # Labels to apply to instances that are created from these properties.
778 &quot;a_key&quot;: &quot;A String&quot;,
779 },
780 &quot;machineType&quot;: &quot;A String&quot;, # The machine type to use for instances that are created from these
781 # properties.
782 # This field only accepts a machine type name, for example `n2-standard-4`.
783 # If you use the machine type full or partial URL, for example
784 # `projects/my-l7ilb-project/zones/us-central1-a/machineTypes/n2-standard-4`,
785 # the request will result in an `INTERNAL_ERROR`.
786 &quot;metadata&quot;: { # A metadata key/value entry. # The metadata key/value pairs to assign to instances that are created from
787 # these properties. These pairs can consist of custom metadata or predefined
788 # keys. SeeProject and
789 # instance metadata for more information.
790 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
791 # the metadata&#x27;s contents and used for optimistic locking. The
792 # fingerprint is initially generated by Compute Engine and changes after
793 # every request to modify or update metadata. You must always provide an
794 # up-to-date fingerprint hash in order to update or change metadata,
795 # otherwise the request will fail with error412 conditionNotMet.
796 #
797 # To see the latest fingerprint, make a get() request to
798 # retrieve the resource.
799 &quot;items&quot;: [ # Array of key/value pairs. The total size of all keys and values must be
800 # less than 512 KB.
801 { # Metadata
802 &quot;key&quot;: &quot;A String&quot;, # Key for the metadata entry. Keys must conform to the following
803 # regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length.
804 # This is reflected as part of a URL in the metadata server. Additionally, to
805 # avoid ambiguity, keys must not conflict with any other metadata keys
806 # for the project.
807 &quot;value&quot;: &quot;A String&quot;, # Value for the metadata entry. These are free-form strings, and only
808 # have meaning as interpreted by the image running in the instance. The
809 # only restriction placed on values is that their size must be less than
810 # or equal to 262144 bytes (256 KiB).
811 },
812 ],
813 &quot;kind&quot;: &quot;compute#metadata&quot;, # Output only. [Output Only] Type of the resource. Always compute#metadata
814 # for metadata.
815 },
816 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Minimum cpu/platform to be used by instances. The instance may be
817 # scheduled on the specified or newer cpu/platform. Applicable values are the
818 # friendly names of CPU platforms, such asminCpuPlatform: &quot;Intel Haswell&quot; orminCpuPlatform: &quot;Intel Sandy Bridge&quot;. For more
819 # information, read Specifying a
820 # Minimum CPU Platform.
821 &quot;networkInterfaces&quot;: [ # An array of network access configurations for this interface.
822 { # A network interface resource attached to an instance.
823 &quot;accessConfigs&quot;: [ # An array of configurations for this interface. Currently, only one access
824 # config, ONE_TO_ONE_NAT, is supported. If there are noaccessConfigs specified, then this instance will have
825 # no external internet access.
826 { # An access configuration attached to an instance&#x27;s network interface.
827 # Only one access config per instance is supported.
828 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
829 # The first IPv6 address of the external IPv6 range associated
830 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
831 # use a static external IP address, it must be unused and in the same region
832 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
833 # assign an external IPv6 address from the instance&#x27;s subnetwork.
834 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
835 # external IPv6 range.
836 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
837 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
838 # (IPv4), the default and recommended name is External NAT, but
839 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
840 # recommend name is External IPv6.
841 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
842 # address associated with this instance. Specify an unused static
843 # external IP address available to the project or leave this field undefined
844 # to use an IP from a shared ephemeral IP address pool. If you specify a
845 # static external IP address, it must live in the same region as the zone of
846 # the instance.
847 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
848 # configuration and can only take the following values: PREMIUM,STANDARD.
849 #
850 # If an AccessConfig is specified without a valid external IP address, an
851 # ephemeral IP will be created with this networkTier.
852 #
853 # If an AccessConfig with a valid external IP address is specified, it must
854 # match that of the networkTier associated with the Address resource owning
855 # that IP.
856 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
857 #
858 # 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
859 # first IP in associated external IPv6 range.
860 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
861 # config.
862 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
863 # external IP address of the instance to a DNS domain name.
864 #
865 # This field is not used in ipv6AccessConfig. A default PTR
866 # record will be created if the VM has external IPv6 range associated.
867 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
868 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
869 },
870 ],
871 &quot;aliasIpRanges&quot;: [ # An array of alias IP ranges for this network interface.
872 # You can only specify this field for network interfaces in VPC networks.
873 { # An alias IP range attached to an instance&#x27;s network interface.
874 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
875 # must belong to the specified subnetwork and cannot contain IP addresses
876 # reserved by system or used by other network interfaces. This range may be
877 # 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).
878 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
879 # alias range. If not specified, the primary range of the subnetwork is used.
880 },
881 ],
882 &quot;aliasIpv6Ranges&quot;: [ # An array of alias IPv6 ranges for this network interface.
883 # You can only specify this field for network interfaces in VPC networks.
884 { # An alias IP range attached to an instance&#x27;s network interface.
885 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
886 # must belong to the specified subnetwork and cannot contain IP addresses
887 # reserved by system or used by other network interfaces. This range may be
888 # 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).
889 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
890 # alias range. If not specified, the primary range of the subnetwork is used.
891 },
892 ],
893 &quot;enableVpcScopedDns&quot;: True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
894 # with network_attachment.
895 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint hash of contents stored in this network interface.
896 # This field will be ignored when inserting an Instance or
897 # adding a NetworkInterface. An up-to-date
898 # 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.
899 &quot;igmpQuery&quot;: &quot;A String&quot;, # Indicate whether igmp query is enabled on the network interface
900 # or not. If enabled, also indicates the version of IGMP supported.
901 &quot;internalIpv6PrefixLength&quot;: 42, # The prefix length of the primary internal IPv6 range.
902 &quot;ipv6AccessConfigs&quot;: [ # An array of IPv6 access configurations for this interface. Currently, only
903 # one IPv6 access config, DIRECT_IPV6, is supported. If there
904 # is no ipv6AccessConfig specified, then this instance will
905 # have no external IPv6 Internet access.
906 { # An access configuration attached to an instance&#x27;s network interface.
907 # Only one access config per instance is supported.
908 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
909 # The first IPv6 address of the external IPv6 range associated
910 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
911 # use a static external IP address, it must be unused and in the same region
912 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
913 # assign an external IPv6 address from the instance&#x27;s subnetwork.
914 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
915 # external IPv6 range.
916 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
917 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
918 # (IPv4), the default and recommended name is External NAT, but
919 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
920 # recommend name is External IPv6.
921 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
922 # address associated with this instance. Specify an unused static
923 # external IP address available to the project or leave this field undefined
924 # to use an IP from a shared ephemeral IP address pool. If you specify a
925 # static external IP address, it must live in the same region as the zone of
926 # the instance.
927 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
928 # configuration and can only take the following values: PREMIUM,STANDARD.
929 #
930 # If an AccessConfig is specified without a valid external IP address, an
931 # ephemeral IP will be created with this networkTier.
932 #
933 # If an AccessConfig with a valid external IP address is specified, it must
934 # match that of the networkTier associated with the Address resource owning
935 # that IP.
936 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
937 #
938 # 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
939 # first IP in associated external IPv6 range.
940 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
941 # config.
942 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
943 # external IP address of the instance to a DNS domain name.
944 #
945 # This field is not used in ipv6AccessConfig. A default PTR
946 # record will be created if the VM has external IPv6 range associated.
947 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
948 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
949 },
950 ],
951 &quot;ipv6AccessType&quot;: &quot;A String&quot;, # Output only. [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be
952 # accessed from the Internet. This field is always inherited from its
953 # subnetwork.
954 #
955 # Valid only if stackType is IPV4_IPV6.
956 &quot;ipv6Address&quot;: &quot;A String&quot;, # An IPv6 internal network address for this network interface. To
957 # use a static internal IP address, it must be unused and in the same region
958 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
959 # assign an internal IPv6 address from the instance&#x27;s subnetwork.
960 &quot;kind&quot;: &quot;compute#networkInterface&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#networkInterface for network interfaces.
961 &quot;macAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] MAC address assigned to this network interface.
962 &quot;name&quot;: &quot;A String&quot;, # [Output Only] The name of the network interface, which is generated by the
963 # server. For a VM, the network interface uses the nicN naming
964 # format. Where N is a value between 0 and7. The default interface value is nic0.
965 &quot;network&quot;: &quot;A String&quot;, # URL of the VPC network resource for this instance. When creating an
966 # instance, if neither the network nor the subnetwork is specified, the
967 # default network global/networks/default is used. If the
968 # selected project doesn&#x27;t have the default network, you must specify a
969 # network or subnet. If the network is not specified but the subnetwork is
970 # specified, the network is inferred.
971 #
972 # If you specify this property, you can specify the network as
973 # a full or partial URL. For example, the following are all valid URLs:
974 #
975 #
976 # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
977 # - projects/project/global/networks/network
978 # - global/networks/default
979 &quot;networkAttachment&quot;: &quot;A String&quot;, # The URL of the network attachment that this interface should connect
980 # to in the following format:
981 # projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.
982 &quot;networkIP&quot;: &quot;A String&quot;, # An IPv4 internal IP address to assign to the instance for this network
983 # interface. If not specified by the user, an unused internal IP is
984 # assigned by the system.
985 &quot;nicType&quot;: &quot;A String&quot;, # The type of vNIC to be used on this interface. This may be gVNIC or
986 # VirtioNet.
987 &quot;parentNicName&quot;: &quot;A String&quot;, # Name of the parent network interface of a dynamic network interface.
988 &quot;queueCount&quot;: 42, # The networking queue count that&#x27;s specified by users for the network
989 # interface. Both Rx and Tx queues will be set to this number. It&#x27;ll be empty
990 # if not specified by the users.
991 &quot;serviceClassId&quot;: &quot;A String&quot;, # Optional. Producer Service&#x27;s Service class Id for the region of this network
992 # interface. Can only be used with network_attachment. It is not possible to
993 # use on its own however, network_attachment can be used without
994 # service_class_id.
995 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for this network interface. To assign only IPv4 addresses,
996 # use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, useIPV4_IPV6. If not specified, IPV4_ONLY is used.
997 #
998 # This field can be both set at instance creation and update network
999 # interface operations.
1000 &quot;subnetwork&quot;: &quot;A String&quot;, # The URL of the Subnetwork resource for this instance. If the network
1001 # resource is inlegacy
1002 # mode, do not specify this field. If the network is in auto subnet
1003 # mode, specifying the subnetwork is optional. If the network is in custom
1004 # subnet mode, specifying the subnetwork is required. If you specify this
1005 # field, you can specify the subnetwork as a full or partial URL. For
1006 # example, the following are all valid URLs:
1007 #
1008 #
1009 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
1010 # - regions/region/subnetworks/subnetwork
1011 &quot;vlan&quot;: 42, # VLAN tag of a dynamic network interface, must be an integer in the range
1012 # from 2 to 255 inclusively.
1013 },
1014 ],
1015 &quot;networkPerformanceConfig&quot;: { # Note that for MachineImage, this is not supported yet.
1016 &quot;totalEgressBandwidthTier&quot;: &quot;A String&quot;,
1017 },
1018 &quot;partnerMetadata&quot;: { # Partner Metadata assigned to the instance properties. A map from a
1019 # subdomain (namespace) to entries map.
1020 &quot;a_key&quot;: {
1021 &quot;entries&quot;: { # Map of a partner metadata that belong to the same subdomain.
1022 # It accepts any value including google.protobuf.Struct.
1023 &quot;a_key&quot;: &quot;&quot;,
1024 },
1025 },
1026 },
1027 &quot;postKeyRevocationActionType&quot;: &quot;A String&quot;, # PostKeyRevocationActionType of the instance.
1028 &quot;privateIpv6GoogleAccess&quot;: &quot;A String&quot;, # The private IPv6 google access type for VMs.
1029 # If not specified, use INHERIT_FROM_SUBNETWORK as default.
1030 # Note that for MachineImage, this is not supported yet.
1031 &quot;reservationAffinity&quot;: { # Specifies the reservations that this instance can consume from. # Specifies the reservations that instances can consume from.
1032 # Note that for MachineImage, this is not supported yet.
1033 &quot;consumeReservationType&quot;: &quot;A String&quot;, # Specifies the type of reservation from which this instance can consume
1034 # resources: ANY_RESERVATION (default),SPECIFIC_RESERVATION, or NO_RESERVATION. See
1035 # Consuming reserved instances for examples.
1036 &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
1037 # the name of your reservation as its value.
1038 &quot;values&quot;: [ # Corresponds to the label values of a reservation resource. This can be
1039 # either a name to a reservation in the same project or
1040 # &quot;projects/different-project/reservations/some-reservation-name&quot; to target a
1041 # shared reservation in the same zone but in a different project.
1042 &quot;A String&quot;,
1043 ],
1044 },
1045 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the instance. Tag keys and values
1046 # have the same definition as resource
1047 # manager tags. Keys and values can be either in numeric format,
1048 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
1049 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
1050 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
1051 # PATCH) when empty.
1052 &quot;a_key&quot;: &quot;A String&quot;,
1053 },
1054 &quot;resourcePolicies&quot;: [ # Resource policies (names, not URLs) applied to instances created from
1055 # these properties.
1056 # Note that for MachineImage, this is not supported yet.
1057 &quot;A String&quot;,
1058 ],
1059 &quot;scheduling&quot;: { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from
1060 # these properties.
1061 &quot;automaticRestart&quot;: True or False, # Specifies whether the instance should be automatically restarted if it is
1062 # terminated by Compute Engine (not terminated by a user). You can only set
1063 # the automatic restart option for standard instances.Preemptible instances
1064 # cannot be automatically restarted.
1065 #
1066 # By default, this is set to true so an instance is
1067 # automatically restarted if it is terminated by Compute Engine.
1068 &quot;availabilityDomain&quot;: 42, # Specifies the availability domain to place the instance in. The value
1069 # must be a number between 1 and the number of availability domains
1070 # specified in the spread placement policy attached to the instance.
1071 &quot;gracefulShutdown&quot;: { # The configuration for gracefully shutting down the instance.
1072 &quot;enabled&quot;: True or False, # Opts-in for graceful shutdown.
1073 &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
1074 # graceful shutdown isn&#x27;t complete after this time, then the instance
1075 # transitions to the STOPPING state.
1076 # as a count of seconds and fractions of seconds at nanosecond
1077 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
1078 # or &quot;month&quot;. Range is approximately 10,000 years.
1079 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
1080 # Durations less than one second are represented with a 0
1081 # `seconds` field and a positive `nanos` field. Must be from 0
1082 # to 999,999,999 inclusive.
1083 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
1084 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
1085 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
1086 },
1087 },
1088 &quot;hostErrorTimeoutSeconds&quot;: 42, # Specify the time in seconds for host error detection, the value must be
1089 # within the range of [90, 330] with the increment of 30, if unset, the
1090 # default behavior of host error recovery will be used.
1091 &quot;instanceTerminationAction&quot;: &quot;A String&quot;, # Specifies the termination action for the instance.
1092 &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
1093 # recovery of the Local Ssd state is attempted. Its value should be in
1094 # between 0 and 168 hours with hour granularity and the default value being 1
1095 # hour.
1096 # as a count of seconds and fractions of seconds at nanosecond
1097 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
1098 # or &quot;month&quot;. Range is approximately 10,000 years.
1099 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
1100 # Durations less than one second are represented with a 0
1101 # `seconds` field and a positive `nanos` field. Must be from 0
1102 # to 999,999,999 inclusive.
1103 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
1104 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
1105 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
1106 },
1107 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the instance close to other
1108 # resources.
1109 # This field is for use by internal tools that use the public API.
1110 &quot;maintenanceFreezeDurationHours&quot;: 42, # Specifies the number of hours after VM instance creation where the VM won&#x27;t
1111 # be scheduled for maintenance.
1112 &quot;maintenanceInterval&quot;: &quot;A String&quot;, # Specifies the frequency of planned maintenance events. The accepted values
1113 # are: `PERIODIC`.
1114 &quot;maxRunDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the max run duration for the given instance. If specified,
1115 # the instance termination action will be performed at the end of the run
1116 # duration.
1117 # as a count of seconds and fractions of seconds at nanosecond
1118 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
1119 # or &quot;month&quot;. Range is approximately 10,000 years.
1120 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
1121 # Durations less than one second are represented with a 0
1122 # `seconds` field and a positive `nanos` field. Must be from 0
1123 # to 999,999,999 inclusive.
1124 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
1125 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
1126 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
1127 },
1128 &quot;minNodeCpus&quot;: 42, # The minimum number of virtual CPUs this instance will consume when running
1129 # on a sole-tenant node.
1130 &quot;nodeAffinities&quot;: [ # A set of node affinity and anti-affinity configurations. Refer toConfiguring node
1131 # affinity for more information.
1132 # Overrides reservationAffinity.
1133 { # Node Affinity: the configuration of desired nodes onto which this Instance
1134 # could be scheduled.
1135 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of Node resource.
1136 &quot;operator&quot;: &quot;A String&quot;, # Defines the operation of node selection. Valid operators areIN for affinity and NOT_IN for anti-affinity.
1137 &quot;values&quot;: [ # Corresponds to the label values of Node resource.
1138 &quot;A String&quot;,
1139 ],
1140 },
1141 ],
1142 &quot;onHostMaintenance&quot;: &quot;A String&quot;, # Defines the maintenance behavior for this instance. For standard instances,
1143 # the default behavior is MIGRATE. Forpreemptible instances,
1144 # the default and only possible behavior is TERMINATE. For more
1145 # information, see
1146 # Set
1147 # VM host maintenance policy.
1148 &quot;onInstanceStopAction&quot;: { # Defines the behaviour for instances with the instance_termination_actionSTOP.
1149 &quot;discardLocalSsd&quot;: True or False, # If true, the contents of any attached Local SSD disks will be discarded
1150 # else, the Local SSD data will be preserved when the instance is stopped
1151 # at the end of the run duration/termination time.
1152 },
1153 &quot;preemptible&quot;: True or False, # Defines whether the instance is preemptible. This can only be set during
1154 # instance creation or while the instance isstopped and
1155 # therefore, in a `TERMINATED` state. SeeInstance Life
1156 # Cycle for more information on the possible instance states.
1157 &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
1158 # Off signal is triggered for Spot
1159 # VMs only. If not specified, there will be no wait before the G2 Soft
1160 # Off signal is triggered.
1161 # as a count of seconds and fractions of seconds at nanosecond
1162 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
1163 # or &quot;month&quot;. Range is approximately 10,000 years.
1164 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
1165 # Durations less than one second are represented with a 0
1166 # `seconds` field and a positive `nanos` field. Must be from 0
1167 # to 999,999,999 inclusive.
1168 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
1169 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
1170 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
1171 },
1172 &quot;provisioningModel&quot;: &quot;A String&quot;, # Specifies the provisioning model of the instance.
1173 &quot;skipGuestOsShutdown&quot;: True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
1174 # Off and ACPI G3 Mechanical
1175 # Off for Standard VMs and 30 seconds for Spot VMs.
1176 &quot;terminationTime&quot;: &quot;A String&quot;, # Specifies the timestamp, when the instance will be terminated, inRFC3339 text format. If specified, the instance
1177 # termination action will be performed at the termination time.
1178 },
1179 &quot;serviceAccounts&quot;: [ # A list of service accounts with specified scopes. Access tokens for these
1180 # service accounts are available to the instances that are created from
1181 # these properties. Use metadata queries to obtain the access tokens for
1182 # these instances.
1183 { # A service account.
1184 &quot;email&quot;: &quot;A String&quot;, # Email address of the service account.
1185 &quot;scopes&quot;: [ # The list of scopes to be made available for this service account.
1186 &quot;A String&quot;,
1187 ],
1188 },
1189 ],
1190 &quot;shieldedInstanceConfig&quot;: { # A set of Shielded Instance options. # Note that for MachineImage, this is not supported yet.
1191 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.Enabled by
1192 # default.
1193 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.Disabled by
1194 # default.
1195 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.Enabled by
1196 # default.
1197 },
1198 &quot;shieldedVmConfig&quot;: { # A set of Shielded VM options. # Specifies the Shielded VM options for the instances that are created from
1199 # these properties.
1200 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.
1201 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.
1202 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.
1203 },
1204 &quot;tags&quot;: { # A set of instance tags. # A list of tags to apply to the instances that are created from these
1205 # properties. The tags identify valid sources or targets for network
1206 # firewalls. The setTags method can modify this list of tags. Each tag within
1207 # the list must comply with RFC1035.
1208 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
1209 # the tags&#x27; contents and used for optimistic locking. The
1210 # fingerprint is initially generated by Compute Engine and changes after
1211 # every request to modify or update tags. You must always provide an
1212 # up-to-date fingerprint hash in order to update or change tags.
1213 #
1214 # To see the latest fingerprint, make get() request to the
1215 # instance.
1216 &quot;items&quot;: [ # An array of tags. Each tag must be 1-63 characters long, and comply
1217 # with RFC1035.
1218 &quot;A String&quot;,
1219 ],
1220 },
1221 &quot;workloadIdentityConfig&quot;: {
1222 &quot;identity&quot;: &quot;A String&quot;,
1223 &quot;identityCertificateEnabled&quot;: True or False,
1224 },
1225 },
1226 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the instance template resides. Only
1227 # applicable for regional resources.
1228 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL for this instance template. The server defines this
1229 # URL.
1230 &quot;sourceInstance&quot;: &quot;A String&quot;, # The source instance used to create the template. You can provide this as a
1231 # partial or full URL to the resource. For example, the following are valid
1232 # values:
1233 #
1234 #
1235 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
1236 # - projects/project/zones/zone/instances/instance
1237 &quot;sourceInstanceParams&quot;: { # A specification of the parameters to use when creating the instance template # The source instance params to use to create this instance template.
1238 # from a source instance.
1239 &quot;diskConfigs&quot;: [ # Attached disks configuration. If not provided, defaults are applied:
1240 # For boot disk and any other R/W disks, the source images for each disk
1241 # will be used. For read-only disks, they will be attached in read-only
1242 # mode. Local SSD disks will be created as blank volumes.
1243 { # A specification of the desired way to instantiate a disk in the instance
1244 # template when its created from a source instance.
1245 &quot;autoDelete&quot;: True or False, # Specifies whether the disk will be auto-deleted when the instance is
1246 # deleted (but not when the disk is detached from the instance).
1247 &quot;customImage&quot;: &quot;A String&quot;, # The custom source image to be used to restore this disk when instantiating
1248 # this instance template.
1249 &quot;deviceName&quot;: &quot;A String&quot;, # Specifies the device name of the disk to which the configurations apply to.
1250 &quot;instantiateFrom&quot;: &quot;A String&quot;, # Specifies whether to include the disk and what image to use. Possible
1251 # values are:
1252 #
1253 #
1254 # - source-image: to use the same image that was used to
1255 # create the source instance&#x27;s corresponding disk. Applicable to the boot
1256 # disk and additional read-write disks.
1257 # - source-image-family: to use the same image family that
1258 # was used to create the source instance&#x27;s corresponding disk. Applicable
1259 # to the boot disk and additional read-write disks.
1260 # - custom-image: to use a user-provided image url for disk
1261 # creation. Applicable to the boot disk and additional read-write
1262 # disks.
1263 # - attach-read-only: to attach a read-only
1264 # disk. Applicable to read-only disks.
1265 # - do-not-include: to exclude a disk from the template.
1266 # Applicable to additional read-write disks, local SSDs, and read-only
1267 # disks.
1268 },
1269 ],
1270 },
1271 },
1272 ],
1273 &quot;warning&quot;: { # [Output Only] An informational warning that replaces the list of instance
1274 # templates when the list is empty.
1275 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1276 # Engine returns NO_RESULTS_ON_PAGE if there
1277 # are no results in the response.
1278 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1279 # value format. For example:
1280 #
1281 # &quot;data&quot;: [
1282 # {
1283 # &quot;key&quot;: &quot;scope&quot;,
1284 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1285 # }
1286 {
1287 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1288 # returned. For example, for warnings where there are no results in a list
1289 # request for a particular zone, this key might be scope and
1290 # the key value might be the zone name. Other examples might be a key
1291 # indicating a deprecated resource and a suggested replacement, or a
1292 # warning about invalid network settings (for example, if an instance
1293 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1294 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1295 },
1296 ],
1297 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1298 },
1299 },
1300 },
1301 &quot;kind&quot;: &quot;compute#instanceTemplateAggregatedList&quot;, # Output only. Type of resource.
1302 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
1303 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
1304 # the query parameter pageToken in the next list request.
1305 # Subsequent list requests will have their own nextPageToken to
1306 # continue paging through the results.
1307 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
1308 &quot;warning&quot;: { # [Output Only] Informational warning message.
1309 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1310 # Engine returns NO_RESULTS_ON_PAGE if there
1311 # are no results in the response.
1312 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1313 # value format. For example:
1314 #
1315 # &quot;data&quot;: [
1316 # {
1317 # &quot;key&quot;: &quot;scope&quot;,
1318 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1319 # }
1320 {
1321 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1322 # returned. For example, for warnings where there are no results in a list
1323 # request for a particular zone, this key might be scope and
1324 # the key value might be the zone name. Other examples might be a key
1325 # indicating a deprecated resource and a suggested replacement, or a
1326 # warning about invalid network settings (for example, if an instance
1327 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1328 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1329 },
1330 ],
1331 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1332 },
1333 }</pre>
1334 </div>
1335
1336 <div class="method">
1337 <code class="details" id="aggregatedList_next">aggregatedList_next()</code>
1338 <pre>Retrieves the next page of results.
1339
1340 Args:
1341 previous_request: The request for the previous page. (required)
1342 previous_response: The response from the request for the previous page. (required)
1343
1344 Returns:
1345 A request object that you can call &#x27;execute()&#x27; on to request the next
1346 page. Returns None if there are no more items in the collection.
1347 </pre>
1348 </div>
1349
1350 <div class="method">
1351 <code class="details" id="close">close()</code>
1352 <pre>Close httplib2 connections.</pre>
1353 </div>
1354
1355 <div class="method">
1356 <code class="details" id="delete">delete(project, instanceTemplate, requestId=None, x__xgafv=None)</code>
1357 <pre>Deletes the specified instance template. Deleting an instance template is
1358 permanent and cannot be undone. It is not possible to delete templates
1359 that are already in use by a managed instance group.
1360
1361 Args:
1362 project: string, Project ID for this request. (required)
1363 instanceTemplate: string, The name of the instance template to delete. (required)
1364 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1365 that if you must retry your request, the server will know to ignore the
1366 request if it has already been completed.
1367
1368 For example, consider a situation where you make an initial request and
1369 the request times out. If you make the request again with the same
1370 request ID, the server can check if original operation with the same
1371 request ID was received, and if so, will ignore the second request. This
1372 prevents clients from accidentally creating duplicate commitments.
1373
1374 The request ID must be
1375 a valid UUID with the exception that zero UUID is not supported
1376 (00000000-0000-0000-0000-000000000000).
1377 x__xgafv: string, V1 error format.
1378 Allowed values
1379 1 - v1 error format
1380 2 - v2 error format
1381
1382 Returns:
1383 An object of the form:
1384
1385 { # Represents an Operation resource.
1386 #
1387 # Google Compute Engine has three Operation resources:
1388 #
1389 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
1390 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
1391 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
1392 #
1393 # You can use an operation resource to manage asynchronous API requests.
1394 # For more information, readHandling
1395 # API responses.
1396 #
1397 # Operations can be global, regional or zonal.
1398 #
1399 # - For global operations, use the `globalOperations`
1400 # resource.
1401 # - For regional operations, use the
1402 # `regionOperations` resource.
1403 # - For zonal operations, use
1404 # the `zoneOperations` resource.
1405 #
1406 #
1407 #
1408 # For more information, read
1409 # Global, Regional, and Zonal Resources.
1410 #
1411 # Note that completed Operation resources have a limited
1412 # retention period.
1413 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1414 # Not present otherwise.
1415 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1416 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1417 # set when the operation is created.
1418 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1419 # text format.
1420 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1421 # this field will be populated.
1422 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1423 # operation.
1424 {
1425 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1426 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1427 # details. There is a set of defined message types to use for providing
1428 # details.The syntax depends on the error code. For example,
1429 # QuotaExceededInfo will have details when the error code is
1430 # QUOTA_EXCEEDED.
1431 {
1432 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1433 #
1434 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1435 # is not enabled:
1436 #
1437 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1438 # &quot;domain&quot;: &quot;googleapis.com&quot;
1439 # &quot;metadata&quot;: {
1440 # &quot;resource&quot;: &quot;projects/123&quot;,
1441 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1442 # }
1443 # }
1444 #
1445 # This response indicates that the pubsub.googleapis.com API is not enabled.
1446 #
1447 # Example of an error that is returned when attempting to create a Spanner
1448 # instance in a region that is out of stock:
1449 #
1450 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1451 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1452 # &quot;metadata&quot;: {
1453 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1454 # }
1455 # }
1456 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1457 # is typically the registered service name of the tool or product that
1458 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1459 # generated by some common infrastructure, the error domain must be a
1460 # globally unique value that identifies the infrastructure. For Google API
1461 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1462 &quot;metadatas&quot;: { # Additional structured details about this error.
1463 #
1464 # Keys must match a regular expression of `a-z+` but should
1465 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1466 # length. When identifying the current value of an exceeded limit, the units
1467 # should be contained in the key, not the value. For example, rather than
1468 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1469 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1470 # instances that can be created in a single (batch) request.
1471 &quot;a_key&quot;: &quot;A String&quot;,
1472 },
1473 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1474 # proximate cause of the error. Error reasons are unique within a particular
1475 # domain of errors. This should be at most 63 characters and match a
1476 # regular expression of `A-Z+[A-Z0-9]`, which represents
1477 # UPPER_SNAKE_CASE.
1478 },
1479 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1480 #
1481 # For example, if a quota check failed with an error indicating the calling
1482 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1483 # directly to the right place in the developer console to flip the bit.
1484 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1485 { # Describes a URL link.
1486 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1487 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1488 },
1489 ],
1490 },
1491 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1492 # which can be attached to an RPC error.
1493 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1494 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1495 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1496 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1497 },
1498 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1499 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1500 &quot;a_key&quot;: &quot;A String&quot;,
1501 },
1502 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1503 # type or metric.
1504 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1505 # or metric.
1506 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1507 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1508 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1509 },
1510 },
1511 ],
1512 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1513 # This property is optional.
1514 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1515 },
1516 ],
1517 },
1518 &quot;getVersionOperationMetadata&quot;: {
1519 &quot;inlineSbomInfo&quot;: {
1520 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1521 # appropriate identifiers.
1522 &quot;a_key&quot;: &quot;A String&quot;,
1523 },
1524 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1525 # identifiers.
1526 &quot;a_key&quot;: &quot;A String&quot;,
1527 },
1528 },
1529 },
1530 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1531 # message that was returned, such as `NOT FOUND`.
1532 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1533 # status code that was returned. For example, a `404` means the
1534 # resource was not found.
1535 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1536 # defined by the server.
1537 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1538 # This value is inRFC3339
1539 # text format.
1540 &quot;instancesBulkInsertOperationMetadata&quot;: {
1541 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1542 # Example key: zones/us-central1-a
1543 &quot;a_key&quot;: {
1544 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1545 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1546 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1547 # error.
1548 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1549 # if the flow is rolling forward or rolling back.
1550 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1551 },
1552 },
1553 },
1554 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1555 # Operation resources.
1556 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1557 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1558 # group of operations results from a `bulkInsert` API request.
1559 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1560 # `update`, or `delete`, and so on.
1561 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1562 # There is no requirement that this be linear or support any granularity of
1563 # operations. This should not be used to guess when the operation will be
1564 # complete. This number should monotonically increase as the operation
1565 # progresses.
1566 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1567 # applicable when performing regional operations.
1568 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1569 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1570 # this field will contain information on all underlying zonal actions and
1571 # their state.
1572 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1573 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1574 # Example key: zones/us-central1-a
1575 &quot;a_key&quot;: {
1576 &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
1577 # populated.
1578 # different programming environments, including REST APIs and RPC APIs. It is
1579 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1580 # three pieces of data: error code, error message, and error details.
1581 #
1582 # You can find out more about this error model and how to work with it in the
1583 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1584 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1585 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1586 # message types for APIs to use.
1587 {
1588 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1589 },
1590 ],
1591 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1592 # user-facing error message should be localized and sent in the
1593 # google.rpc.Status.details field, or localized by the client.
1594 },
1595 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1596 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1597 },
1598 },
1599 },
1600 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1601 # This value is inRFC3339
1602 # text format.
1603 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1604 # following:
1605 # `PENDING`, `RUNNING`, or `DONE`.
1606 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1607 # operation.
1608 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1609 # of the target resource.
1610 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1611 # operations related to creating a snapshot, this points to the disk
1612 # that the snapshot was created from.
1613 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1614 # `[email protected]` or
1615 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1616 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1617 # operation, this field will be populated.
1618 {
1619 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1620 # Engine returns NO_RESULTS_ON_PAGE if there
1621 # are no results in the response.
1622 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1623 # value format. For example:
1624 #
1625 # &quot;data&quot;: [
1626 # {
1627 # &quot;key&quot;: &quot;scope&quot;,
1628 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1629 # }
1630 {
1631 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1632 # returned. For example, for warnings where there are no results in a list
1633 # request for a particular zone, this key might be scope and
1634 # the key value might be the zone name. Other examples might be a key
1635 # indicating a deprecated resource and a suggested replacement, or a
1636 # warning about invalid network settings (for example, if an instance
1637 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1638 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1639 },
1640 ],
1641 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1642 },
1643 ],
1644 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1645 # applicable when performing per-zone operations.
1646 }</pre>
1647 </div>
1648
1649 <div class="method">
1650 <code class="details" id="get">get(project, instanceTemplate, view=None, x__xgafv=None)</code>
1651 <pre>Returns the specified instance template.
1652
1653 Args:
1654 project: string, Project ID for this request. (required)
1655 instanceTemplate: string, The name of the instance template. (required)
1656 view: string, View of the instance template.
1657 Allowed values
1658 BASIC - Include everything except Partner Metadata.
1659 FULL - Include everything.
1660 INSTANCE_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view.
1661 x__xgafv: string, V1 error format.
1662 Allowed values
1663 1 - v1 error format
1664 2 - v2 error format
1665
1666 Returns:
1667 An object of the form:
1668
1669 { # Represents an Instance Template resource.
1670 #
1671 # Google Compute Engine has two Instance Template resources:
1672 #
1673 # * [Global](/compute/docs/reference/rest/beta/instanceTemplates)
1674 # * [Regional](/compute/docs/reference/rest/beta/regionInstanceTemplates)
1675 #
1676 # You can reuse a global instance template in
1677 # different regions whereas you can use a regional instance template in a
1678 # specified region only. If you want to reduce cross-region dependency or
1679 # achieve data residency, use a regional instance template.
1680 #
1681 # To create VMs, managed instance groups, and reservations, you can use either
1682 # global or regional instance templates.
1683 #
1684 # For more information, readInstance Templates.
1685 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] The creation timestamp for this instance template inRFC3339
1686 # text format.
1687 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1688 # create the resource.
1689 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] A unique identifier for this instance template. The server
1690 # defines this identifier.
1691 &quot;kind&quot;: &quot;compute#instanceTemplate&quot;, # Output only. [Output Only] The resource type, which is alwayscompute#instanceTemplate for instance templates.
1692 &quot;name&quot;: &quot;A String&quot;, # Name of the resource; provided by the client when the resource is created.
1693 # The name must be 1-63 characters long, and comply withRFC1035.
1694 # Specifically, the name must be 1-63 characters long and match the regular
1695 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1696 # character must be a lowercase letter, and all following characters must be
1697 # a dash, lowercase letter, or digit, except the last character, which cannot
1698 # be a dash.
1699 &quot;properties&quot;: { # The instance properties for this instance template.
1700 &quot;advancedMachineFeatures&quot;: { # Specifies options for controlling advanced machine features. # Controls for advanced machine-related behavior features.
1701 # Note that for MachineImage, this is not supported yet.
1702 # Options that would traditionally be configured in a BIOS belong
1703 # here. Features that require operating system support may have
1704 # corresponding entries in the GuestOsFeatures of anImage (e.g., whether or not the OS in theImage supports nested virtualization being enabled or
1705 # disabled).
1706 &quot;enableNestedVirtualization&quot;: True or False, # Whether to enable nested virtualization or not (default is false).
1707 &quot;enableUefiNetworking&quot;: True or False, # Whether to enable UEFI networking for instance creation.
1708 &quot;performanceMonitoringUnit&quot;: &quot;A String&quot;, # Type of Performance Monitoring Unit requested on instance.
1709 &quot;threadsPerCore&quot;: 42, # The number of threads per physical core. To disable simultaneous
1710 # multithreading (SMT) set this to 1. If unset, the maximum number
1711 # of threads supported per core by the underlying processor is
1712 # assumed.
1713 &quot;turboMode&quot;: &quot;A String&quot;, # Turbo frequency mode to use for the instance.
1714 # Supported modes include:
1715 # * ALL_CORE_MAX
1716 #
1717 # Using empty string or not setting this field will use the platform-specific
1718 # default turbo mode.
1719 &quot;visibleCoreCount&quot;: 42, # The number of physical cores to expose to an instance. Multiply by
1720 # the number of threads per core to compute the total number of virtual
1721 # CPUs to expose to the instance. If unset, the number of cores is
1722 # inferred from the instance&#x27;s nominal CPU count and the underlying
1723 # platform&#x27;s SMT width.
1724 },
1725 &quot;canIpForward&quot;: True or False, # Enables instances created based on these properties to send packets with
1726 # source IP addresses other than their own and receive packets with
1727 # destination IP addresses other than their own. If these instances will be
1728 # used as an IP gateway or it will be set as the next-hop in a Route
1729 # resource, specify true. If unsure, leave this set tofalse. See theEnable IP forwarding
1730 # documentation for more information.
1731 &quot;confidentialInstanceConfig&quot;: { # A set of Confidential Instance options. # Specifies the Confidential Instance options.
1732 # Note that for MachineImage, this is not supported yet.
1733 &quot;confidentialInstanceType&quot;: &quot;A String&quot;, # Defines the type of technology used by the confidential instance.
1734 &quot;enableConfidentialCompute&quot;: True or False, # Defines whether the instance should have confidential compute enabled.
1735 },
1736 &quot;description&quot;: &quot;A String&quot;, # An optional text description for the instances that are created from these
1737 # properties.
1738 &quot;disks&quot;: [ # An array of disks that are associated with the instances that are created
1739 # from these properties.
1740 { # An instance-attached disk resource.
1741 &quot;architecture&quot;: &quot;A String&quot;, # Output only. [Output Only] The architecture of the attached disk. Valid values are ARM64
1742 # or X86_64.
1743 &quot;autoDelete&quot;: True or False, # Specifies whether the disk will be auto-deleted when the instance is
1744 # deleted (but not when the disk is detached from the instance).
1745 &quot;boot&quot;: True or False, # Indicates that this is a boot disk. The virtual machine will use the first
1746 # partition of the disk for its root filesystem.
1747 &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
1748 # running within the instance. This name can be used to reference the device
1749 # for mounting, resizing, and so on, from within the instance.
1750 #
1751 # If not specified, the server chooses a default device name to apply to this
1752 # disk, in the form persistent-disk-x, where x is a number
1753 # assigned by Google Compute Engine. This field is only applicable for
1754 # persistent disks.
1755 &quot;diskEncryptionKey&quot;: { # Encrypts or decrypts a disk using acustomer-supplied
1756 # encryption key.
1757 #
1758 # If you are creating a new disk, this field encrypts the new disk using
1759 # an encryption key that you provide. If you are attaching an existing
1760 # disk that is already encrypted, this field decrypts the disk using
1761 # the customer-supplied encryption key.
1762 #
1763 # If you encrypt a disk using a customer-supplied key, you must provide the
1764 # same key again when you attempt to use this resource at a later time. For
1765 # example, you must provide the key when you create a snapshot or an image
1766 # from the disk or when you attach the disk to a virtual machine instance.
1767 #
1768 # If you do not provide an encryption key, then the disk will be encrypted
1769 # using an automatically generated key and you do not need to provide a key
1770 # to use the disk later.
1771 #
1772 # Note:
1773 #
1774 # Instance templates do not storecustomer-supplied
1775 # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
1776 #
1777 # You cannot create VMs that have disks with customer-supplied keys using
1778 # the bulk
1779 # insert method.
1780 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
1781 # For example:
1782 #
1783 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1784 # key_region/cryptoKeys/key
1785 #
1786 # The fully-qualifed key name may be returned for resource GET requests. For
1787 # example:
1788 #
1789 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1790 # key_region/cryptoKeys/key
1791 # /cryptoKeyVersions/1
1792 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
1793 # key. If absent, the Compute Engine default service account is used.
1794 # For example:
1795 #
1796 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
1797 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
1798 # encryption key, encoded in RFC
1799 # 4648 base64 to either encrypt or decrypt this resource. You can
1800 # provide either the rawKey or thersaEncryptedKey.
1801 # For example:
1802 #
1803 # &quot;rawKey&quot;:
1804 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
1805 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
1806 # customer-supplied encryption key to either encrypt or decrypt this
1807 # resource. You can provide either the rawKey or thersaEncryptedKey.
1808 # For example:
1809 #
1810 # &quot;rsaEncryptedKey&quot;:
1811 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
1812 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
1813 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
1814 #
1815 # The key must meet the following requirements before you can provide it to
1816 # Compute Engine:
1817 #
1818 # 1. The key is wrapped using a RSA public key certificate provided by
1819 # Google.
1820 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
1821 # encoding.
1822 #
1823 # Gets the RSA public key certificate provided by Google at:
1824 #
1825 #
1826 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
1827 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
1828 # 4648 base64 encoded SHA-256 hash of the customer-supplied
1829 # encryption key that protects this resource.
1830 },
1831 &quot;diskSizeGb&quot;: &quot;A String&quot;, # The size of the disk in GB.
1832 &quot;forceAttach&quot;: True or False, # [Input Only] Whether to force attach the regional disk even if it&#x27;s
1833 # currently attached to another instance. If you try to force attach a zonal
1834 # disk to an instance, you will receive an error.
1835 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
1836 # only for bootable images. Read
1837 # Enabling guest operating system features to see a list of available
1838 # options.
1839 { # Guest OS features.
1840 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
1841 # separate values. Set to one or more of the following values:
1842 #
1843 # - VIRTIO_SCSI_MULTIQUEUE
1844 # - WINDOWS
1845 # - MULTI_IP_SUBNET
1846 # - UEFI_COMPATIBLE
1847 # - GVNIC
1848 # - SEV_CAPABLE
1849 # - SUSPEND_RESUME_COMPATIBLE
1850 # - SEV_LIVE_MIGRATABLE_V2
1851 # - SEV_SNP_CAPABLE
1852 # - TDX_CAPABLE
1853 # - IDPF
1854 # - SNP_SVSM_CAPABLE
1855 # - CCA_CAPABLE
1856 #
1857 #
1858 # For more information, see
1859 # Enabling guest operating system features.
1860 },
1861 ],
1862 &quot;index&quot;: 42, # Output only. [Output Only] A zero-based index to this disk, where 0 is reserved for the
1863 # boot disk. If you have many disks attached to an instance, each
1864 # disk would have a unique index number.
1865 &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
1866 # alongside the new instance. Use initialization parameters to create boot
1867 # disks or local SSDs attached to the new instance.
1868 #
1869 # This property is mutually exclusive with the source property;
1870 # you can only define one or the other, but not both.
1871 # alongside the new instance. Use initialization parameters to create boot
1872 # disks or local SSDs attached to the new instance.
1873 #
1874 # This field is persisted and returned for instanceTemplate and not returned
1875 # in the context of instance.
1876 #
1877 # This property is mutually exclusive with the source property;
1878 # you can only define one or the other, but not both.
1879 &quot;architecture&quot;: &quot;A String&quot;, # The architecture of the attached disk. Valid values are
1880 # arm64 or x86_64.
1881 &quot;description&quot;: &quot;A String&quot;, # An optional description. Provide this property when creating the disk.
1882 &quot;diskName&quot;: &quot;A String&quot;, # Specifies the disk name. If not specified, the default is to use the name
1883 # of the instance. If a disk with the same name already exists in the given
1884 # region, the existing disk is attached to the new instance and the
1885 # new disk is not created.
1886 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB. The size must be at least
1887 # 10 GB. If you specify a sourceImage, which is required for
1888 # boot disks, the default size is the size of the sourceImage.
1889 # If you do not specify a sourceImage, the default disk size
1890 # is 500 GB.
1891 &quot;diskType&quot;: &quot;A String&quot;,
1892 &quot;enableConfidentialCompute&quot;: True or False, # Whether this disk is using confidential compute mode.
1893 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
1894 # only for bootable images. Read
1895 # Enabling guest operating system features to see a list of available
1896 # options.
1897 #
1898 # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
1899 { # Guest OS features.
1900 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
1901 # separate values. Set to one or more of the following values:
1902 #
1903 # - VIRTIO_SCSI_MULTIQUEUE
1904 # - WINDOWS
1905 # - MULTI_IP_SUBNET
1906 # - UEFI_COMPATIBLE
1907 # - GVNIC
1908 # - SEV_CAPABLE
1909 # - SUSPEND_RESUME_COMPATIBLE
1910 # - SEV_LIVE_MIGRATABLE_V2
1911 # - SEV_SNP_CAPABLE
1912 # - TDX_CAPABLE
1913 # - IDPF
1914 # - SNP_SVSM_CAPABLE
1915 # - CCA_CAPABLE
1916 #
1917 #
1918 # For more information, see
1919 # Enabling guest operating system features.
1920 },
1921 ],
1922 &quot;labels&quot;: { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
1923 # persistent disks.
1924 &quot;a_key&quot;: &quot;A String&quot;,
1925 },
1926 &quot;licenses&quot;: [ # A list of publicly visible licenses. Reserved for Google&#x27;s use.
1927 &quot;A String&quot;,
1928 ],
1929 &quot;multiWriter&quot;: True or False, # Indicates whether or not the disk can be read/write attached to
1930 # more than one instance.
1931 &quot;onUpdateAction&quot;: &quot;A String&quot;, # Specifies which action to take on instance update with this disk. Default
1932 # is to use the existing disk.
1933 &quot;provisionedIops&quot;: &quot;A String&quot;, # Indicates how many IOPS to provision for the disk. This sets the number
1934 # of I/O operations per second that the disk can handle. Values must be
1935 # between 10,000 and 120,000. For more details, see theExtreme persistent
1936 # disk documentation.
1937 &quot;provisionedThroughput&quot;: &quot;A String&quot;, # Indicates how much throughput to provision for the disk. This sets the
1938 # number of throughput mb per second that the disk can handle. Values must
1939 # greater than or equal to 1.
1940 &quot;replicaZones&quot;: [ # Required for each regional disk associated with the instance. Specify
1941 # the URLs of the zones where the disk should be replicated to.
1942 # You must provide exactly two replica zones, and one zone must be the same
1943 # as the instance zone.
1944 &quot;A String&quot;,
1945 ],
1946 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
1947 # have the same definition as resource
1948 # manager tags. Keys and values can be either in numeric format,
1949 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
1950 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
1951 # `{tag_value_short_name}`. The field is ignored (both PUT &amp; PATCH) when
1952 # empty.
1953 &quot;a_key&quot;: &quot;A String&quot;,
1954 },
1955 &quot;resourcePolicies&quot;: [ # Resource policies applied to this disk for automatic snapshot creations.
1956 # Specified using the full or partial URL. For instance template, specify
1957 # only the resource policy name.
1958 &quot;A String&quot;,
1959 ],
1960 &quot;sourceImage&quot;: &quot;A String&quot;, # The source image to create this disk. When creating a new instance boot
1961 # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
1962 # is required.
1963 #
1964 # To create a disk with one of the public operating system
1965 # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
1966 #
1967 # projects/debian-cloud/global/images/family/debian-9
1968 #
1969 #
1970 # Alternatively, use a specific version of a public operating system image:
1971 #
1972 # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
1973 #
1974 #
1975 # To create a disk with a custom image that you created, specify the
1976 # image name in the following format:
1977 #
1978 # global/images/my-custom-image
1979 #
1980 #
1981 # You can also specify a custom image by its image family, which returns
1982 # the latest version of the image in that family. Replace the image name
1983 # with family/family-name:
1984 #
1985 # global/images/family/my-image-family
1986 #
1987 #
1988 # If the source image is deleted later, this field will not be set.
1989 &quot;sourceImageEncryptionKey&quot;: { # Thecustomer-supplied
1990 # encryption key of the source image. Required if the source image is
1991 # protected by a customer-supplied encryption key.
1992 #
1993 # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
1994 # encryption keys, so you cannot create disks for instances in a managed instance group if the
1995 # source images are encrypted with your own keys.
1996 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
1997 # For example:
1998 #
1999 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2000 # key_region/cryptoKeys/key
2001 #
2002 # The fully-qualifed key name may be returned for resource GET requests. For
2003 # example:
2004 #
2005 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2006 # key_region/cryptoKeys/key
2007 # /cryptoKeyVersions/1
2008 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
2009 # key. If absent, the Compute Engine default service account is used.
2010 # For example:
2011 #
2012 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
2013 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
2014 # encryption key, encoded in RFC
2015 # 4648 base64 to either encrypt or decrypt this resource. You can
2016 # provide either the rawKey or thersaEncryptedKey.
2017 # For example:
2018 #
2019 # &quot;rawKey&quot;:
2020 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
2021 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
2022 # customer-supplied encryption key to either encrypt or decrypt this
2023 # resource. You can provide either the rawKey or thersaEncryptedKey.
2024 # For example:
2025 #
2026 # &quot;rsaEncryptedKey&quot;:
2027 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
2028 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
2029 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
2030 #
2031 # The key must meet the following requirements before you can provide it to
2032 # Compute Engine:
2033 #
2034 # 1. The key is wrapped using a RSA public key certificate provided by
2035 # Google.
2036 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
2037 # encoding.
2038 #
2039 # Gets the RSA public key certificate provided by Google at:
2040 #
2041 #
2042 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
2043 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
2044 # 4648 base64 encoded SHA-256 hash of the customer-supplied
2045 # encryption key that protects this resource.
2046 },
2047 &quot;sourceInstantSnapshot&quot;: &quot;A String&quot;, # The source instant-snapshot to create this disk. When creating a new
2048 # instance boot disk, one of initializeParams.sourceSnapshot
2049 # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
2050 # is required.
2051 #
2052 # To create a disk with a snapshot that you created, specify the
2053 # snapshot name in the following format:
2054 #
2055 # us-central1-a/instantSnapshots/my-backup
2056 #
2057 #
2058 # If the source instant-snapshot is deleted later, this field will not be
2059 # set.
2060 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # The source snapshot to create this disk. When creating a new instance
2061 # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
2062 # is required.
2063 #
2064 # To create a disk with a snapshot that you created, specify the
2065 # snapshot name in the following format:
2066 #
2067 # global/snapshots/my-backup
2068 #
2069 #
2070 # If the source snapshot is deleted later, this field will not be set.
2071 #
2072 # Note: You cannot create VMs in bulk using a snapshot as the source. Use
2073 # an image instead when you create VMs using
2074 # the bulk
2075 # insert method.
2076 &quot;sourceSnapshotEncryptionKey&quot;: { # Thecustomer-supplied
2077 # encryption key of the source snapshot.
2078 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
2079 # For example:
2080 #
2081 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2082 # key_region/cryptoKeys/key
2083 #
2084 # The fully-qualifed key name may be returned for resource GET requests. For
2085 # example:
2086 #
2087 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2088 # key_region/cryptoKeys/key
2089 # /cryptoKeyVersions/1
2090 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
2091 # key. If absent, the Compute Engine default service account is used.
2092 # For example:
2093 #
2094 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
2095 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
2096 # encryption key, encoded in RFC
2097 # 4648 base64 to either encrypt or decrypt this resource. You can
2098 # provide either the rawKey or thersaEncryptedKey.
2099 # For example:
2100 #
2101 # &quot;rawKey&quot;:
2102 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
2103 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
2104 # customer-supplied encryption key to either encrypt or decrypt this
2105 # resource. You can provide either the rawKey or thersaEncryptedKey.
2106 # For example:
2107 #
2108 # &quot;rsaEncryptedKey&quot;:
2109 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
2110 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
2111 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
2112 #
2113 # The key must meet the following requirements before you can provide it to
2114 # Compute Engine:
2115 #
2116 # 1. The key is wrapped using a RSA public key certificate provided by
2117 # Google.
2118 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
2119 # encoding.
2120 #
2121 # Gets the RSA public key certificate provided by Google at:
2122 #
2123 #
2124 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
2125 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
2126 # 4648 base64 encoded SHA-256 hash of the customer-supplied
2127 # encryption key that protects this resource.
2128 },
2129 &quot;storagePool&quot;: &quot;A String&quot;, # The storage pool in which the new disk is created. You can provide
2130 # this as a partial or full URL to the resource. For example, the following
2131 # are valid values:
2132 #
2133 #
2134 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
2135 # - projects/project/zones/zone/storagePools/storagePool
2136 # - zones/zone/storagePools/storagePool
2137 },
2138 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is
2139 # either SCSI or NVME. For most machine types, the
2140 # default is SCSI. Local SSDs can use either NVME or SCSI.
2141 # In certain configurations, persistent disks can use NVMe. For more
2142 # information, seeAbout
2143 # persistent disks.
2144 &quot;kind&quot;: &quot;compute#attachedDisk&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
2145 &quot;licenses&quot;: [ # Output only. [Output Only] Any valid publicly visible licenses.
2146 &quot;A String&quot;,
2147 ],
2148 &quot;locked&quot;: True or False, # Output only. [Output Only] Whether to indicate the attached disk is locked. The locked
2149 # disk is not allowed to be detached from the instance, or to be used as the
2150 # source of the snapshot creation, and the image creation. The instance with
2151 # at least one locked attached disk is not allow to be used as source of
2152 # machine image creation, instant snapshot creation, and not allowed to be
2153 # deleted with --keep-disk parameter set to true for locked disks.
2154 &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
2155 # in READ_WRITE mode.
2156 &quot;savedState&quot;: &quot;A String&quot;, # Output only. For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
2157 # field is set to PRESERVED if the LocalSSD data has been saved
2158 # to a persistent location by customer request. (see the
2159 # discard_local_ssd option on Stop/Suspend).
2160 # Read-only in the api.
2161 &quot;shieldedInstanceInitialState&quot;: { # Initial State for shielded instance, # Output only. [Output Only] shielded vm initial state stored on disk
2162 # these are public keys which are safe to store in public
2163 &quot;dbs&quot;: [ # The Key Database (db).
2164 {
2165 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
2166 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
2167 },
2168 ],
2169 &quot;dbxs&quot;: [ # The forbidden key database (dbx).
2170 {
2171 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
2172 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
2173 },
2174 ],
2175 &quot;keks&quot;: [ # The Key Exchange Key (KEK).
2176 {
2177 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
2178 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
2179 },
2180 ],
2181 &quot;pk&quot;: { # The Platform Key (PK).
2182 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
2183 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
2184 },
2185 },
2186 &quot;source&quot;: &quot;A String&quot;, # Specifies a valid partial or full URL to an existing Persistent Disk
2187 # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
2188 # is required.
2189 #
2190 # If desired, you can also attach existing non-root persistent disks using
2191 # this property. This field is only applicable for persistent disks.
2192 #
2193 # Note that for InstanceTemplate, specify the disk name for zonal disk,
2194 # and the URL for regional disk.
2195 &quot;type&quot;: &quot;A String&quot;, # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
2196 },
2197 ],
2198 &quot;displayDevice&quot;: { # A set of Display Device options # Display Device properties to enable support
2199 # for remote display products like: Teradici,
2200 # VNC and TeamViewer
2201 # Note that for MachineImage, this is not supported yet.
2202 &quot;enableDisplay&quot;: True or False, # Defines whether the instance has Display enabled.
2203 },
2204 &quot;guestAccelerators&quot;: [ # A list of guest accelerator cards&#x27; type and count to use for instances
2205 # created from these properties.
2206 { # A specification of the type and number of accelerator cards attached to the
2207 # instance.
2208 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
2209 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this
2210 # instance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100
2211 # If you are creating an instance template, specify only the
2212 # accelerator name.
2213 # See GPUs on Compute Engine
2214 # for a full list of accelerator types.
2215 },
2216 ],
2217 &quot;keyRevocationActionType&quot;: &quot;A String&quot;, # KeyRevocationActionType of the instance. Supported options are &quot;STOP&quot; and
2218 # &quot;NONE&quot;. The default value is &quot;NONE&quot; if it is not specified.
2219 &quot;labels&quot;: { # Labels to apply to instances that are created from these properties.
2220 &quot;a_key&quot;: &quot;A String&quot;,
2221 },
2222 &quot;machineType&quot;: &quot;A String&quot;, # The machine type to use for instances that are created from these
2223 # properties.
2224 # This field only accepts a machine type name, for example `n2-standard-4`.
2225 # If you use the machine type full or partial URL, for example
2226 # `projects/my-l7ilb-project/zones/us-central1-a/machineTypes/n2-standard-4`,
2227 # the request will result in an `INTERNAL_ERROR`.
2228 &quot;metadata&quot;: { # A metadata key/value entry. # The metadata key/value pairs to assign to instances that are created from
2229 # these properties. These pairs can consist of custom metadata or predefined
2230 # keys. SeeProject and
2231 # instance metadata for more information.
2232 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
2233 # the metadata&#x27;s contents and used for optimistic locking. The
2234 # fingerprint is initially generated by Compute Engine and changes after
2235 # every request to modify or update metadata. You must always provide an
2236 # up-to-date fingerprint hash in order to update or change metadata,
2237 # otherwise the request will fail with error412 conditionNotMet.
2238 #
2239 # To see the latest fingerprint, make a get() request to
2240 # retrieve the resource.
2241 &quot;items&quot;: [ # Array of key/value pairs. The total size of all keys and values must be
2242 # less than 512 KB.
2243 { # Metadata
2244 &quot;key&quot;: &quot;A String&quot;, # Key for the metadata entry. Keys must conform to the following
2245 # regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length.
2246 # This is reflected as part of a URL in the metadata server. Additionally, to
2247 # avoid ambiguity, keys must not conflict with any other metadata keys
2248 # for the project.
2249 &quot;value&quot;: &quot;A String&quot;, # Value for the metadata entry. These are free-form strings, and only
2250 # have meaning as interpreted by the image running in the instance. The
2251 # only restriction placed on values is that their size must be less than
2252 # or equal to 262144 bytes (256 KiB).
2253 },
2254 ],
2255 &quot;kind&quot;: &quot;compute#metadata&quot;, # Output only. [Output Only] Type of the resource. Always compute#metadata
2256 # for metadata.
2257 },
2258 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Minimum cpu/platform to be used by instances. The instance may be
2259 # scheduled on the specified or newer cpu/platform. Applicable values are the
2260 # friendly names of CPU platforms, such asminCpuPlatform: &quot;Intel Haswell&quot; orminCpuPlatform: &quot;Intel Sandy Bridge&quot;. For more
2261 # information, read Specifying a
2262 # Minimum CPU Platform.
2263 &quot;networkInterfaces&quot;: [ # An array of network access configurations for this interface.
2264 { # A network interface resource attached to an instance.
2265 &quot;accessConfigs&quot;: [ # An array of configurations for this interface. Currently, only one access
2266 # config, ONE_TO_ONE_NAT, is supported. If there are noaccessConfigs specified, then this instance will have
2267 # no external internet access.
2268 { # An access configuration attached to an instance&#x27;s network interface.
2269 # Only one access config per instance is supported.
2270 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
2271 # The first IPv6 address of the external IPv6 range associated
2272 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
2273 # use a static external IP address, it must be unused and in the same region
2274 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
2275 # assign an external IPv6 address from the instance&#x27;s subnetwork.
2276 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
2277 # external IPv6 range.
2278 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
2279 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
2280 # (IPv4), the default and recommended name is External NAT, but
2281 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
2282 # recommend name is External IPv6.
2283 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
2284 # address associated with this instance. Specify an unused static
2285 # external IP address available to the project or leave this field undefined
2286 # to use an IP from a shared ephemeral IP address pool. If you specify a
2287 # static external IP address, it must live in the same region as the zone of
2288 # the instance.
2289 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
2290 # configuration and can only take the following values: PREMIUM,STANDARD.
2291 #
2292 # If an AccessConfig is specified without a valid external IP address, an
2293 # ephemeral IP will be created with this networkTier.
2294 #
2295 # If an AccessConfig with a valid external IP address is specified, it must
2296 # match that of the networkTier associated with the Address resource owning
2297 # that IP.
2298 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
2299 #
2300 # 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
2301 # first IP in associated external IPv6 range.
2302 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
2303 # config.
2304 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
2305 # external IP address of the instance to a DNS domain name.
2306 #
2307 # This field is not used in ipv6AccessConfig. A default PTR
2308 # record will be created if the VM has external IPv6 range associated.
2309 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
2310 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
2311 },
2312 ],
2313 &quot;aliasIpRanges&quot;: [ # An array of alias IP ranges for this network interface.
2314 # You can only specify this field for network interfaces in VPC networks.
2315 { # An alias IP range attached to an instance&#x27;s network interface.
2316 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
2317 # must belong to the specified subnetwork and cannot contain IP addresses
2318 # reserved by system or used by other network interfaces. This range may be
2319 # 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).
2320 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
2321 # alias range. If not specified, the primary range of the subnetwork is used.
2322 },
2323 ],
2324 &quot;aliasIpv6Ranges&quot;: [ # An array of alias IPv6 ranges for this network interface.
2325 # You can only specify this field for network interfaces in VPC networks.
2326 { # An alias IP range attached to an instance&#x27;s network interface.
2327 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
2328 # must belong to the specified subnetwork and cannot contain IP addresses
2329 # reserved by system or used by other network interfaces. This range may be
2330 # 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).
2331 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
2332 # alias range. If not specified, the primary range of the subnetwork is used.
2333 },
2334 ],
2335 &quot;enableVpcScopedDns&quot;: True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
2336 # with network_attachment.
2337 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint hash of contents stored in this network interface.
2338 # This field will be ignored when inserting an Instance or
2339 # adding a NetworkInterface. An up-to-date
2340 # 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.
2341 &quot;igmpQuery&quot;: &quot;A String&quot;, # Indicate whether igmp query is enabled on the network interface
2342 # or not. If enabled, also indicates the version of IGMP supported.
2343 &quot;internalIpv6PrefixLength&quot;: 42, # The prefix length of the primary internal IPv6 range.
2344 &quot;ipv6AccessConfigs&quot;: [ # An array of IPv6 access configurations for this interface. Currently, only
2345 # one IPv6 access config, DIRECT_IPV6, is supported. If there
2346 # is no ipv6AccessConfig specified, then this instance will
2347 # have no external IPv6 Internet access.
2348 { # An access configuration attached to an instance&#x27;s network interface.
2349 # Only one access config per instance is supported.
2350 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
2351 # The first IPv6 address of the external IPv6 range associated
2352 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
2353 # use a static external IP address, it must be unused and in the same region
2354 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
2355 # assign an external IPv6 address from the instance&#x27;s subnetwork.
2356 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
2357 # external IPv6 range.
2358 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
2359 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
2360 # (IPv4), the default and recommended name is External NAT, but
2361 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
2362 # recommend name is External IPv6.
2363 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
2364 # address associated with this instance. Specify an unused static
2365 # external IP address available to the project or leave this field undefined
2366 # to use an IP from a shared ephemeral IP address pool. If you specify a
2367 # static external IP address, it must live in the same region as the zone of
2368 # the instance.
2369 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
2370 # configuration and can only take the following values: PREMIUM,STANDARD.
2371 #
2372 # If an AccessConfig is specified without a valid external IP address, an
2373 # ephemeral IP will be created with this networkTier.
2374 #
2375 # If an AccessConfig with a valid external IP address is specified, it must
2376 # match that of the networkTier associated with the Address resource owning
2377 # that IP.
2378 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
2379 #
2380 # 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
2381 # first IP in associated external IPv6 range.
2382 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
2383 # config.
2384 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
2385 # external IP address of the instance to a DNS domain name.
2386 #
2387 # This field is not used in ipv6AccessConfig. A default PTR
2388 # record will be created if the VM has external IPv6 range associated.
2389 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
2390 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
2391 },
2392 ],
2393 &quot;ipv6AccessType&quot;: &quot;A String&quot;, # Output only. [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be
2394 # accessed from the Internet. This field is always inherited from its
2395 # subnetwork.
2396 #
2397 # Valid only if stackType is IPV4_IPV6.
2398 &quot;ipv6Address&quot;: &quot;A String&quot;, # An IPv6 internal network address for this network interface. To
2399 # use a static internal IP address, it must be unused and in the same region
2400 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
2401 # assign an internal IPv6 address from the instance&#x27;s subnetwork.
2402 &quot;kind&quot;: &quot;compute#networkInterface&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#networkInterface for network interfaces.
2403 &quot;macAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] MAC address assigned to this network interface.
2404 &quot;name&quot;: &quot;A String&quot;, # [Output Only] The name of the network interface, which is generated by the
2405 # server. For a VM, the network interface uses the nicN naming
2406 # format. Where N is a value between 0 and7. The default interface value is nic0.
2407 &quot;network&quot;: &quot;A String&quot;, # URL of the VPC network resource for this instance. When creating an
2408 # instance, if neither the network nor the subnetwork is specified, the
2409 # default network global/networks/default is used. If the
2410 # selected project doesn&#x27;t have the default network, you must specify a
2411 # network or subnet. If the network is not specified but the subnetwork is
2412 # specified, the network is inferred.
2413 #
2414 # If you specify this property, you can specify the network as
2415 # a full or partial URL. For example, the following are all valid URLs:
2416 #
2417 #
2418 # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
2419 # - projects/project/global/networks/network
2420 # - global/networks/default
2421 &quot;networkAttachment&quot;: &quot;A String&quot;, # The URL of the network attachment that this interface should connect
2422 # to in the following format:
2423 # projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.
2424 &quot;networkIP&quot;: &quot;A String&quot;, # An IPv4 internal IP address to assign to the instance for this network
2425 # interface. If not specified by the user, an unused internal IP is
2426 # assigned by the system.
2427 &quot;nicType&quot;: &quot;A String&quot;, # The type of vNIC to be used on this interface. This may be gVNIC or
2428 # VirtioNet.
2429 &quot;parentNicName&quot;: &quot;A String&quot;, # Name of the parent network interface of a dynamic network interface.
2430 &quot;queueCount&quot;: 42, # The networking queue count that&#x27;s specified by users for the network
2431 # interface. Both Rx and Tx queues will be set to this number. It&#x27;ll be empty
2432 # if not specified by the users.
2433 &quot;serviceClassId&quot;: &quot;A String&quot;, # Optional. Producer Service&#x27;s Service class Id for the region of this network
2434 # interface. Can only be used with network_attachment. It is not possible to
2435 # use on its own however, network_attachment can be used without
2436 # service_class_id.
2437 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for this network interface. To assign only IPv4 addresses,
2438 # use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, useIPV4_IPV6. If not specified, IPV4_ONLY is used.
2439 #
2440 # This field can be both set at instance creation and update network
2441 # interface operations.
2442 &quot;subnetwork&quot;: &quot;A String&quot;, # The URL of the Subnetwork resource for this instance. If the network
2443 # resource is inlegacy
2444 # mode, do not specify this field. If the network is in auto subnet
2445 # mode, specifying the subnetwork is optional. If the network is in custom
2446 # subnet mode, specifying the subnetwork is required. If you specify this
2447 # field, you can specify the subnetwork as a full or partial URL. For
2448 # example, the following are all valid URLs:
2449 #
2450 #
2451 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
2452 # - regions/region/subnetworks/subnetwork
2453 &quot;vlan&quot;: 42, # VLAN tag of a dynamic network interface, must be an integer in the range
2454 # from 2 to 255 inclusively.
2455 },
2456 ],
2457 &quot;networkPerformanceConfig&quot;: { # Note that for MachineImage, this is not supported yet.
2458 &quot;totalEgressBandwidthTier&quot;: &quot;A String&quot;,
2459 },
2460 &quot;partnerMetadata&quot;: { # Partner Metadata assigned to the instance properties. A map from a
2461 # subdomain (namespace) to entries map.
2462 &quot;a_key&quot;: {
2463 &quot;entries&quot;: { # Map of a partner metadata that belong to the same subdomain.
2464 # It accepts any value including google.protobuf.Struct.
2465 &quot;a_key&quot;: &quot;&quot;,
2466 },
2467 },
2468 },
2469 &quot;postKeyRevocationActionType&quot;: &quot;A String&quot;, # PostKeyRevocationActionType of the instance.
2470 &quot;privateIpv6GoogleAccess&quot;: &quot;A String&quot;, # The private IPv6 google access type for VMs.
2471 # If not specified, use INHERIT_FROM_SUBNETWORK as default.
2472 # Note that for MachineImage, this is not supported yet.
2473 &quot;reservationAffinity&quot;: { # Specifies the reservations that this instance can consume from. # Specifies the reservations that instances can consume from.
2474 # Note that for MachineImage, this is not supported yet.
2475 &quot;consumeReservationType&quot;: &quot;A String&quot;, # Specifies the type of reservation from which this instance can consume
2476 # resources: ANY_RESERVATION (default),SPECIFIC_RESERVATION, or NO_RESERVATION. See
2477 # Consuming reserved instances for examples.
2478 &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
2479 # the name of your reservation as its value.
2480 &quot;values&quot;: [ # Corresponds to the label values of a reservation resource. This can be
2481 # either a name to a reservation in the same project or
2482 # &quot;projects/different-project/reservations/some-reservation-name&quot; to target a
2483 # shared reservation in the same zone but in a different project.
2484 &quot;A String&quot;,
2485 ],
2486 },
2487 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the instance. Tag keys and values
2488 # have the same definition as resource
2489 # manager tags. Keys and values can be either in numeric format,
2490 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
2491 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
2492 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
2493 # PATCH) when empty.
2494 &quot;a_key&quot;: &quot;A String&quot;,
2495 },
2496 &quot;resourcePolicies&quot;: [ # Resource policies (names, not URLs) applied to instances created from
2497 # these properties.
2498 # Note that for MachineImage, this is not supported yet.
2499 &quot;A String&quot;,
2500 ],
2501 &quot;scheduling&quot;: { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from
2502 # these properties.
2503 &quot;automaticRestart&quot;: True or False, # Specifies whether the instance should be automatically restarted if it is
2504 # terminated by Compute Engine (not terminated by a user). You can only set
2505 # the automatic restart option for standard instances.Preemptible instances
2506 # cannot be automatically restarted.
2507 #
2508 # By default, this is set to true so an instance is
2509 # automatically restarted if it is terminated by Compute Engine.
2510 &quot;availabilityDomain&quot;: 42, # Specifies the availability domain to place the instance in. The value
2511 # must be a number between 1 and the number of availability domains
2512 # specified in the spread placement policy attached to the instance.
2513 &quot;gracefulShutdown&quot;: { # The configuration for gracefully shutting down the instance.
2514 &quot;enabled&quot;: True or False, # Opts-in for graceful shutdown.
2515 &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
2516 # graceful shutdown isn&#x27;t complete after this time, then the instance
2517 # transitions to the STOPPING state.
2518 # as a count of seconds and fractions of seconds at nanosecond
2519 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
2520 # or &quot;month&quot;. Range is approximately 10,000 years.
2521 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
2522 # Durations less than one second are represented with a 0
2523 # `seconds` field and a positive `nanos` field. Must be from 0
2524 # to 999,999,999 inclusive.
2525 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
2526 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
2527 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
2528 },
2529 },
2530 &quot;hostErrorTimeoutSeconds&quot;: 42, # Specify the time in seconds for host error detection, the value must be
2531 # within the range of [90, 330] with the increment of 30, if unset, the
2532 # default behavior of host error recovery will be used.
2533 &quot;instanceTerminationAction&quot;: &quot;A String&quot;, # Specifies the termination action for the instance.
2534 &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
2535 # recovery of the Local Ssd state is attempted. Its value should be in
2536 # between 0 and 168 hours with hour granularity and the default value being 1
2537 # hour.
2538 # as a count of seconds and fractions of seconds at nanosecond
2539 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
2540 # or &quot;month&quot;. Range is approximately 10,000 years.
2541 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
2542 # Durations less than one second are represented with a 0
2543 # `seconds` field and a positive `nanos` field. Must be from 0
2544 # to 999,999,999 inclusive.
2545 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
2546 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
2547 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
2548 },
2549 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the instance close to other
2550 # resources.
2551 # This field is for use by internal tools that use the public API.
2552 &quot;maintenanceFreezeDurationHours&quot;: 42, # Specifies the number of hours after VM instance creation where the VM won&#x27;t
2553 # be scheduled for maintenance.
2554 &quot;maintenanceInterval&quot;: &quot;A String&quot;, # Specifies the frequency of planned maintenance events. The accepted values
2555 # are: `PERIODIC`.
2556 &quot;maxRunDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the max run duration for the given instance. If specified,
2557 # the instance termination action will be performed at the end of the run
2558 # duration.
2559 # as a count of seconds and fractions of seconds at nanosecond
2560 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
2561 # or &quot;month&quot;. Range is approximately 10,000 years.
2562 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
2563 # Durations less than one second are represented with a 0
2564 # `seconds` field and a positive `nanos` field. Must be from 0
2565 # to 999,999,999 inclusive.
2566 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
2567 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
2568 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
2569 },
2570 &quot;minNodeCpus&quot;: 42, # The minimum number of virtual CPUs this instance will consume when running
2571 # on a sole-tenant node.
2572 &quot;nodeAffinities&quot;: [ # A set of node affinity and anti-affinity configurations. Refer toConfiguring node
2573 # affinity for more information.
2574 # Overrides reservationAffinity.
2575 { # Node Affinity: the configuration of desired nodes onto which this Instance
2576 # could be scheduled.
2577 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of Node resource.
2578 &quot;operator&quot;: &quot;A String&quot;, # Defines the operation of node selection. Valid operators areIN for affinity and NOT_IN for anti-affinity.
2579 &quot;values&quot;: [ # Corresponds to the label values of Node resource.
2580 &quot;A String&quot;,
2581 ],
2582 },
2583 ],
2584 &quot;onHostMaintenance&quot;: &quot;A String&quot;, # Defines the maintenance behavior for this instance. For standard instances,
2585 # the default behavior is MIGRATE. Forpreemptible instances,
2586 # the default and only possible behavior is TERMINATE. For more
2587 # information, see
2588 # Set
2589 # VM host maintenance policy.
2590 &quot;onInstanceStopAction&quot;: { # Defines the behaviour for instances with the instance_termination_actionSTOP.
2591 &quot;discardLocalSsd&quot;: True or False, # If true, the contents of any attached Local SSD disks will be discarded
2592 # else, the Local SSD data will be preserved when the instance is stopped
2593 # at the end of the run duration/termination time.
2594 },
2595 &quot;preemptible&quot;: True or False, # Defines whether the instance is preemptible. This can only be set during
2596 # instance creation or while the instance isstopped and
2597 # therefore, in a `TERMINATED` state. SeeInstance Life
2598 # Cycle for more information on the possible instance states.
2599 &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
2600 # Off signal is triggered for Spot
2601 # VMs only. If not specified, there will be no wait before the G2 Soft
2602 # Off signal is triggered.
2603 # as a count of seconds and fractions of seconds at nanosecond
2604 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
2605 # or &quot;month&quot;. Range is approximately 10,000 years.
2606 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
2607 # Durations less than one second are represented with a 0
2608 # `seconds` field and a positive `nanos` field. Must be from 0
2609 # to 999,999,999 inclusive.
2610 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
2611 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
2612 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
2613 },
2614 &quot;provisioningModel&quot;: &quot;A String&quot;, # Specifies the provisioning model of the instance.
2615 &quot;skipGuestOsShutdown&quot;: True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
2616 # Off and ACPI G3 Mechanical
2617 # Off for Standard VMs and 30 seconds for Spot VMs.
2618 &quot;terminationTime&quot;: &quot;A String&quot;, # Specifies the timestamp, when the instance will be terminated, inRFC3339 text format. If specified, the instance
2619 # termination action will be performed at the termination time.
2620 },
2621 &quot;serviceAccounts&quot;: [ # A list of service accounts with specified scopes. Access tokens for these
2622 # service accounts are available to the instances that are created from
2623 # these properties. Use metadata queries to obtain the access tokens for
2624 # these instances.
2625 { # A service account.
2626 &quot;email&quot;: &quot;A String&quot;, # Email address of the service account.
2627 &quot;scopes&quot;: [ # The list of scopes to be made available for this service account.
2628 &quot;A String&quot;,
2629 ],
2630 },
2631 ],
2632 &quot;shieldedInstanceConfig&quot;: { # A set of Shielded Instance options. # Note that for MachineImage, this is not supported yet.
2633 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.Enabled by
2634 # default.
2635 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.Disabled by
2636 # default.
2637 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.Enabled by
2638 # default.
2639 },
2640 &quot;shieldedVmConfig&quot;: { # A set of Shielded VM options. # Specifies the Shielded VM options for the instances that are created from
2641 # these properties.
2642 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.
2643 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.
2644 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.
2645 },
2646 &quot;tags&quot;: { # A set of instance tags. # A list of tags to apply to the instances that are created from these
2647 # properties. The tags identify valid sources or targets for network
2648 # firewalls. The setTags method can modify this list of tags. Each tag within
2649 # the list must comply with RFC1035.
2650 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
2651 # the tags&#x27; contents and used for optimistic locking. The
2652 # fingerprint is initially generated by Compute Engine and changes after
2653 # every request to modify or update tags. You must always provide an
2654 # up-to-date fingerprint hash in order to update or change tags.
2655 #
2656 # To see the latest fingerprint, make get() request to the
2657 # instance.
2658 &quot;items&quot;: [ # An array of tags. Each tag must be 1-63 characters long, and comply
2659 # with RFC1035.
2660 &quot;A String&quot;,
2661 ],
2662 },
2663 &quot;workloadIdentityConfig&quot;: {
2664 &quot;identity&quot;: &quot;A String&quot;,
2665 &quot;identityCertificateEnabled&quot;: True or False,
2666 },
2667 },
2668 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the instance template resides. Only
2669 # applicable for regional resources.
2670 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL for this instance template. The server defines this
2671 # URL.
2672 &quot;sourceInstance&quot;: &quot;A String&quot;, # The source instance used to create the template. You can provide this as a
2673 # partial or full URL to the resource. For example, the following are valid
2674 # values:
2675 #
2676 #
2677 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
2678 # - projects/project/zones/zone/instances/instance
2679 &quot;sourceInstanceParams&quot;: { # A specification of the parameters to use when creating the instance template # The source instance params to use to create this instance template.
2680 # from a source instance.
2681 &quot;diskConfigs&quot;: [ # Attached disks configuration. If not provided, defaults are applied:
2682 # For boot disk and any other R/W disks, the source images for each disk
2683 # will be used. For read-only disks, they will be attached in read-only
2684 # mode. Local SSD disks will be created as blank volumes.
2685 { # A specification of the desired way to instantiate a disk in the instance
2686 # template when its created from a source instance.
2687 &quot;autoDelete&quot;: True or False, # Specifies whether the disk will be auto-deleted when the instance is
2688 # deleted (but not when the disk is detached from the instance).
2689 &quot;customImage&quot;: &quot;A String&quot;, # The custom source image to be used to restore this disk when instantiating
2690 # this instance template.
2691 &quot;deviceName&quot;: &quot;A String&quot;, # Specifies the device name of the disk to which the configurations apply to.
2692 &quot;instantiateFrom&quot;: &quot;A String&quot;, # Specifies whether to include the disk and what image to use. Possible
2693 # values are:
2694 #
2695 #
2696 # - source-image: to use the same image that was used to
2697 # create the source instance&#x27;s corresponding disk. Applicable to the boot
2698 # disk and additional read-write disks.
2699 # - source-image-family: to use the same image family that
2700 # was used to create the source instance&#x27;s corresponding disk. Applicable
2701 # to the boot disk and additional read-write disks.
2702 # - custom-image: to use a user-provided image url for disk
2703 # creation. Applicable to the boot disk and additional read-write
2704 # disks.
2705 # - attach-read-only: to attach a read-only
2706 # disk. Applicable to read-only disks.
2707 # - do-not-include: to exclude a disk from the template.
2708 # Applicable to additional read-write disks, local SSDs, and read-only
2709 # disks.
2710 },
2711 ],
2712 },
2713 }</pre>
2714 </div>
2715
2716 <div class="method">
2717 <code class="details" id="getIamPolicy">getIamPolicy(project, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</code>
2718 <pre>Gets the access control policy for a resource. May be empty if no such
2719 policy or resource exists.
2720
2721 Args:
2722 project: string, Project ID for this request. (required)
2723 resource: string, Name or id of the resource for this request. (required)
2724 optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
2725 x__xgafv: string, V1 error format.
2726 Allowed values
2727 1 - v1 error format
2728 2 - v2 error format
2729
2730 Returns:
2731 An object of the form:
2732
2733 { # An Identity and Access Management (IAM) policy, which specifies access
2734 # controls for Google Cloud resources.
2735 #
2736 #
2737 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
2738 # `members`, or principals, to a single `role`. Principals can be user
2739 # accounts, service accounts, Google groups, and domains (such as G Suite). A
2740 # `role` is a named list of permissions; each `role` can be an IAM predefined
2741 # role or a user-created custom role.
2742 #
2743 # For some types of Google Cloud resources, a `binding` can also specify a
2744 # `condition`, which is a logical expression that allows access to a resource
2745 # only if the expression evaluates to `true`. A condition can add constraints
2746 # based on attributes of the request, the resource, or both. To learn which
2747 # resources support conditions in their IAM policies, see the
2748 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
2749 #
2750 # **JSON example:**
2751 #
2752 # ```
2753 # {
2754 # &quot;bindings&quot;: [
2755 # {
2756 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
2757 # &quot;members&quot;: [
2758 # &quot;user:[email protected]&quot;,
2759 # &quot;group:[email protected]&quot;,
2760 # &quot;domain:google.com&quot;,
2761 # &quot;serviceAccount:[email protected]&quot;
2762 # ]
2763 # },
2764 # {
2765 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
2766 # &quot;members&quot;: [
2767 # &quot;user:[email protected]&quot;
2768 # ],
2769 # &quot;condition&quot;: {
2770 # &quot;title&quot;: &quot;expirable access&quot;,
2771 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
2772 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
2773 # }
2774 # }
2775 # ],
2776 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
2777 # &quot;version&quot;: 3
2778 # }
2779 # ```
2780 #
2781 # **YAML example:**
2782 #
2783 # ```
2784 # bindings:
2785 # - members:
2786 # - user:[email protected]
2787 # - group:[email protected]
2788 # - domain:google.com
2789 # - serviceAccount:[email protected]
2790 # role: roles/resourcemanager.organizationAdmin
2791 # - members:
2792 # - user:[email protected]
2793 # role: roles/resourcemanager.organizationViewer
2794 # condition:
2795 # title: expirable access
2796 # description: Does not grant access after Sep 2020
2797 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
2798 # etag: BwWWja0YfJA=
2799 # version: 3
2800 # ```
2801 #
2802 # For a description of IAM and its features, see the
2803 # [IAM documentation](https://cloud.google.com/iam/docs/).
2804 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
2805 { # Specifies the audit configuration for a service.
2806 # The configuration determines which permission types are logged, and what
2807 # identities, if any, are exempted from logging.
2808 # An AuditConfig must have one or more AuditLogConfigs.
2809 #
2810 # If there are AuditConfigs for both `allServices` and a specific service,
2811 # the union of the two AuditConfigs is used for that service: the log_types
2812 # specified in each AuditConfig are enabled, and the exempted_members in each
2813 # AuditLogConfig are exempted.
2814 #
2815 # Example Policy with multiple AuditConfigs:
2816 #
2817 # {
2818 # &quot;audit_configs&quot;: [
2819 # {
2820 # &quot;service&quot;: &quot;allServices&quot;,
2821 # &quot;audit_log_configs&quot;: [
2822 # {
2823 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
2824 # &quot;exempted_members&quot;: [
2825 # &quot;user:[email protected]&quot;
2826 # ]
2827 # },
2828 # {
2829 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
2830 # },
2831 # {
2832 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
2833 # }
2834 # ]
2835 # },
2836 # {
2837 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
2838 # &quot;audit_log_configs&quot;: [
2839 # {
2840 # &quot;log_type&quot;: &quot;DATA_READ&quot;
2841 # },
2842 # {
2843 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
2844 # &quot;exempted_members&quot;: [
2845 # &quot;user:[email protected]&quot;
2846 # ]
2847 # }
2848 # ]
2849 # }
2850 # ]
2851 # }
2852 #
2853 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
2854 # logging. It also exempts `[email protected]` from DATA_READ logging, and
2855 # `[email protected]` from DATA_WRITE logging.
2856 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
2857 { # Provides the configuration for logging a type of permissions.
2858 # Example:
2859 #
2860 # {
2861 # &quot;audit_log_configs&quot;: [
2862 # {
2863 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
2864 # &quot;exempted_members&quot;: [
2865 # &quot;user:[email protected]&quot;
2866 # ]
2867 # },
2868 # {
2869 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
2870 # }
2871 # ]
2872 # }
2873 #
2874 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
2875 # [email protected] from DATA_READ logging.
2876 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
2877 # permission.
2878 # Follows the same format of Binding.members.
2879 &quot;A String&quot;,
2880 ],
2881 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
2882 },
2883 ],
2884 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
2885 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
2886 # `allServices` is a special value that covers all services.
2887 },
2888 ],
2889 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
2890 # may specify a `condition` that determines how and when the `bindings` are
2891 # applied. Each of the `bindings` must contain at least one principal.
2892 #
2893 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
2894 # of these principals can be Google groups. Each occurrence of a principal
2895 # counts towards these limits. For example, if the `bindings` grant 50
2896 # different roles to `user:[email protected]`, and not to any other
2897 # principal, then you can add another 1,450 principals to the `bindings` in
2898 # the `Policy`.
2899 { # Associates `members`, or principals, with a `role`.
2900 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
2901 #
2902 # If the condition evaluates to `true`, then this binding applies to the
2903 # current request.
2904 #
2905 # If the condition evaluates to `false`, then this binding does not apply to
2906 # the current request. However, a different role binding might grant the same
2907 # role to one or more of the principals in this binding.
2908 #
2909 # To learn which resources support conditions in their IAM policies, see the
2910 # [IAM
2911 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
2912 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
2913 # are documented at https://github.com/google/cel-spec.
2914 #
2915 # Example (Comparison):
2916 #
2917 # title: &quot;Summary size limit&quot;
2918 # description: &quot;Determines if a summary is less than 100 chars&quot;
2919 # expression: &quot;document.summary.size() &lt; 100&quot;
2920 #
2921 # Example (Equality):
2922 #
2923 # title: &quot;Requestor is owner&quot;
2924 # description: &quot;Determines if requestor is the document owner&quot;
2925 # expression: &quot;document.owner == request.auth.claims.email&quot;
2926 #
2927 # Example (Logic):
2928 #
2929 # title: &quot;Public documents&quot;
2930 # description: &quot;Determine whether the document should be publicly visible&quot;
2931 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
2932 #
2933 # Example (Data Manipulation):
2934 #
2935 # title: &quot;Notification string&quot;
2936 # description: &quot;Create a notification string with a timestamp.&quot;
2937 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
2938 #
2939 # The exact variables and functions that may be referenced within an expression
2940 # are determined by the service that evaluates it. See the service
2941 # documentation for additional information.
2942 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
2943 # describes the expression, e.g. when hovered over it in a UI.
2944 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
2945 # syntax.
2946 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
2947 # reporting, e.g. a file name and a position in the file.
2948 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
2949 # its purpose. This can be used e.g. in UIs which allow to enter the
2950 # expression.
2951 },
2952 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
2953 # `members` can have the following values:
2954 #
2955 # * `allUsers`: A special identifier that represents anyone who is
2956 # on the internet; with or without a Google account.
2957 #
2958 # * `allAuthenticatedUsers`: A special identifier that represents anyone
2959 # who is authenticated with a Google account or a service account.
2960 # Does not include identities that come from external identity providers
2961 # (IdPs) through identity federation.
2962 #
2963 # * `user:{emailid}`: An email address that represents a specific Google
2964 # account. For example, `[email protected]` .
2965 #
2966 #
2967 # * `serviceAccount:{emailid}`: An email address that represents a Google
2968 # service account. For example,
2969 # `[email protected]`.
2970 #
2971 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
2972 # identifier for a
2973 # [Kubernetes service
2974 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
2975 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
2976 #
2977 # * `group:{emailid}`: An email address that represents a Google group.
2978 # For example, `[email protected]`.
2979 #
2980 #
2981 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
2982 # users of that domain. For example, `google.com` or `example.com`.
2983 #
2984 #
2985 #
2986 #
2987 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
2988 # A single identity in a workforce identity pool.
2989 #
2990 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
2991 # All workforce identities in a group.
2992 #
2993 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
2994 # All workforce identities with a specific attribute value.
2995 #
2996 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
2997 # All identities in a workforce identity pool.
2998 #
2999 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
3000 # A single identity in a workload identity pool.
3001 #
3002 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
3003 # A workload identity pool group.
3004 #
3005 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
3006 # All identities in a workload identity pool with a certain attribute.
3007 #
3008 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
3009 # All identities in a workload identity pool.
3010 #
3011 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
3012 # identifier) representing a user that has been recently deleted. For
3013 # example, `[email protected]?uid=123456789012345678901`. If the user is
3014 # recovered, this value reverts to `user:{emailid}` and the recovered user
3015 # retains the role in the binding.
3016 #
3017 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
3018 # unique identifier) representing a service account that has been recently
3019 # deleted. For example,
3020 # `[email protected]?uid=123456789012345678901`.
3021 # If the service account is undeleted, this value reverts to
3022 # `serviceAccount:{emailid}` and the undeleted service account retains the
3023 # role in the binding.
3024 #
3025 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
3026 # identifier) representing a Google group that has been recently
3027 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
3028 # the group is recovered, this value reverts to `group:{emailid}` and the
3029 # recovered group retains the role in the binding.
3030 #
3031 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
3032 # Deleted single identity in a workforce identity pool. For example,
3033 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
3034 &quot;A String&quot;,
3035 ],
3036 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
3037 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
3038 #
3039 # For an overview of the IAM roles and permissions, see the
3040 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
3041 # a list of the available pre-defined roles, see
3042 # [here](https://cloud.google.com/iam/docs/understanding-roles).
3043 },
3044 ],
3045 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
3046 # prevent simultaneous updates of a policy from overwriting each other.
3047 # It is strongly suggested that systems make use of the `etag` in the
3048 # read-modify-write cycle to perform policy updates in order to avoid race
3049 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
3050 # systems are expected to put that etag in the request to `setIamPolicy` to
3051 # ensure that their change will be applied to the same version of the policy.
3052 #
3053 # **Important:** If you use IAM Conditions, you must include the `etag` field
3054 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
3055 # you to overwrite a version `3` policy with a version `1` policy, and all of
3056 # the conditions in the version `3` policy are lost.
3057 &quot;version&quot;: 42, # Specifies the format of the policy.
3058 #
3059 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
3060 # are rejected.
3061 #
3062 # Any operation that affects conditional role bindings must specify version
3063 # `3`. This requirement applies to the following operations:
3064 #
3065 # * Getting a policy that includes a conditional role binding
3066 # * Adding a conditional role binding to a policy
3067 # * Changing a conditional role binding in a policy
3068 # * Removing any role binding, with or without a condition, from a policy
3069 # that includes conditions
3070 #
3071 # **Important:** If you use IAM Conditions, you must include the `etag` field
3072 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
3073 # you to overwrite a version `3` policy with a version `1` policy, and all of
3074 # the conditions in the version `3` policy are lost.
3075 #
3076 # If a policy does not include any conditions, operations on that policy may
3077 # specify any valid version or leave the field unset.
3078 #
3079 # To learn which resources support conditions in their IAM policies, see the
3080 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3081 }</pre>
3082 </div>
3083
3084 <div class="method">
3085 <code class="details" id="insert">insert(project, body=None, requestId=None, x__xgafv=None)</code>
3086 <pre>Creates an instance template in the specified project using the
3087 data that is included in the request. If you are creating a new template to
3088 update an existing instance group, your new instance template must use the
3089 same network or, if applicable, the same subnetwork as the original
3090 template.
3091
3092 Args:
3093 project: string, Project ID for this request. (required)
3094 body: object, The request body.
3095 The object takes the form of:
3096
3097 { # Represents an Instance Template resource.
3098 #
3099 # Google Compute Engine has two Instance Template resources:
3100 #
3101 # * [Global](/compute/docs/reference/rest/beta/instanceTemplates)
3102 # * [Regional](/compute/docs/reference/rest/beta/regionInstanceTemplates)
3103 #
3104 # You can reuse a global instance template in
3105 # different regions whereas you can use a regional instance template in a
3106 # specified region only. If you want to reduce cross-region dependency or
3107 # achieve data residency, use a regional instance template.
3108 #
3109 # To create VMs, managed instance groups, and reservations, you can use either
3110 # global or regional instance templates.
3111 #
3112 # For more information, readInstance Templates.
3113 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] The creation timestamp for this instance template inRFC3339
3114 # text format.
3115 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
3116 # create the resource.
3117 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] A unique identifier for this instance template. The server
3118 # defines this identifier.
3119 &quot;kind&quot;: &quot;compute#instanceTemplate&quot;, # Output only. [Output Only] The resource type, which is alwayscompute#instanceTemplate for instance templates.
3120 &quot;name&quot;: &quot;A String&quot;, # Name of the resource; provided by the client when the resource is created.
3121 # The name must be 1-63 characters long, and comply withRFC1035.
3122 # Specifically, the name must be 1-63 characters long and match the regular
3123 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
3124 # character must be a lowercase letter, and all following characters must be
3125 # a dash, lowercase letter, or digit, except the last character, which cannot
3126 # be a dash.
3127 &quot;properties&quot;: { # The instance properties for this instance template.
3128 &quot;advancedMachineFeatures&quot;: { # Specifies options for controlling advanced machine features. # Controls for advanced machine-related behavior features.
3129 # Note that for MachineImage, this is not supported yet.
3130 # Options that would traditionally be configured in a BIOS belong
3131 # here. Features that require operating system support may have
3132 # corresponding entries in the GuestOsFeatures of anImage (e.g., whether or not the OS in theImage supports nested virtualization being enabled or
3133 # disabled).
3134 &quot;enableNestedVirtualization&quot;: True or False, # Whether to enable nested virtualization or not (default is false).
3135 &quot;enableUefiNetworking&quot;: True or False, # Whether to enable UEFI networking for instance creation.
3136 &quot;performanceMonitoringUnit&quot;: &quot;A String&quot;, # Type of Performance Monitoring Unit requested on instance.
3137 &quot;threadsPerCore&quot;: 42, # The number of threads per physical core. To disable simultaneous
3138 # multithreading (SMT) set this to 1. If unset, the maximum number
3139 # of threads supported per core by the underlying processor is
3140 # assumed.
3141 &quot;turboMode&quot;: &quot;A String&quot;, # Turbo frequency mode to use for the instance.
3142 # Supported modes include:
3143 # * ALL_CORE_MAX
3144 #
3145 # Using empty string or not setting this field will use the platform-specific
3146 # default turbo mode.
3147 &quot;visibleCoreCount&quot;: 42, # The number of physical cores to expose to an instance. Multiply by
3148 # the number of threads per core to compute the total number of virtual
3149 # CPUs to expose to the instance. If unset, the number of cores is
3150 # inferred from the instance&#x27;s nominal CPU count and the underlying
3151 # platform&#x27;s SMT width.
3152 },
3153 &quot;canIpForward&quot;: True or False, # Enables instances created based on these properties to send packets with
3154 # source IP addresses other than their own and receive packets with
3155 # destination IP addresses other than their own. If these instances will be
3156 # used as an IP gateway or it will be set as the next-hop in a Route
3157 # resource, specify true. If unsure, leave this set tofalse. See theEnable IP forwarding
3158 # documentation for more information.
3159 &quot;confidentialInstanceConfig&quot;: { # A set of Confidential Instance options. # Specifies the Confidential Instance options.
3160 # Note that for MachineImage, this is not supported yet.
3161 &quot;confidentialInstanceType&quot;: &quot;A String&quot;, # Defines the type of technology used by the confidential instance.
3162 &quot;enableConfidentialCompute&quot;: True or False, # Defines whether the instance should have confidential compute enabled.
3163 },
3164 &quot;description&quot;: &quot;A String&quot;, # An optional text description for the instances that are created from these
3165 # properties.
3166 &quot;disks&quot;: [ # An array of disks that are associated with the instances that are created
3167 # from these properties.
3168 { # An instance-attached disk resource.
3169 &quot;architecture&quot;: &quot;A String&quot;, # Output only. [Output Only] The architecture of the attached disk. Valid values are ARM64
3170 # or X86_64.
3171 &quot;autoDelete&quot;: True or False, # Specifies whether the disk will be auto-deleted when the instance is
3172 # deleted (but not when the disk is detached from the instance).
3173 &quot;boot&quot;: True or False, # Indicates that this is a boot disk. The virtual machine will use the first
3174 # partition of the disk for its root filesystem.
3175 &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
3176 # running within the instance. This name can be used to reference the device
3177 # for mounting, resizing, and so on, from within the instance.
3178 #
3179 # If not specified, the server chooses a default device name to apply to this
3180 # disk, in the form persistent-disk-x, where x is a number
3181 # assigned by Google Compute Engine. This field is only applicable for
3182 # persistent disks.
3183 &quot;diskEncryptionKey&quot;: { # Encrypts or decrypts a disk using acustomer-supplied
3184 # encryption key.
3185 #
3186 # If you are creating a new disk, this field encrypts the new disk using
3187 # an encryption key that you provide. If you are attaching an existing
3188 # disk that is already encrypted, this field decrypts the disk using
3189 # the customer-supplied encryption key.
3190 #
3191 # If you encrypt a disk using a customer-supplied key, you must provide the
3192 # same key again when you attempt to use this resource at a later time. For
3193 # example, you must provide the key when you create a snapshot or an image
3194 # from the disk or when you attach the disk to a virtual machine instance.
3195 #
3196 # If you do not provide an encryption key, then the disk will be encrypted
3197 # using an automatically generated key and you do not need to provide a key
3198 # to use the disk later.
3199 #
3200 # Note:
3201 #
3202 # Instance templates do not storecustomer-supplied
3203 # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
3204 #
3205 # You cannot create VMs that have disks with customer-supplied keys using
3206 # the bulk
3207 # insert method.
3208 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
3209 # For example:
3210 #
3211 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3212 # key_region/cryptoKeys/key
3213 #
3214 # The fully-qualifed key name may be returned for resource GET requests. For
3215 # example:
3216 #
3217 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3218 # key_region/cryptoKeys/key
3219 # /cryptoKeyVersions/1
3220 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
3221 # key. If absent, the Compute Engine default service account is used.
3222 # For example:
3223 #
3224 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
3225 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
3226 # encryption key, encoded in RFC
3227 # 4648 base64 to either encrypt or decrypt this resource. You can
3228 # provide either the rawKey or thersaEncryptedKey.
3229 # For example:
3230 #
3231 # &quot;rawKey&quot;:
3232 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
3233 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
3234 # customer-supplied encryption key to either encrypt or decrypt this
3235 # resource. You can provide either the rawKey or thersaEncryptedKey.
3236 # For example:
3237 #
3238 # &quot;rsaEncryptedKey&quot;:
3239 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
3240 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
3241 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
3242 #
3243 # The key must meet the following requirements before you can provide it to
3244 # Compute Engine:
3245 #
3246 # 1. The key is wrapped using a RSA public key certificate provided by
3247 # Google.
3248 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
3249 # encoding.
3250 #
3251 # Gets the RSA public key certificate provided by Google at:
3252 #
3253 #
3254 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
3255 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
3256 # 4648 base64 encoded SHA-256 hash of the customer-supplied
3257 # encryption key that protects this resource.
3258 },
3259 &quot;diskSizeGb&quot;: &quot;A String&quot;, # The size of the disk in GB.
3260 &quot;forceAttach&quot;: True or False, # [Input Only] Whether to force attach the regional disk even if it&#x27;s
3261 # currently attached to another instance. If you try to force attach a zonal
3262 # disk to an instance, you will receive an error.
3263 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
3264 # only for bootable images. Read
3265 # Enabling guest operating system features to see a list of available
3266 # options.
3267 { # Guest OS features.
3268 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
3269 # separate values. Set to one or more of the following values:
3270 #
3271 # - VIRTIO_SCSI_MULTIQUEUE
3272 # - WINDOWS
3273 # - MULTI_IP_SUBNET
3274 # - UEFI_COMPATIBLE
3275 # - GVNIC
3276 # - SEV_CAPABLE
3277 # - SUSPEND_RESUME_COMPATIBLE
3278 # - SEV_LIVE_MIGRATABLE_V2
3279 # - SEV_SNP_CAPABLE
3280 # - TDX_CAPABLE
3281 # - IDPF
3282 # - SNP_SVSM_CAPABLE
3283 # - CCA_CAPABLE
3284 #
3285 #
3286 # For more information, see
3287 # Enabling guest operating system features.
3288 },
3289 ],
3290 &quot;index&quot;: 42, # Output only. [Output Only] A zero-based index to this disk, where 0 is reserved for the
3291 # boot disk. If you have many disks attached to an instance, each
3292 # disk would have a unique index number.
3293 &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
3294 # alongside the new instance. Use initialization parameters to create boot
3295 # disks or local SSDs attached to the new instance.
3296 #
3297 # This property is mutually exclusive with the source property;
3298 # you can only define one or the other, but not both.
3299 # alongside the new instance. Use initialization parameters to create boot
3300 # disks or local SSDs attached to the new instance.
3301 #
3302 # This field is persisted and returned for instanceTemplate and not returned
3303 # in the context of instance.
3304 #
3305 # This property is mutually exclusive with the source property;
3306 # you can only define one or the other, but not both.
3307 &quot;architecture&quot;: &quot;A String&quot;, # The architecture of the attached disk. Valid values are
3308 # arm64 or x86_64.
3309 &quot;description&quot;: &quot;A String&quot;, # An optional description. Provide this property when creating the disk.
3310 &quot;diskName&quot;: &quot;A String&quot;, # Specifies the disk name. If not specified, the default is to use the name
3311 # of the instance. If a disk with the same name already exists in the given
3312 # region, the existing disk is attached to the new instance and the
3313 # new disk is not created.
3314 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB. The size must be at least
3315 # 10 GB. If you specify a sourceImage, which is required for
3316 # boot disks, the default size is the size of the sourceImage.
3317 # If you do not specify a sourceImage, the default disk size
3318 # is 500 GB.
3319 &quot;diskType&quot;: &quot;A String&quot;,
3320 &quot;enableConfidentialCompute&quot;: True or False, # Whether this disk is using confidential compute mode.
3321 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
3322 # only for bootable images. Read
3323 # Enabling guest operating system features to see a list of available
3324 # options.
3325 #
3326 # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
3327 { # Guest OS features.
3328 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
3329 # separate values. Set to one or more of the following values:
3330 #
3331 # - VIRTIO_SCSI_MULTIQUEUE
3332 # - WINDOWS
3333 # - MULTI_IP_SUBNET
3334 # - UEFI_COMPATIBLE
3335 # - GVNIC
3336 # - SEV_CAPABLE
3337 # - SUSPEND_RESUME_COMPATIBLE
3338 # - SEV_LIVE_MIGRATABLE_V2
3339 # - SEV_SNP_CAPABLE
3340 # - TDX_CAPABLE
3341 # - IDPF
3342 # - SNP_SVSM_CAPABLE
3343 # - CCA_CAPABLE
3344 #
3345 #
3346 # For more information, see
3347 # Enabling guest operating system features.
3348 },
3349 ],
3350 &quot;labels&quot;: { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
3351 # persistent disks.
3352 &quot;a_key&quot;: &quot;A String&quot;,
3353 },
3354 &quot;licenses&quot;: [ # A list of publicly visible licenses. Reserved for Google&#x27;s use.
3355 &quot;A String&quot;,
3356 ],
3357 &quot;multiWriter&quot;: True or False, # Indicates whether or not the disk can be read/write attached to
3358 # more than one instance.
3359 &quot;onUpdateAction&quot;: &quot;A String&quot;, # Specifies which action to take on instance update with this disk. Default
3360 # is to use the existing disk.
3361 &quot;provisionedIops&quot;: &quot;A String&quot;, # Indicates how many IOPS to provision for the disk. This sets the number
3362 # of I/O operations per second that the disk can handle. Values must be
3363 # between 10,000 and 120,000. For more details, see theExtreme persistent
3364 # disk documentation.
3365 &quot;provisionedThroughput&quot;: &quot;A String&quot;, # Indicates how much throughput to provision for the disk. This sets the
3366 # number of throughput mb per second that the disk can handle. Values must
3367 # greater than or equal to 1.
3368 &quot;replicaZones&quot;: [ # Required for each regional disk associated with the instance. Specify
3369 # the URLs of the zones where the disk should be replicated to.
3370 # You must provide exactly two replica zones, and one zone must be the same
3371 # as the instance zone.
3372 &quot;A String&quot;,
3373 ],
3374 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
3375 # have the same definition as resource
3376 # manager tags. Keys and values can be either in numeric format,
3377 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
3378 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
3379 # `{tag_value_short_name}`. The field is ignored (both PUT &amp; PATCH) when
3380 # empty.
3381 &quot;a_key&quot;: &quot;A String&quot;,
3382 },
3383 &quot;resourcePolicies&quot;: [ # Resource policies applied to this disk for automatic snapshot creations.
3384 # Specified using the full or partial URL. For instance template, specify
3385 # only the resource policy name.
3386 &quot;A String&quot;,
3387 ],
3388 &quot;sourceImage&quot;: &quot;A String&quot;, # The source image to create this disk. When creating a new instance boot
3389 # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
3390 # is required.
3391 #
3392 # To create a disk with one of the public operating system
3393 # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
3394 #
3395 # projects/debian-cloud/global/images/family/debian-9
3396 #
3397 #
3398 # Alternatively, use a specific version of a public operating system image:
3399 #
3400 # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
3401 #
3402 #
3403 # To create a disk with a custom image that you created, specify the
3404 # image name in the following format:
3405 #
3406 # global/images/my-custom-image
3407 #
3408 #
3409 # You can also specify a custom image by its image family, which returns
3410 # the latest version of the image in that family. Replace the image name
3411 # with family/family-name:
3412 #
3413 # global/images/family/my-image-family
3414 #
3415 #
3416 # If the source image is deleted later, this field will not be set.
3417 &quot;sourceImageEncryptionKey&quot;: { # Thecustomer-supplied
3418 # encryption key of the source image. Required if the source image is
3419 # protected by a customer-supplied encryption key.
3420 #
3421 # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
3422 # encryption keys, so you cannot create disks for instances in a managed instance group if the
3423 # source images are encrypted with your own keys.
3424 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
3425 # For example:
3426 #
3427 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3428 # key_region/cryptoKeys/key
3429 #
3430 # The fully-qualifed key name may be returned for resource GET requests. For
3431 # example:
3432 #
3433 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3434 # key_region/cryptoKeys/key
3435 # /cryptoKeyVersions/1
3436 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
3437 # key. If absent, the Compute Engine default service account is used.
3438 # For example:
3439 #
3440 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
3441 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
3442 # encryption key, encoded in RFC
3443 # 4648 base64 to either encrypt or decrypt this resource. You can
3444 # provide either the rawKey or thersaEncryptedKey.
3445 # For example:
3446 #
3447 # &quot;rawKey&quot;:
3448 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
3449 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
3450 # customer-supplied encryption key to either encrypt or decrypt this
3451 # resource. You can provide either the rawKey or thersaEncryptedKey.
3452 # For example:
3453 #
3454 # &quot;rsaEncryptedKey&quot;:
3455 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
3456 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
3457 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
3458 #
3459 # The key must meet the following requirements before you can provide it to
3460 # Compute Engine:
3461 #
3462 # 1. The key is wrapped using a RSA public key certificate provided by
3463 # Google.
3464 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
3465 # encoding.
3466 #
3467 # Gets the RSA public key certificate provided by Google at:
3468 #
3469 #
3470 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
3471 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
3472 # 4648 base64 encoded SHA-256 hash of the customer-supplied
3473 # encryption key that protects this resource.
3474 },
3475 &quot;sourceInstantSnapshot&quot;: &quot;A String&quot;, # The source instant-snapshot to create this disk. When creating a new
3476 # instance boot disk, one of initializeParams.sourceSnapshot
3477 # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
3478 # is required.
3479 #
3480 # To create a disk with a snapshot that you created, specify the
3481 # snapshot name in the following format:
3482 #
3483 # us-central1-a/instantSnapshots/my-backup
3484 #
3485 #
3486 # If the source instant-snapshot is deleted later, this field will not be
3487 # set.
3488 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # The source snapshot to create this disk. When creating a new instance
3489 # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
3490 # is required.
3491 #
3492 # To create a disk with a snapshot that you created, specify the
3493 # snapshot name in the following format:
3494 #
3495 # global/snapshots/my-backup
3496 #
3497 #
3498 # If the source snapshot is deleted later, this field will not be set.
3499 #
3500 # Note: You cannot create VMs in bulk using a snapshot as the source. Use
3501 # an image instead when you create VMs using
3502 # the bulk
3503 # insert method.
3504 &quot;sourceSnapshotEncryptionKey&quot;: { # Thecustomer-supplied
3505 # encryption key of the source snapshot.
3506 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
3507 # For example:
3508 #
3509 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3510 # key_region/cryptoKeys/key
3511 #
3512 # The fully-qualifed key name may be returned for resource GET requests. For
3513 # example:
3514 #
3515 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3516 # key_region/cryptoKeys/key
3517 # /cryptoKeyVersions/1
3518 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
3519 # key. If absent, the Compute Engine default service account is used.
3520 # For example:
3521 #
3522 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
3523 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
3524 # encryption key, encoded in RFC
3525 # 4648 base64 to either encrypt or decrypt this resource. You can
3526 # provide either the rawKey or thersaEncryptedKey.
3527 # For example:
3528 #
3529 # &quot;rawKey&quot;:
3530 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
3531 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
3532 # customer-supplied encryption key to either encrypt or decrypt this
3533 # resource. You can provide either the rawKey or thersaEncryptedKey.
3534 # For example:
3535 #
3536 # &quot;rsaEncryptedKey&quot;:
3537 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
3538 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
3539 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
3540 #
3541 # The key must meet the following requirements before you can provide it to
3542 # Compute Engine:
3543 #
3544 # 1. The key is wrapped using a RSA public key certificate provided by
3545 # Google.
3546 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
3547 # encoding.
3548 #
3549 # Gets the RSA public key certificate provided by Google at:
3550 #
3551 #
3552 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
3553 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
3554 # 4648 base64 encoded SHA-256 hash of the customer-supplied
3555 # encryption key that protects this resource.
3556 },
3557 &quot;storagePool&quot;: &quot;A String&quot;, # The storage pool in which the new disk is created. You can provide
3558 # this as a partial or full URL to the resource. For example, the following
3559 # are valid values:
3560 #
3561 #
3562 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
3563 # - projects/project/zones/zone/storagePools/storagePool
3564 # - zones/zone/storagePools/storagePool
3565 },
3566 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is
3567 # either SCSI or NVME. For most machine types, the
3568 # default is SCSI. Local SSDs can use either NVME or SCSI.
3569 # In certain configurations, persistent disks can use NVMe. For more
3570 # information, seeAbout
3571 # persistent disks.
3572 &quot;kind&quot;: &quot;compute#attachedDisk&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
3573 &quot;licenses&quot;: [ # Output only. [Output Only] Any valid publicly visible licenses.
3574 &quot;A String&quot;,
3575 ],
3576 &quot;locked&quot;: True or False, # Output only. [Output Only] Whether to indicate the attached disk is locked. The locked
3577 # disk is not allowed to be detached from the instance, or to be used as the
3578 # source of the snapshot creation, and the image creation. The instance with
3579 # at least one locked attached disk is not allow to be used as source of
3580 # machine image creation, instant snapshot creation, and not allowed to be
3581 # deleted with --keep-disk parameter set to true for locked disks.
3582 &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
3583 # in READ_WRITE mode.
3584 &quot;savedState&quot;: &quot;A String&quot;, # Output only. For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
3585 # field is set to PRESERVED if the LocalSSD data has been saved
3586 # to a persistent location by customer request. (see the
3587 # discard_local_ssd option on Stop/Suspend).
3588 # Read-only in the api.
3589 &quot;shieldedInstanceInitialState&quot;: { # Initial State for shielded instance, # Output only. [Output Only] shielded vm initial state stored on disk
3590 # these are public keys which are safe to store in public
3591 &quot;dbs&quot;: [ # The Key Database (db).
3592 {
3593 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
3594 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
3595 },
3596 ],
3597 &quot;dbxs&quot;: [ # The forbidden key database (dbx).
3598 {
3599 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
3600 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
3601 },
3602 ],
3603 &quot;keks&quot;: [ # The Key Exchange Key (KEK).
3604 {
3605 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
3606 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
3607 },
3608 ],
3609 &quot;pk&quot;: { # The Platform Key (PK).
3610 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
3611 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
3612 },
3613 },
3614 &quot;source&quot;: &quot;A String&quot;, # Specifies a valid partial or full URL to an existing Persistent Disk
3615 # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
3616 # is required.
3617 #
3618 # If desired, you can also attach existing non-root persistent disks using
3619 # this property. This field is only applicable for persistent disks.
3620 #
3621 # Note that for InstanceTemplate, specify the disk name for zonal disk,
3622 # and the URL for regional disk.
3623 &quot;type&quot;: &quot;A String&quot;, # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
3624 },
3625 ],
3626 &quot;displayDevice&quot;: { # A set of Display Device options # Display Device properties to enable support
3627 # for remote display products like: Teradici,
3628 # VNC and TeamViewer
3629 # Note that for MachineImage, this is not supported yet.
3630 &quot;enableDisplay&quot;: True or False, # Defines whether the instance has Display enabled.
3631 },
3632 &quot;guestAccelerators&quot;: [ # A list of guest accelerator cards&#x27; type and count to use for instances
3633 # created from these properties.
3634 { # A specification of the type and number of accelerator cards attached to the
3635 # instance.
3636 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
3637 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this
3638 # instance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100
3639 # If you are creating an instance template, specify only the
3640 # accelerator name.
3641 # See GPUs on Compute Engine
3642 # for a full list of accelerator types.
3643 },
3644 ],
3645 &quot;keyRevocationActionType&quot;: &quot;A String&quot;, # KeyRevocationActionType of the instance. Supported options are &quot;STOP&quot; and
3646 # &quot;NONE&quot;. The default value is &quot;NONE&quot; if it is not specified.
3647 &quot;labels&quot;: { # Labels to apply to instances that are created from these properties.
3648 &quot;a_key&quot;: &quot;A String&quot;,
3649 },
3650 &quot;machineType&quot;: &quot;A String&quot;, # The machine type to use for instances that are created from these
3651 # properties.
3652 # This field only accepts a machine type name, for example `n2-standard-4`.
3653 # If you use the machine type full or partial URL, for example
3654 # `projects/my-l7ilb-project/zones/us-central1-a/machineTypes/n2-standard-4`,
3655 # the request will result in an `INTERNAL_ERROR`.
3656 &quot;metadata&quot;: { # A metadata key/value entry. # The metadata key/value pairs to assign to instances that are created from
3657 # these properties. These pairs can consist of custom metadata or predefined
3658 # keys. SeeProject and
3659 # instance metadata for more information.
3660 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
3661 # the metadata&#x27;s contents and used for optimistic locking. The
3662 # fingerprint is initially generated by Compute Engine and changes after
3663 # every request to modify or update metadata. You must always provide an
3664 # up-to-date fingerprint hash in order to update or change metadata,
3665 # otherwise the request will fail with error412 conditionNotMet.
3666 #
3667 # To see the latest fingerprint, make a get() request to
3668 # retrieve the resource.
3669 &quot;items&quot;: [ # Array of key/value pairs. The total size of all keys and values must be
3670 # less than 512 KB.
3671 { # Metadata
3672 &quot;key&quot;: &quot;A String&quot;, # Key for the metadata entry. Keys must conform to the following
3673 # regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length.
3674 # This is reflected as part of a URL in the metadata server. Additionally, to
3675 # avoid ambiguity, keys must not conflict with any other metadata keys
3676 # for the project.
3677 &quot;value&quot;: &quot;A String&quot;, # Value for the metadata entry. These are free-form strings, and only
3678 # have meaning as interpreted by the image running in the instance. The
3679 # only restriction placed on values is that their size must be less than
3680 # or equal to 262144 bytes (256 KiB).
3681 },
3682 ],
3683 &quot;kind&quot;: &quot;compute#metadata&quot;, # Output only. [Output Only] Type of the resource. Always compute#metadata
3684 # for metadata.
3685 },
3686 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Minimum cpu/platform to be used by instances. The instance may be
3687 # scheduled on the specified or newer cpu/platform. Applicable values are the
3688 # friendly names of CPU platforms, such asminCpuPlatform: &quot;Intel Haswell&quot; orminCpuPlatform: &quot;Intel Sandy Bridge&quot;. For more
3689 # information, read Specifying a
3690 # Minimum CPU Platform.
3691 &quot;networkInterfaces&quot;: [ # An array of network access configurations for this interface.
3692 { # A network interface resource attached to an instance.
3693 &quot;accessConfigs&quot;: [ # An array of configurations for this interface. Currently, only one access
3694 # config, ONE_TO_ONE_NAT, is supported. If there are noaccessConfigs specified, then this instance will have
3695 # no external internet access.
3696 { # An access configuration attached to an instance&#x27;s network interface.
3697 # Only one access config per instance is supported.
3698 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
3699 # The first IPv6 address of the external IPv6 range associated
3700 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
3701 # use a static external IP address, it must be unused and in the same region
3702 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
3703 # assign an external IPv6 address from the instance&#x27;s subnetwork.
3704 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
3705 # external IPv6 range.
3706 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
3707 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
3708 # (IPv4), the default and recommended name is External NAT, but
3709 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
3710 # recommend name is External IPv6.
3711 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
3712 # address associated with this instance. Specify an unused static
3713 # external IP address available to the project or leave this field undefined
3714 # to use an IP from a shared ephemeral IP address pool. If you specify a
3715 # static external IP address, it must live in the same region as the zone of
3716 # the instance.
3717 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
3718 # configuration and can only take the following values: PREMIUM,STANDARD.
3719 #
3720 # If an AccessConfig is specified without a valid external IP address, an
3721 # ephemeral IP will be created with this networkTier.
3722 #
3723 # If an AccessConfig with a valid external IP address is specified, it must
3724 # match that of the networkTier associated with the Address resource owning
3725 # that IP.
3726 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
3727 #
3728 # 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
3729 # first IP in associated external IPv6 range.
3730 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
3731 # config.
3732 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
3733 # external IP address of the instance to a DNS domain name.
3734 #
3735 # This field is not used in ipv6AccessConfig. A default PTR
3736 # record will be created if the VM has external IPv6 range associated.
3737 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
3738 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
3739 },
3740 ],
3741 &quot;aliasIpRanges&quot;: [ # An array of alias IP ranges for this network interface.
3742 # You can only specify this field for network interfaces in VPC networks.
3743 { # An alias IP range attached to an instance&#x27;s network interface.
3744 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
3745 # must belong to the specified subnetwork and cannot contain IP addresses
3746 # reserved by system or used by other network interfaces. This range may be
3747 # 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).
3748 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
3749 # alias range. If not specified, the primary range of the subnetwork is used.
3750 },
3751 ],
3752 &quot;aliasIpv6Ranges&quot;: [ # An array of alias IPv6 ranges for this network interface.
3753 # You can only specify this field for network interfaces in VPC networks.
3754 { # An alias IP range attached to an instance&#x27;s network interface.
3755 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
3756 # must belong to the specified subnetwork and cannot contain IP addresses
3757 # reserved by system or used by other network interfaces. This range may be
3758 # 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).
3759 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
3760 # alias range. If not specified, the primary range of the subnetwork is used.
3761 },
3762 ],
3763 &quot;enableVpcScopedDns&quot;: True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
3764 # with network_attachment.
3765 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint hash of contents stored in this network interface.
3766 # This field will be ignored when inserting an Instance or
3767 # adding a NetworkInterface. An up-to-date
3768 # 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.
3769 &quot;igmpQuery&quot;: &quot;A String&quot;, # Indicate whether igmp query is enabled on the network interface
3770 # or not. If enabled, also indicates the version of IGMP supported.
3771 &quot;internalIpv6PrefixLength&quot;: 42, # The prefix length of the primary internal IPv6 range.
3772 &quot;ipv6AccessConfigs&quot;: [ # An array of IPv6 access configurations for this interface. Currently, only
3773 # one IPv6 access config, DIRECT_IPV6, is supported. If there
3774 # is no ipv6AccessConfig specified, then this instance will
3775 # have no external IPv6 Internet access.
3776 { # An access configuration attached to an instance&#x27;s network interface.
3777 # Only one access config per instance is supported.
3778 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
3779 # The first IPv6 address of the external IPv6 range associated
3780 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
3781 # use a static external IP address, it must be unused and in the same region
3782 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
3783 # assign an external IPv6 address from the instance&#x27;s subnetwork.
3784 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
3785 # external IPv6 range.
3786 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
3787 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
3788 # (IPv4), the default and recommended name is External NAT, but
3789 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
3790 # recommend name is External IPv6.
3791 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
3792 # address associated with this instance. Specify an unused static
3793 # external IP address available to the project or leave this field undefined
3794 # to use an IP from a shared ephemeral IP address pool. If you specify a
3795 # static external IP address, it must live in the same region as the zone of
3796 # the instance.
3797 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
3798 # configuration and can only take the following values: PREMIUM,STANDARD.
3799 #
3800 # If an AccessConfig is specified without a valid external IP address, an
3801 # ephemeral IP will be created with this networkTier.
3802 #
3803 # If an AccessConfig with a valid external IP address is specified, it must
3804 # match that of the networkTier associated with the Address resource owning
3805 # that IP.
3806 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
3807 #
3808 # 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
3809 # first IP in associated external IPv6 range.
3810 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
3811 # config.
3812 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
3813 # external IP address of the instance to a DNS domain name.
3814 #
3815 # This field is not used in ipv6AccessConfig. A default PTR
3816 # record will be created if the VM has external IPv6 range associated.
3817 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
3818 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
3819 },
3820 ],
3821 &quot;ipv6AccessType&quot;: &quot;A String&quot;, # Output only. [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be
3822 # accessed from the Internet. This field is always inherited from its
3823 # subnetwork.
3824 #
3825 # Valid only if stackType is IPV4_IPV6.
3826 &quot;ipv6Address&quot;: &quot;A String&quot;, # An IPv6 internal network address for this network interface. To
3827 # use a static internal IP address, it must be unused and in the same region
3828 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
3829 # assign an internal IPv6 address from the instance&#x27;s subnetwork.
3830 &quot;kind&quot;: &quot;compute#networkInterface&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#networkInterface for network interfaces.
3831 &quot;macAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] MAC address assigned to this network interface.
3832 &quot;name&quot;: &quot;A String&quot;, # [Output Only] The name of the network interface, which is generated by the
3833 # server. For a VM, the network interface uses the nicN naming
3834 # format. Where N is a value between 0 and7. The default interface value is nic0.
3835 &quot;network&quot;: &quot;A String&quot;, # URL of the VPC network resource for this instance. When creating an
3836 # instance, if neither the network nor the subnetwork is specified, the
3837 # default network global/networks/default is used. If the
3838 # selected project doesn&#x27;t have the default network, you must specify a
3839 # network or subnet. If the network is not specified but the subnetwork is
3840 # specified, the network is inferred.
3841 #
3842 # If you specify this property, you can specify the network as
3843 # a full or partial URL. For example, the following are all valid URLs:
3844 #
3845 #
3846 # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
3847 # - projects/project/global/networks/network
3848 # - global/networks/default
3849 &quot;networkAttachment&quot;: &quot;A String&quot;, # The URL of the network attachment that this interface should connect
3850 # to in the following format:
3851 # projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.
3852 &quot;networkIP&quot;: &quot;A String&quot;, # An IPv4 internal IP address to assign to the instance for this network
3853 # interface. If not specified by the user, an unused internal IP is
3854 # assigned by the system.
3855 &quot;nicType&quot;: &quot;A String&quot;, # The type of vNIC to be used on this interface. This may be gVNIC or
3856 # VirtioNet.
3857 &quot;parentNicName&quot;: &quot;A String&quot;, # Name of the parent network interface of a dynamic network interface.
3858 &quot;queueCount&quot;: 42, # The networking queue count that&#x27;s specified by users for the network
3859 # interface. Both Rx and Tx queues will be set to this number. It&#x27;ll be empty
3860 # if not specified by the users.
3861 &quot;serviceClassId&quot;: &quot;A String&quot;, # Optional. Producer Service&#x27;s Service class Id for the region of this network
3862 # interface. Can only be used with network_attachment. It is not possible to
3863 # use on its own however, network_attachment can be used without
3864 # service_class_id.
3865 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for this network interface. To assign only IPv4 addresses,
3866 # use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, useIPV4_IPV6. If not specified, IPV4_ONLY is used.
3867 #
3868 # This field can be both set at instance creation and update network
3869 # interface operations.
3870 &quot;subnetwork&quot;: &quot;A String&quot;, # The URL of the Subnetwork resource for this instance. If the network
3871 # resource is inlegacy
3872 # mode, do not specify this field. If the network is in auto subnet
3873 # mode, specifying the subnetwork is optional. If the network is in custom
3874 # subnet mode, specifying the subnetwork is required. If you specify this
3875 # field, you can specify the subnetwork as a full or partial URL. For
3876 # example, the following are all valid URLs:
3877 #
3878 #
3879 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
3880 # - regions/region/subnetworks/subnetwork
3881 &quot;vlan&quot;: 42, # VLAN tag of a dynamic network interface, must be an integer in the range
3882 # from 2 to 255 inclusively.
3883 },
3884 ],
3885 &quot;networkPerformanceConfig&quot;: { # Note that for MachineImage, this is not supported yet.
3886 &quot;totalEgressBandwidthTier&quot;: &quot;A String&quot;,
3887 },
3888 &quot;partnerMetadata&quot;: { # Partner Metadata assigned to the instance properties. A map from a
3889 # subdomain (namespace) to entries map.
3890 &quot;a_key&quot;: {
3891 &quot;entries&quot;: { # Map of a partner metadata that belong to the same subdomain.
3892 # It accepts any value including google.protobuf.Struct.
3893 &quot;a_key&quot;: &quot;&quot;,
3894 },
3895 },
3896 },
3897 &quot;postKeyRevocationActionType&quot;: &quot;A String&quot;, # PostKeyRevocationActionType of the instance.
3898 &quot;privateIpv6GoogleAccess&quot;: &quot;A String&quot;, # The private IPv6 google access type for VMs.
3899 # If not specified, use INHERIT_FROM_SUBNETWORK as default.
3900 # Note that for MachineImage, this is not supported yet.
3901 &quot;reservationAffinity&quot;: { # Specifies the reservations that this instance can consume from. # Specifies the reservations that instances can consume from.
3902 # Note that for MachineImage, this is not supported yet.
3903 &quot;consumeReservationType&quot;: &quot;A String&quot;, # Specifies the type of reservation from which this instance can consume
3904 # resources: ANY_RESERVATION (default),SPECIFIC_RESERVATION, or NO_RESERVATION. See
3905 # Consuming reserved instances for examples.
3906 &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
3907 # the name of your reservation as its value.
3908 &quot;values&quot;: [ # Corresponds to the label values of a reservation resource. This can be
3909 # either a name to a reservation in the same project or
3910 # &quot;projects/different-project/reservations/some-reservation-name&quot; to target a
3911 # shared reservation in the same zone but in a different project.
3912 &quot;A String&quot;,
3913 ],
3914 },
3915 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the instance. Tag keys and values
3916 # have the same definition as resource
3917 # manager tags. Keys and values can be either in numeric format,
3918 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
3919 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
3920 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
3921 # PATCH) when empty.
3922 &quot;a_key&quot;: &quot;A String&quot;,
3923 },
3924 &quot;resourcePolicies&quot;: [ # Resource policies (names, not URLs) applied to instances created from
3925 # these properties.
3926 # Note that for MachineImage, this is not supported yet.
3927 &quot;A String&quot;,
3928 ],
3929 &quot;scheduling&quot;: { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from
3930 # these properties.
3931 &quot;automaticRestart&quot;: True or False, # Specifies whether the instance should be automatically restarted if it is
3932 # terminated by Compute Engine (not terminated by a user). You can only set
3933 # the automatic restart option for standard instances.Preemptible instances
3934 # cannot be automatically restarted.
3935 #
3936 # By default, this is set to true so an instance is
3937 # automatically restarted if it is terminated by Compute Engine.
3938 &quot;availabilityDomain&quot;: 42, # Specifies the availability domain to place the instance in. The value
3939 # must be a number between 1 and the number of availability domains
3940 # specified in the spread placement policy attached to the instance.
3941 &quot;gracefulShutdown&quot;: { # The configuration for gracefully shutting down the instance.
3942 &quot;enabled&quot;: True or False, # Opts-in for graceful shutdown.
3943 &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
3944 # graceful shutdown isn&#x27;t complete after this time, then the instance
3945 # transitions to the STOPPING state.
3946 # as a count of seconds and fractions of seconds at nanosecond
3947 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
3948 # or &quot;month&quot;. Range is approximately 10,000 years.
3949 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
3950 # Durations less than one second are represented with a 0
3951 # `seconds` field and a positive `nanos` field. Must be from 0
3952 # to 999,999,999 inclusive.
3953 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
3954 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
3955 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
3956 },
3957 },
3958 &quot;hostErrorTimeoutSeconds&quot;: 42, # Specify the time in seconds for host error detection, the value must be
3959 # within the range of [90, 330] with the increment of 30, if unset, the
3960 # default behavior of host error recovery will be used.
3961 &quot;instanceTerminationAction&quot;: &quot;A String&quot;, # Specifies the termination action for the instance.
3962 &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
3963 # recovery of the Local Ssd state is attempted. Its value should be in
3964 # between 0 and 168 hours with hour granularity and the default value being 1
3965 # hour.
3966 # as a count of seconds and fractions of seconds at nanosecond
3967 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
3968 # or &quot;month&quot;. Range is approximately 10,000 years.
3969 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
3970 # Durations less than one second are represented with a 0
3971 # `seconds` field and a positive `nanos` field. Must be from 0
3972 # to 999,999,999 inclusive.
3973 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
3974 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
3975 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
3976 },
3977 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the instance close to other
3978 # resources.
3979 # This field is for use by internal tools that use the public API.
3980 &quot;maintenanceFreezeDurationHours&quot;: 42, # Specifies the number of hours after VM instance creation where the VM won&#x27;t
3981 # be scheduled for maintenance.
3982 &quot;maintenanceInterval&quot;: &quot;A String&quot;, # Specifies the frequency of planned maintenance events. The accepted values
3983 # are: `PERIODIC`.
3984 &quot;maxRunDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the max run duration for the given instance. If specified,
3985 # the instance termination action will be performed at the end of the run
3986 # duration.
3987 # as a count of seconds and fractions of seconds at nanosecond
3988 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
3989 # or &quot;month&quot;. Range is approximately 10,000 years.
3990 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
3991 # Durations less than one second are represented with a 0
3992 # `seconds` field and a positive `nanos` field. Must be from 0
3993 # to 999,999,999 inclusive.
3994 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
3995 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
3996 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
3997 },
3998 &quot;minNodeCpus&quot;: 42, # The minimum number of virtual CPUs this instance will consume when running
3999 # on a sole-tenant node.
4000 &quot;nodeAffinities&quot;: [ # A set of node affinity and anti-affinity configurations. Refer toConfiguring node
4001 # affinity for more information.
4002 # Overrides reservationAffinity.
4003 { # Node Affinity: the configuration of desired nodes onto which this Instance
4004 # could be scheduled.
4005 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of Node resource.
4006 &quot;operator&quot;: &quot;A String&quot;, # Defines the operation of node selection. Valid operators areIN for affinity and NOT_IN for anti-affinity.
4007 &quot;values&quot;: [ # Corresponds to the label values of Node resource.
4008 &quot;A String&quot;,
4009 ],
4010 },
4011 ],
4012 &quot;onHostMaintenance&quot;: &quot;A String&quot;, # Defines the maintenance behavior for this instance. For standard instances,
4013 # the default behavior is MIGRATE. Forpreemptible instances,
4014 # the default and only possible behavior is TERMINATE. For more
4015 # information, see
4016 # Set
4017 # VM host maintenance policy.
4018 &quot;onInstanceStopAction&quot;: { # Defines the behaviour for instances with the instance_termination_actionSTOP.
4019 &quot;discardLocalSsd&quot;: True or False, # If true, the contents of any attached Local SSD disks will be discarded
4020 # else, the Local SSD data will be preserved when the instance is stopped
4021 # at the end of the run duration/termination time.
4022 },
4023 &quot;preemptible&quot;: True or False, # Defines whether the instance is preemptible. This can only be set during
4024 # instance creation or while the instance isstopped and
4025 # therefore, in a `TERMINATED` state. SeeInstance Life
4026 # Cycle for more information on the possible instance states.
4027 &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
4028 # Off signal is triggered for Spot
4029 # VMs only. If not specified, there will be no wait before the G2 Soft
4030 # Off signal is triggered.
4031 # as a count of seconds and fractions of seconds at nanosecond
4032 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
4033 # or &quot;month&quot;. Range is approximately 10,000 years.
4034 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
4035 # Durations less than one second are represented with a 0
4036 # `seconds` field and a positive `nanos` field. Must be from 0
4037 # to 999,999,999 inclusive.
4038 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
4039 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
4040 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
4041 },
4042 &quot;provisioningModel&quot;: &quot;A String&quot;, # Specifies the provisioning model of the instance.
4043 &quot;skipGuestOsShutdown&quot;: True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
4044 # Off and ACPI G3 Mechanical
4045 # Off for Standard VMs and 30 seconds for Spot VMs.
4046 &quot;terminationTime&quot;: &quot;A String&quot;, # Specifies the timestamp, when the instance will be terminated, inRFC3339 text format. If specified, the instance
4047 # termination action will be performed at the termination time.
4048 },
4049 &quot;serviceAccounts&quot;: [ # A list of service accounts with specified scopes. Access tokens for these
4050 # service accounts are available to the instances that are created from
4051 # these properties. Use metadata queries to obtain the access tokens for
4052 # these instances.
4053 { # A service account.
4054 &quot;email&quot;: &quot;A String&quot;, # Email address of the service account.
4055 &quot;scopes&quot;: [ # The list of scopes to be made available for this service account.
4056 &quot;A String&quot;,
4057 ],
4058 },
4059 ],
4060 &quot;shieldedInstanceConfig&quot;: { # A set of Shielded Instance options. # Note that for MachineImage, this is not supported yet.
4061 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.Enabled by
4062 # default.
4063 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.Disabled by
4064 # default.
4065 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.Enabled by
4066 # default.
4067 },
4068 &quot;shieldedVmConfig&quot;: { # A set of Shielded VM options. # Specifies the Shielded VM options for the instances that are created from
4069 # these properties.
4070 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.
4071 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.
4072 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.
4073 },
4074 &quot;tags&quot;: { # A set of instance tags. # A list of tags to apply to the instances that are created from these
4075 # properties. The tags identify valid sources or targets for network
4076 # firewalls. The setTags method can modify this list of tags. Each tag within
4077 # the list must comply with RFC1035.
4078 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
4079 # the tags&#x27; contents and used for optimistic locking. The
4080 # fingerprint is initially generated by Compute Engine and changes after
4081 # every request to modify or update tags. You must always provide an
4082 # up-to-date fingerprint hash in order to update or change tags.
4083 #
4084 # To see the latest fingerprint, make get() request to the
4085 # instance.
4086 &quot;items&quot;: [ # An array of tags. Each tag must be 1-63 characters long, and comply
4087 # with RFC1035.
4088 &quot;A String&quot;,
4089 ],
4090 },
4091 &quot;workloadIdentityConfig&quot;: {
4092 &quot;identity&quot;: &quot;A String&quot;,
4093 &quot;identityCertificateEnabled&quot;: True or False,
4094 },
4095 },
4096 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the instance template resides. Only
4097 # applicable for regional resources.
4098 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL for this instance template. The server defines this
4099 # URL.
4100 &quot;sourceInstance&quot;: &quot;A String&quot;, # The source instance used to create the template. You can provide this as a
4101 # partial or full URL to the resource. For example, the following are valid
4102 # values:
4103 #
4104 #
4105 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
4106 # - projects/project/zones/zone/instances/instance
4107 &quot;sourceInstanceParams&quot;: { # A specification of the parameters to use when creating the instance template # The source instance params to use to create this instance template.
4108 # from a source instance.
4109 &quot;diskConfigs&quot;: [ # Attached disks configuration. If not provided, defaults are applied:
4110 # For boot disk and any other R/W disks, the source images for each disk
4111 # will be used. For read-only disks, they will be attached in read-only
4112 # mode. Local SSD disks will be created as blank volumes.
4113 { # A specification of the desired way to instantiate a disk in the instance
4114 # template when its created from a source instance.
4115 &quot;autoDelete&quot;: True or False, # Specifies whether the disk will be auto-deleted when the instance is
4116 # deleted (but not when the disk is detached from the instance).
4117 &quot;customImage&quot;: &quot;A String&quot;, # The custom source image to be used to restore this disk when instantiating
4118 # this instance template.
4119 &quot;deviceName&quot;: &quot;A String&quot;, # Specifies the device name of the disk to which the configurations apply to.
4120 &quot;instantiateFrom&quot;: &quot;A String&quot;, # Specifies whether to include the disk and what image to use. Possible
4121 # values are:
4122 #
4123 #
4124 # - source-image: to use the same image that was used to
4125 # create the source instance&#x27;s corresponding disk. Applicable to the boot
4126 # disk and additional read-write disks.
4127 # - source-image-family: to use the same image family that
4128 # was used to create the source instance&#x27;s corresponding disk. Applicable
4129 # to the boot disk and additional read-write disks.
4130 # - custom-image: to use a user-provided image url for disk
4131 # creation. Applicable to the boot disk and additional read-write
4132 # disks.
4133 # - attach-read-only: to attach a read-only
4134 # disk. Applicable to read-only disks.
4135 # - do-not-include: to exclude a disk from the template.
4136 # Applicable to additional read-write disks, local SSDs, and read-only
4137 # disks.
4138 },
4139 ],
4140 },
4141 }
4142
4143 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
4144 that if you must retry your request, the server will know to ignore the
4145 request if it has already been completed.
4146
4147 For example, consider a situation where you make an initial request and
4148 the request times out. If you make the request again with the same
4149 request ID, the server can check if original operation with the same
4150 request ID was received, and if so, will ignore the second request. This
4151 prevents clients from accidentally creating duplicate commitments.
4152
4153 The request ID must be
4154 a valid UUID with the exception that zero UUID is not supported
4155 (00000000-0000-0000-0000-000000000000).
4156 x__xgafv: string, V1 error format.
4157 Allowed values
4158 1 - v1 error format
4159 2 - v2 error format
4160
4161 Returns:
4162 An object of the form:
4163
4164 { # Represents an Operation resource.
4165 #
4166 # Google Compute Engine has three Operation resources:
4167 #
4168 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
4169 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
4170 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
4171 #
4172 # You can use an operation resource to manage asynchronous API requests.
4173 # For more information, readHandling
4174 # API responses.
4175 #
4176 # Operations can be global, regional or zonal.
4177 #
4178 # - For global operations, use the `globalOperations`
4179 # resource.
4180 # - For regional operations, use the
4181 # `regionOperations` resource.
4182 # - For zonal operations, use
4183 # the `zoneOperations` resource.
4184 #
4185 #
4186 #
4187 # For more information, read
4188 # Global, Regional, and Zonal Resources.
4189 #
4190 # Note that completed Operation resources have a limited
4191 # retention period.
4192 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
4193 # Not present otherwise.
4194 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
4195 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
4196 # set when the operation is created.
4197 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
4198 # text format.
4199 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
4200 # this field will be populated.
4201 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
4202 # operation.
4203 {
4204 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
4205 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
4206 # details. There is a set of defined message types to use for providing
4207 # details.The syntax depends on the error code. For example,
4208 # QuotaExceededInfo will have details when the error code is
4209 # QUOTA_EXCEEDED.
4210 {
4211 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
4212 #
4213 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
4214 # is not enabled:
4215 #
4216 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
4217 # &quot;domain&quot;: &quot;googleapis.com&quot;
4218 # &quot;metadata&quot;: {
4219 # &quot;resource&quot;: &quot;projects/123&quot;,
4220 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
4221 # }
4222 # }
4223 #
4224 # This response indicates that the pubsub.googleapis.com API is not enabled.
4225 #
4226 # Example of an error that is returned when attempting to create a Spanner
4227 # instance in a region that is out of stock:
4228 #
4229 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
4230 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
4231 # &quot;metadata&quot;: {
4232 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
4233 # }
4234 # }
4235 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
4236 # is typically the registered service name of the tool or product that
4237 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
4238 # generated by some common infrastructure, the error domain must be a
4239 # globally unique value that identifies the infrastructure. For Google API
4240 # infrastructure, the error domain is &quot;googleapis.com&quot;.
4241 &quot;metadatas&quot;: { # Additional structured details about this error.
4242 #
4243 # Keys must match a regular expression of `a-z+` but should
4244 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
4245 # length. When identifying the current value of an exceeded limit, the units
4246 # should be contained in the key, not the value. For example, rather than
4247 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
4248 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
4249 # instances that can be created in a single (batch) request.
4250 &quot;a_key&quot;: &quot;A String&quot;,
4251 },
4252 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
4253 # proximate cause of the error. Error reasons are unique within a particular
4254 # domain of errors. This should be at most 63 characters and match a
4255 # regular expression of `A-Z+[A-Z0-9]`, which represents
4256 # UPPER_SNAKE_CASE.
4257 },
4258 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
4259 #
4260 # For example, if a quota check failed with an error indicating the calling
4261 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
4262 # directly to the right place in the developer console to flip the bit.
4263 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
4264 { # Describes a URL link.
4265 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
4266 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
4267 },
4268 ],
4269 },
4270 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
4271 # which can be attached to an RPC error.
4272 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
4273 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
4274 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
4275 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
4276 },
4277 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
4278 &quot;dimensions&quot;: { # The map holding related quota dimensions.
4279 &quot;a_key&quot;: &quot;A String&quot;,
4280 },
4281 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
4282 # type or metric.
4283 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
4284 # or metric.
4285 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
4286 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
4287 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
4288 },
4289 },
4290 ],
4291 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
4292 # This property is optional.
4293 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
4294 },
4295 ],
4296 },
4297 &quot;getVersionOperationMetadata&quot;: {
4298 &quot;inlineSbomInfo&quot;: {
4299 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
4300 # appropriate identifiers.
4301 &quot;a_key&quot;: &quot;A String&quot;,
4302 },
4303 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
4304 # identifiers.
4305 &quot;a_key&quot;: &quot;A String&quot;,
4306 },
4307 },
4308 },
4309 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
4310 # message that was returned, such as `NOT FOUND`.
4311 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
4312 # status code that was returned. For example, a `404` means the
4313 # resource was not found.
4314 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
4315 # defined by the server.
4316 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
4317 # This value is inRFC3339
4318 # text format.
4319 &quot;instancesBulkInsertOperationMetadata&quot;: {
4320 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
4321 # Example key: zones/us-central1-a
4322 &quot;a_key&quot;: {
4323 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
4324 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
4325 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
4326 # error.
4327 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
4328 # if the flow is rolling forward or rolling back.
4329 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
4330 },
4331 },
4332 },
4333 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
4334 # Operation resources.
4335 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
4336 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
4337 # group of operations results from a `bulkInsert` API request.
4338 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
4339 # `update`, or `delete`, and so on.
4340 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
4341 # There is no requirement that this be linear or support any granularity of
4342 # operations. This should not be used to guess when the operation will be
4343 # complete. This number should monotonically increase as the operation
4344 # progresses.
4345 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
4346 # applicable when performing regional operations.
4347 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
4348 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
4349 # this field will contain information on all underlying zonal actions and
4350 # their state.
4351 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
4352 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
4353 # Example key: zones/us-central1-a
4354 &quot;a_key&quot;: {
4355 &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
4356 # populated.
4357 # different programming environments, including REST APIs and RPC APIs. It is
4358 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
4359 # three pieces of data: error code, error message, and error details.
4360 #
4361 # You can find out more about this error model and how to work with it in the
4362 # [API Design Guide](https://cloud.google.com/apis/design/errors).
4363 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
4364 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
4365 # message types for APIs to use.
4366 {
4367 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
4368 },
4369 ],
4370 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
4371 # user-facing error message should be localized and sent in the
4372 # google.rpc.Status.details field, or localized by the client.
4373 },
4374 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
4375 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
4376 },
4377 },
4378 },
4379 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
4380 # This value is inRFC3339
4381 # text format.
4382 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
4383 # following:
4384 # `PENDING`, `RUNNING`, or `DONE`.
4385 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
4386 # operation.
4387 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
4388 # of the target resource.
4389 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
4390 # operations related to creating a snapshot, this points to the disk
4391 # that the snapshot was created from.
4392 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
4393 # `[email protected]` or
4394 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
4395 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
4396 # operation, this field will be populated.
4397 {
4398 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
4399 # Engine returns NO_RESULTS_ON_PAGE if there
4400 # are no results in the response.
4401 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
4402 # value format. For example:
4403 #
4404 # &quot;data&quot;: [
4405 # {
4406 # &quot;key&quot;: &quot;scope&quot;,
4407 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
4408 # }
4409 {
4410 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
4411 # returned. For example, for warnings where there are no results in a list
4412 # request for a particular zone, this key might be scope and
4413 # the key value might be the zone name. Other examples might be a key
4414 # indicating a deprecated resource and a suggested replacement, or a
4415 # warning about invalid network settings (for example, if an instance
4416 # attempts to perform IP forwarding but is not enabled for IP forwarding).
4417 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
4418 },
4419 ],
4420 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
4421 },
4422 ],
4423 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
4424 # applicable when performing per-zone operations.
4425 }</pre>
4426 </div>
4427
4428 <div class="method">
4429 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, view=None, x__xgafv=None)</code>
4430 <pre>Retrieves a list of instance templates that are contained within
4431 the specified project.
4432
4433 Args:
4434 project: string, Project ID for this request. (required)
4435 filter: string, A filter expression that filters resources listed in the response. Most
4436 Compute resources support two types of filter expressions:
4437 expressions that support regular expressions and expressions that follow
4438 API improvement proposal AIP-160.
4439 These two types of filter expressions cannot be mixed in one request.
4440
4441 If you want to use AIP-160, your expression must specify the field name, an
4442 operator, and the value that you want to use for filtering. The value
4443 must be a string, a number, or a boolean. The operator
4444 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
4445
4446 For example, if you are filtering Compute Engine instances, you can
4447 exclude instances named `example-instance` by specifying
4448 `name != example-instance`.
4449
4450 The `:*` comparison can be used to test whether a key has been defined.
4451 For example, to find all objects with `owner` label use:
4452 ```
4453 labels.owner:*
4454 ```
4455
4456 You can also filter nested fields. For example, you could specify
4457 `scheduling.automaticRestart = false` to include instances only
4458 if they are not scheduled for automatic restarts. You can use filtering
4459 on nested fields to filter based onresource labels.
4460
4461 To filter on multiple expressions, provide each separate expression within
4462 parentheses. For example:
4463 ```
4464 (scheduling.automaticRestart = true)
4465 (cpuPlatform = &quot;Intel Skylake&quot;)
4466 ```
4467 By default, each expression is an `AND` expression. However, you
4468 can include `AND` and `OR` expressions explicitly.
4469 For example:
4470 ```
4471 (cpuPlatform = &quot;Intel Skylake&quot;) OR
4472 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
4473 (scheduling.automaticRestart = true)
4474 ```
4475
4476 If you want to use a regular expression, use the `eq` (equal) or `ne`
4477 (not equal) operator against a single un-parenthesized expression with or
4478 without quotes or against multiple parenthesized expressions. Examples:
4479
4480 `fieldname eq unquoted literal`
4481 `fieldname eq &#x27;single quoted literal&#x27;`
4482 `fieldname eq &quot;double quoted literal&quot;`
4483 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
4484
4485 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
4486 The literal value must match the entire field.
4487
4488 For example, to filter for instances that do not end with name &quot;instance&quot;,
4489 you would use `name ne .*instance`.
4490
4491 You cannot combine constraints on multiple fields using regular
4492 expressions.
4493 maxResults: integer, The maximum number of results per page that should be returned.
4494 If the number of available results is larger than `maxResults`,
4495 Compute Engine returns a `nextPageToken` that can be used to get
4496 the next page of results in subsequent list requests. Acceptable values are
4497 `0` to `500`, inclusive. (Default: `500`)
4498 orderBy: string, Sorts list results by a certain order. By default, results
4499 are returned in alphanumerical order based on the resource name.
4500
4501 You can also sort results in descending order based on the creation
4502 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
4503 results based on the `creationTimestamp` field in
4504 reverse chronological order (newest result first). Use this to sort
4505 resources like operations so that the newest operation is returned first.
4506
4507 Currently, only sorting by `name` or
4508 `creationTimestamp desc` is supported.
4509 pageToken: string, Specifies a page token to use. Set `pageToken` to the
4510 `nextPageToken` returned by a previous list request to get
4511 the next page of results.
4512 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
4513 of failure. The default value is false.
4514
4515 For example, when partial success behavior is enabled, aggregatedList for a
4516 single zone scope either returns all resources in the zone or no resources,
4517 with an error code.
4518 view: string, View of the instance template.
4519 Allowed values
4520 BASIC - Include everything except Partner Metadata.
4521 FULL - Include everything.
4522 INSTANCE_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view.
4523 x__xgafv: string, V1 error format.
4524 Allowed values
4525 1 - v1 error format
4526 2 - v2 error format
4527
4528 Returns:
4529 An object of the form:
4530
4531 { # A list of instance templates.
4532 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
4533 &quot;items&quot;: [ # A list of InstanceTemplate resources.
4534 { # Represents an Instance Template resource.
4535 #
4536 # Google Compute Engine has two Instance Template resources:
4537 #
4538 # * [Global](/compute/docs/reference/rest/beta/instanceTemplates)
4539 # * [Regional](/compute/docs/reference/rest/beta/regionInstanceTemplates)
4540 #
4541 # You can reuse a global instance template in
4542 # different regions whereas you can use a regional instance template in a
4543 # specified region only. If you want to reduce cross-region dependency or
4544 # achieve data residency, use a regional instance template.
4545 #
4546 # To create VMs, managed instance groups, and reservations, you can use either
4547 # global or regional instance templates.
4548 #
4549 # For more information, readInstance Templates.
4550 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] The creation timestamp for this instance template inRFC3339
4551 # text format.
4552 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
4553 # create the resource.
4554 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] A unique identifier for this instance template. The server
4555 # defines this identifier.
4556 &quot;kind&quot;: &quot;compute#instanceTemplate&quot;, # Output only. [Output Only] The resource type, which is alwayscompute#instanceTemplate for instance templates.
4557 &quot;name&quot;: &quot;A String&quot;, # Name of the resource; provided by the client when the resource is created.
4558 # The name must be 1-63 characters long, and comply withRFC1035.
4559 # Specifically, the name must be 1-63 characters long and match the regular
4560 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
4561 # character must be a lowercase letter, and all following characters must be
4562 # a dash, lowercase letter, or digit, except the last character, which cannot
4563 # be a dash.
4564 &quot;properties&quot;: { # The instance properties for this instance template.
4565 &quot;advancedMachineFeatures&quot;: { # Specifies options for controlling advanced machine features. # Controls for advanced machine-related behavior features.
4566 # Note that for MachineImage, this is not supported yet.
4567 # Options that would traditionally be configured in a BIOS belong
4568 # here. Features that require operating system support may have
4569 # corresponding entries in the GuestOsFeatures of anImage (e.g., whether or not the OS in theImage supports nested virtualization being enabled or
4570 # disabled).
4571 &quot;enableNestedVirtualization&quot;: True or False, # Whether to enable nested virtualization or not (default is false).
4572 &quot;enableUefiNetworking&quot;: True or False, # Whether to enable UEFI networking for instance creation.
4573 &quot;performanceMonitoringUnit&quot;: &quot;A String&quot;, # Type of Performance Monitoring Unit requested on instance.
4574 &quot;threadsPerCore&quot;: 42, # The number of threads per physical core. To disable simultaneous
4575 # multithreading (SMT) set this to 1. If unset, the maximum number
4576 # of threads supported per core by the underlying processor is
4577 # assumed.
4578 &quot;turboMode&quot;: &quot;A String&quot;, # Turbo frequency mode to use for the instance.
4579 # Supported modes include:
4580 # * ALL_CORE_MAX
4581 #
4582 # Using empty string or not setting this field will use the platform-specific
4583 # default turbo mode.
4584 &quot;visibleCoreCount&quot;: 42, # The number of physical cores to expose to an instance. Multiply by
4585 # the number of threads per core to compute the total number of virtual
4586 # CPUs to expose to the instance. If unset, the number of cores is
4587 # inferred from the instance&#x27;s nominal CPU count and the underlying
4588 # platform&#x27;s SMT width.
4589 },
4590 &quot;canIpForward&quot;: True or False, # Enables instances created based on these properties to send packets with
4591 # source IP addresses other than their own and receive packets with
4592 # destination IP addresses other than their own. If these instances will be
4593 # used as an IP gateway or it will be set as the next-hop in a Route
4594 # resource, specify true. If unsure, leave this set tofalse. See theEnable IP forwarding
4595 # documentation for more information.
4596 &quot;confidentialInstanceConfig&quot;: { # A set of Confidential Instance options. # Specifies the Confidential Instance options.
4597 # Note that for MachineImage, this is not supported yet.
4598 &quot;confidentialInstanceType&quot;: &quot;A String&quot;, # Defines the type of technology used by the confidential instance.
4599 &quot;enableConfidentialCompute&quot;: True or False, # Defines whether the instance should have confidential compute enabled.
4600 },
4601 &quot;description&quot;: &quot;A String&quot;, # An optional text description for the instances that are created from these
4602 # properties.
4603 &quot;disks&quot;: [ # An array of disks that are associated with the instances that are created
4604 # from these properties.
4605 { # An instance-attached disk resource.
4606 &quot;architecture&quot;: &quot;A String&quot;, # Output only. [Output Only] The architecture of the attached disk. Valid values are ARM64
4607 # or X86_64.
4608 &quot;autoDelete&quot;: True or False, # Specifies whether the disk will be auto-deleted when the instance is
4609 # deleted (but not when the disk is detached from the instance).
4610 &quot;boot&quot;: True or False, # Indicates that this is a boot disk. The virtual machine will use the first
4611 # partition of the disk for its root filesystem.
4612 &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
4613 # running within the instance. This name can be used to reference the device
4614 # for mounting, resizing, and so on, from within the instance.
4615 #
4616 # If not specified, the server chooses a default device name to apply to this
4617 # disk, in the form persistent-disk-x, where x is a number
4618 # assigned by Google Compute Engine. This field is only applicable for
4619 # persistent disks.
4620 &quot;diskEncryptionKey&quot;: { # Encrypts or decrypts a disk using acustomer-supplied
4621 # encryption key.
4622 #
4623 # If you are creating a new disk, this field encrypts the new disk using
4624 # an encryption key that you provide. If you are attaching an existing
4625 # disk that is already encrypted, this field decrypts the disk using
4626 # the customer-supplied encryption key.
4627 #
4628 # If you encrypt a disk using a customer-supplied key, you must provide the
4629 # same key again when you attempt to use this resource at a later time. For
4630 # example, you must provide the key when you create a snapshot or an image
4631 # from the disk or when you attach the disk to a virtual machine instance.
4632 #
4633 # If you do not provide an encryption key, then the disk will be encrypted
4634 # using an automatically generated key and you do not need to provide a key
4635 # to use the disk later.
4636 #
4637 # Note:
4638 #
4639 # Instance templates do not storecustomer-supplied
4640 # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
4641 #
4642 # You cannot create VMs that have disks with customer-supplied keys using
4643 # the bulk
4644 # insert method.
4645 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
4646 # For example:
4647 #
4648 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
4649 # key_region/cryptoKeys/key
4650 #
4651 # The fully-qualifed key name may be returned for resource GET requests. For
4652 # example:
4653 #
4654 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
4655 # key_region/cryptoKeys/key
4656 # /cryptoKeyVersions/1
4657 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
4658 # key. If absent, the Compute Engine default service account is used.
4659 # For example:
4660 #
4661 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
4662 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
4663 # encryption key, encoded in RFC
4664 # 4648 base64 to either encrypt or decrypt this resource. You can
4665 # provide either the rawKey or thersaEncryptedKey.
4666 # For example:
4667 #
4668 # &quot;rawKey&quot;:
4669 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
4670 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
4671 # customer-supplied encryption key to either encrypt or decrypt this
4672 # resource. You can provide either the rawKey or thersaEncryptedKey.
4673 # For example:
4674 #
4675 # &quot;rsaEncryptedKey&quot;:
4676 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
4677 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
4678 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
4679 #
4680 # The key must meet the following requirements before you can provide it to
4681 # Compute Engine:
4682 #
4683 # 1. The key is wrapped using a RSA public key certificate provided by
4684 # Google.
4685 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
4686 # encoding.
4687 #
4688 # Gets the RSA public key certificate provided by Google at:
4689 #
4690 #
4691 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
4692 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
4693 # 4648 base64 encoded SHA-256 hash of the customer-supplied
4694 # encryption key that protects this resource.
4695 },
4696 &quot;diskSizeGb&quot;: &quot;A String&quot;, # The size of the disk in GB.
4697 &quot;forceAttach&quot;: True or False, # [Input Only] Whether to force attach the regional disk even if it&#x27;s
4698 # currently attached to another instance. If you try to force attach a zonal
4699 # disk to an instance, you will receive an error.
4700 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
4701 # only for bootable images. Read
4702 # Enabling guest operating system features to see a list of available
4703 # options.
4704 { # Guest OS features.
4705 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
4706 # separate values. Set to one or more of the following values:
4707 #
4708 # - VIRTIO_SCSI_MULTIQUEUE
4709 # - WINDOWS
4710 # - MULTI_IP_SUBNET
4711 # - UEFI_COMPATIBLE
4712 # - GVNIC
4713 # - SEV_CAPABLE
4714 # - SUSPEND_RESUME_COMPATIBLE
4715 # - SEV_LIVE_MIGRATABLE_V2
4716 # - SEV_SNP_CAPABLE
4717 # - TDX_CAPABLE
4718 # - IDPF
4719 # - SNP_SVSM_CAPABLE
4720 # - CCA_CAPABLE
4721 #
4722 #
4723 # For more information, see
4724 # Enabling guest operating system features.
4725 },
4726 ],
4727 &quot;index&quot;: 42, # Output only. [Output Only] A zero-based index to this disk, where 0 is reserved for the
4728 # boot disk. If you have many disks attached to an instance, each
4729 # disk would have a unique index number.
4730 &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
4731 # alongside the new instance. Use initialization parameters to create boot
4732 # disks or local SSDs attached to the new instance.
4733 #
4734 # This property is mutually exclusive with the source property;
4735 # you can only define one or the other, but not both.
4736 # alongside the new instance. Use initialization parameters to create boot
4737 # disks or local SSDs attached to the new instance.
4738 #
4739 # This field is persisted and returned for instanceTemplate and not returned
4740 # in the context of instance.
4741 #
4742 # This property is mutually exclusive with the source property;
4743 # you can only define one or the other, but not both.
4744 &quot;architecture&quot;: &quot;A String&quot;, # The architecture of the attached disk. Valid values are
4745 # arm64 or x86_64.
4746 &quot;description&quot;: &quot;A String&quot;, # An optional description. Provide this property when creating the disk.
4747 &quot;diskName&quot;: &quot;A String&quot;, # Specifies the disk name. If not specified, the default is to use the name
4748 # of the instance. If a disk with the same name already exists in the given
4749 # region, the existing disk is attached to the new instance and the
4750 # new disk is not created.
4751 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB. The size must be at least
4752 # 10 GB. If you specify a sourceImage, which is required for
4753 # boot disks, the default size is the size of the sourceImage.
4754 # If you do not specify a sourceImage, the default disk size
4755 # is 500 GB.
4756 &quot;diskType&quot;: &quot;A String&quot;,
4757 &quot;enableConfidentialCompute&quot;: True or False, # Whether this disk is using confidential compute mode.
4758 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
4759 # only for bootable images. Read
4760 # Enabling guest operating system features to see a list of available
4761 # options.
4762 #
4763 # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
4764 { # Guest OS features.
4765 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
4766 # separate values. Set to one or more of the following values:
4767 #
4768 # - VIRTIO_SCSI_MULTIQUEUE
4769 # - WINDOWS
4770 # - MULTI_IP_SUBNET
4771 # - UEFI_COMPATIBLE
4772 # - GVNIC
4773 # - SEV_CAPABLE
4774 # - SUSPEND_RESUME_COMPATIBLE
4775 # - SEV_LIVE_MIGRATABLE_V2
4776 # - SEV_SNP_CAPABLE
4777 # - TDX_CAPABLE
4778 # - IDPF
4779 # - SNP_SVSM_CAPABLE
4780 # - CCA_CAPABLE
4781 #
4782 #
4783 # For more information, see
4784 # Enabling guest operating system features.
4785 },
4786 ],
4787 &quot;labels&quot;: { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
4788 # persistent disks.
4789 &quot;a_key&quot;: &quot;A String&quot;,
4790 },
4791 &quot;licenses&quot;: [ # A list of publicly visible licenses. Reserved for Google&#x27;s use.
4792 &quot;A String&quot;,
4793 ],
4794 &quot;multiWriter&quot;: True or False, # Indicates whether or not the disk can be read/write attached to
4795 # more than one instance.
4796 &quot;onUpdateAction&quot;: &quot;A String&quot;, # Specifies which action to take on instance update with this disk. Default
4797 # is to use the existing disk.
4798 &quot;provisionedIops&quot;: &quot;A String&quot;, # Indicates how many IOPS to provision for the disk. This sets the number
4799 # of I/O operations per second that the disk can handle. Values must be
4800 # between 10,000 and 120,000. For more details, see theExtreme persistent
4801 # disk documentation.
4802 &quot;provisionedThroughput&quot;: &quot;A String&quot;, # Indicates how much throughput to provision for the disk. This sets the
4803 # number of throughput mb per second that the disk can handle. Values must
4804 # greater than or equal to 1.
4805 &quot;replicaZones&quot;: [ # Required for each regional disk associated with the instance. Specify
4806 # the URLs of the zones where the disk should be replicated to.
4807 # You must provide exactly two replica zones, and one zone must be the same
4808 # as the instance zone.
4809 &quot;A String&quot;,
4810 ],
4811 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
4812 # have the same definition as resource
4813 # manager tags. Keys and values can be either in numeric format,
4814 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
4815 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
4816 # `{tag_value_short_name}`. The field is ignored (both PUT &amp; PATCH) when
4817 # empty.
4818 &quot;a_key&quot;: &quot;A String&quot;,
4819 },
4820 &quot;resourcePolicies&quot;: [ # Resource policies applied to this disk for automatic snapshot creations.
4821 # Specified using the full or partial URL. For instance template, specify
4822 # only the resource policy name.
4823 &quot;A String&quot;,
4824 ],
4825 &quot;sourceImage&quot;: &quot;A String&quot;, # The source image to create this disk. When creating a new instance boot
4826 # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
4827 # is required.
4828 #
4829 # To create a disk with one of the public operating system
4830 # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
4831 #
4832 # projects/debian-cloud/global/images/family/debian-9
4833 #
4834 #
4835 # Alternatively, use a specific version of a public operating system image:
4836 #
4837 # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
4838 #
4839 #
4840 # To create a disk with a custom image that you created, specify the
4841 # image name in the following format:
4842 #
4843 # global/images/my-custom-image
4844 #
4845 #
4846 # You can also specify a custom image by its image family, which returns
4847 # the latest version of the image in that family. Replace the image name
4848 # with family/family-name:
4849 #
4850 # global/images/family/my-image-family
4851 #
4852 #
4853 # If the source image is deleted later, this field will not be set.
4854 &quot;sourceImageEncryptionKey&quot;: { # Thecustomer-supplied
4855 # encryption key of the source image. Required if the source image is
4856 # protected by a customer-supplied encryption key.
4857 #
4858 # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
4859 # encryption keys, so you cannot create disks for instances in a managed instance group if the
4860 # source images are encrypted with your own keys.
4861 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
4862 # For example:
4863 #
4864 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
4865 # key_region/cryptoKeys/key
4866 #
4867 # The fully-qualifed key name may be returned for resource GET requests. For
4868 # example:
4869 #
4870 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
4871 # key_region/cryptoKeys/key
4872 # /cryptoKeyVersions/1
4873 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
4874 # key. If absent, the Compute Engine default service account is used.
4875 # For example:
4876 #
4877 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
4878 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
4879 # encryption key, encoded in RFC
4880 # 4648 base64 to either encrypt or decrypt this resource. You can
4881 # provide either the rawKey or thersaEncryptedKey.
4882 # For example:
4883 #
4884 # &quot;rawKey&quot;:
4885 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
4886 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
4887 # customer-supplied encryption key to either encrypt or decrypt this
4888 # resource. You can provide either the rawKey or thersaEncryptedKey.
4889 # For example:
4890 #
4891 # &quot;rsaEncryptedKey&quot;:
4892 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
4893 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
4894 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
4895 #
4896 # The key must meet the following requirements before you can provide it to
4897 # Compute Engine:
4898 #
4899 # 1. The key is wrapped using a RSA public key certificate provided by
4900 # Google.
4901 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
4902 # encoding.
4903 #
4904 # Gets the RSA public key certificate provided by Google at:
4905 #
4906 #
4907 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
4908 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
4909 # 4648 base64 encoded SHA-256 hash of the customer-supplied
4910 # encryption key that protects this resource.
4911 },
4912 &quot;sourceInstantSnapshot&quot;: &quot;A String&quot;, # The source instant-snapshot to create this disk. When creating a new
4913 # instance boot disk, one of initializeParams.sourceSnapshot
4914 # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
4915 # is required.
4916 #
4917 # To create a disk with a snapshot that you created, specify the
4918 # snapshot name in the following format:
4919 #
4920 # us-central1-a/instantSnapshots/my-backup
4921 #
4922 #
4923 # If the source instant-snapshot is deleted later, this field will not be
4924 # set.
4925 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # The source snapshot to create this disk. When creating a new instance
4926 # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
4927 # is required.
4928 #
4929 # To create a disk with a snapshot that you created, specify the
4930 # snapshot name in the following format:
4931 #
4932 # global/snapshots/my-backup
4933 #
4934 #
4935 # If the source snapshot is deleted later, this field will not be set.
4936 #
4937 # Note: You cannot create VMs in bulk using a snapshot as the source. Use
4938 # an image instead when you create VMs using
4939 # the bulk
4940 # insert method.
4941 &quot;sourceSnapshotEncryptionKey&quot;: { # Thecustomer-supplied
4942 # encryption key of the source snapshot.
4943 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
4944 # For example:
4945 #
4946 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
4947 # key_region/cryptoKeys/key
4948 #
4949 # The fully-qualifed key name may be returned for resource GET requests. For
4950 # example:
4951 #
4952 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
4953 # key_region/cryptoKeys/key
4954 # /cryptoKeyVersions/1
4955 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
4956 # key. If absent, the Compute Engine default service account is used.
4957 # For example:
4958 #
4959 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
4960 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
4961 # encryption key, encoded in RFC
4962 # 4648 base64 to either encrypt or decrypt this resource. You can
4963 # provide either the rawKey or thersaEncryptedKey.
4964 # For example:
4965 #
4966 # &quot;rawKey&quot;:
4967 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
4968 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
4969 # customer-supplied encryption key to either encrypt or decrypt this
4970 # resource. You can provide either the rawKey or thersaEncryptedKey.
4971 # For example:
4972 #
4973 # &quot;rsaEncryptedKey&quot;:
4974 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
4975 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
4976 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
4977 #
4978 # The key must meet the following requirements before you can provide it to
4979 # Compute Engine:
4980 #
4981 # 1. The key is wrapped using a RSA public key certificate provided by
4982 # Google.
4983 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
4984 # encoding.
4985 #
4986 # Gets the RSA public key certificate provided by Google at:
4987 #
4988 #
4989 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
4990 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
4991 # 4648 base64 encoded SHA-256 hash of the customer-supplied
4992 # encryption key that protects this resource.
4993 },
4994 &quot;storagePool&quot;: &quot;A String&quot;, # The storage pool in which the new disk is created. You can provide
4995 # this as a partial or full URL to the resource. For example, the following
4996 # are valid values:
4997 #
4998 #
4999 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
5000 # - projects/project/zones/zone/storagePools/storagePool
5001 # - zones/zone/storagePools/storagePool
5002 },
5003 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is
5004 # either SCSI or NVME. For most machine types, the
5005 # default is SCSI. Local SSDs can use either NVME or SCSI.
5006 # In certain configurations, persistent disks can use NVMe. For more
5007 # information, seeAbout
5008 # persistent disks.
5009 &quot;kind&quot;: &quot;compute#attachedDisk&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
5010 &quot;licenses&quot;: [ # Output only. [Output Only] Any valid publicly visible licenses.
5011 &quot;A String&quot;,
5012 ],
5013 &quot;locked&quot;: True or False, # Output only. [Output Only] Whether to indicate the attached disk is locked. The locked
5014 # disk is not allowed to be detached from the instance, or to be used as the
5015 # source of the snapshot creation, and the image creation. The instance with
5016 # at least one locked attached disk is not allow to be used as source of
5017 # machine image creation, instant snapshot creation, and not allowed to be
5018 # deleted with --keep-disk parameter set to true for locked disks.
5019 &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
5020 # in READ_WRITE mode.
5021 &quot;savedState&quot;: &quot;A String&quot;, # Output only. For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
5022 # field is set to PRESERVED if the LocalSSD data has been saved
5023 # to a persistent location by customer request. (see the
5024 # discard_local_ssd option on Stop/Suspend).
5025 # Read-only in the api.
5026 &quot;shieldedInstanceInitialState&quot;: { # Initial State for shielded instance, # Output only. [Output Only] shielded vm initial state stored on disk
5027 # these are public keys which are safe to store in public
5028 &quot;dbs&quot;: [ # The Key Database (db).
5029 {
5030 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
5031 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
5032 },
5033 ],
5034 &quot;dbxs&quot;: [ # The forbidden key database (dbx).
5035 {
5036 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
5037 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
5038 },
5039 ],
5040 &quot;keks&quot;: [ # The Key Exchange Key (KEK).
5041 {
5042 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
5043 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
5044 },
5045 ],
5046 &quot;pk&quot;: { # The Platform Key (PK).
5047 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
5048 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
5049 },
5050 },
5051 &quot;source&quot;: &quot;A String&quot;, # Specifies a valid partial or full URL to an existing Persistent Disk
5052 # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
5053 # is required.
5054 #
5055 # If desired, you can also attach existing non-root persistent disks using
5056 # this property. This field is only applicable for persistent disks.
5057 #
5058 # Note that for InstanceTemplate, specify the disk name for zonal disk,
5059 # and the URL for regional disk.
5060 &quot;type&quot;: &quot;A String&quot;, # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
5061 },
5062 ],
5063 &quot;displayDevice&quot;: { # A set of Display Device options # Display Device properties to enable support
5064 # for remote display products like: Teradici,
5065 # VNC and TeamViewer
5066 # Note that for MachineImage, this is not supported yet.
5067 &quot;enableDisplay&quot;: True or False, # Defines whether the instance has Display enabled.
5068 },
5069 &quot;guestAccelerators&quot;: [ # A list of guest accelerator cards&#x27; type and count to use for instances
5070 # created from these properties.
5071 { # A specification of the type and number of accelerator cards attached to the
5072 # instance.
5073 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
5074 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this
5075 # instance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100
5076 # If you are creating an instance template, specify only the
5077 # accelerator name.
5078 # See GPUs on Compute Engine
5079 # for a full list of accelerator types.
5080 },
5081 ],
5082 &quot;keyRevocationActionType&quot;: &quot;A String&quot;, # KeyRevocationActionType of the instance. Supported options are &quot;STOP&quot; and
5083 # &quot;NONE&quot;. The default value is &quot;NONE&quot; if it is not specified.
5084 &quot;labels&quot;: { # Labels to apply to instances that are created from these properties.
5085 &quot;a_key&quot;: &quot;A String&quot;,
5086 },
5087 &quot;machineType&quot;: &quot;A String&quot;, # The machine type to use for instances that are created from these
5088 # properties.
5089 # This field only accepts a machine type name, for example `n2-standard-4`.
5090 # If you use the machine type full or partial URL, for example
5091 # `projects/my-l7ilb-project/zones/us-central1-a/machineTypes/n2-standard-4`,
5092 # the request will result in an `INTERNAL_ERROR`.
5093 &quot;metadata&quot;: { # A metadata key/value entry. # The metadata key/value pairs to assign to instances that are created from
5094 # these properties. These pairs can consist of custom metadata or predefined
5095 # keys. SeeProject and
5096 # instance metadata for more information.
5097 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
5098 # the metadata&#x27;s contents and used for optimistic locking. The
5099 # fingerprint is initially generated by Compute Engine and changes after
5100 # every request to modify or update metadata. You must always provide an
5101 # up-to-date fingerprint hash in order to update or change metadata,
5102 # otherwise the request will fail with error412 conditionNotMet.
5103 #
5104 # To see the latest fingerprint, make a get() request to
5105 # retrieve the resource.
5106 &quot;items&quot;: [ # Array of key/value pairs. The total size of all keys and values must be
5107 # less than 512 KB.
5108 { # Metadata
5109 &quot;key&quot;: &quot;A String&quot;, # Key for the metadata entry. Keys must conform to the following
5110 # regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length.
5111 # This is reflected as part of a URL in the metadata server. Additionally, to
5112 # avoid ambiguity, keys must not conflict with any other metadata keys
5113 # for the project.
5114 &quot;value&quot;: &quot;A String&quot;, # Value for the metadata entry. These are free-form strings, and only
5115 # have meaning as interpreted by the image running in the instance. The
5116 # only restriction placed on values is that their size must be less than
5117 # or equal to 262144 bytes (256 KiB).
5118 },
5119 ],
5120 &quot;kind&quot;: &quot;compute#metadata&quot;, # Output only. [Output Only] Type of the resource. Always compute#metadata
5121 # for metadata.
5122 },
5123 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Minimum cpu/platform to be used by instances. The instance may be
5124 # scheduled on the specified or newer cpu/platform. Applicable values are the
5125 # friendly names of CPU platforms, such asminCpuPlatform: &quot;Intel Haswell&quot; orminCpuPlatform: &quot;Intel Sandy Bridge&quot;. For more
5126 # information, read Specifying a
5127 # Minimum CPU Platform.
5128 &quot;networkInterfaces&quot;: [ # An array of network access configurations for this interface.
5129 { # A network interface resource attached to an instance.
5130 &quot;accessConfigs&quot;: [ # An array of configurations for this interface. Currently, only one access
5131 # config, ONE_TO_ONE_NAT, is supported. If there are noaccessConfigs specified, then this instance will have
5132 # no external internet access.
5133 { # An access configuration attached to an instance&#x27;s network interface.
5134 # Only one access config per instance is supported.
5135 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
5136 # The first IPv6 address of the external IPv6 range associated
5137 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
5138 # use a static external IP address, it must be unused and in the same region
5139 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
5140 # assign an external IPv6 address from the instance&#x27;s subnetwork.
5141 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
5142 # external IPv6 range.
5143 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
5144 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
5145 # (IPv4), the default and recommended name is External NAT, but
5146 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
5147 # recommend name is External IPv6.
5148 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
5149 # address associated with this instance. Specify an unused static
5150 # external IP address available to the project or leave this field undefined
5151 # to use an IP from a shared ephemeral IP address pool. If you specify a
5152 # static external IP address, it must live in the same region as the zone of
5153 # the instance.
5154 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
5155 # configuration and can only take the following values: PREMIUM,STANDARD.
5156 #
5157 # If an AccessConfig is specified without a valid external IP address, an
5158 # ephemeral IP will be created with this networkTier.
5159 #
5160 # If an AccessConfig with a valid external IP address is specified, it must
5161 # match that of the networkTier associated with the Address resource owning
5162 # that IP.
5163 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
5164 #
5165 # 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
5166 # first IP in associated external IPv6 range.
5167 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
5168 # config.
5169 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
5170 # external IP address of the instance to a DNS domain name.
5171 #
5172 # This field is not used in ipv6AccessConfig. A default PTR
5173 # record will be created if the VM has external IPv6 range associated.
5174 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
5175 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
5176 },
5177 ],
5178 &quot;aliasIpRanges&quot;: [ # An array of alias IP ranges for this network interface.
5179 # You can only specify this field for network interfaces in VPC networks.
5180 { # An alias IP range attached to an instance&#x27;s network interface.
5181 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
5182 # must belong to the specified subnetwork and cannot contain IP addresses
5183 # reserved by system or used by other network interfaces. This range may be
5184 # 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).
5185 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
5186 # alias range. If not specified, the primary range of the subnetwork is used.
5187 },
5188 ],
5189 &quot;aliasIpv6Ranges&quot;: [ # An array of alias IPv6 ranges for this network interface.
5190 # You can only specify this field for network interfaces in VPC networks.
5191 { # An alias IP range attached to an instance&#x27;s network interface.
5192 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range
5193 # must belong to the specified subnetwork and cannot contain IP addresses
5194 # reserved by system or used by other network interfaces. This range may be
5195 # 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).
5196 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP
5197 # alias range. If not specified, the primary range of the subnetwork is used.
5198 },
5199 ],
5200 &quot;enableVpcScopedDns&quot;: True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
5201 # with network_attachment.
5202 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint hash of contents stored in this network interface.
5203 # This field will be ignored when inserting an Instance or
5204 # adding a NetworkInterface. An up-to-date
5205 # 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.
5206 &quot;igmpQuery&quot;: &quot;A String&quot;, # Indicate whether igmp query is enabled on the network interface
5207 # or not. If enabled, also indicates the version of IGMP supported.
5208 &quot;internalIpv6PrefixLength&quot;: 42, # The prefix length of the primary internal IPv6 range.
5209 &quot;ipv6AccessConfigs&quot;: [ # An array of IPv6 access configurations for this interface. Currently, only
5210 # one IPv6 access config, DIRECT_IPV6, is supported. If there
5211 # is no ipv6AccessConfig specified, then this instance will
5212 # have no external IPv6 Internet access.
5213 { # An access configuration attached to an instance&#x27;s network interface.
5214 # Only one access config per instance is supported.
5215 &quot;externalIpv6&quot;: &quot;A String&quot;, # Applies to ipv6AccessConfigs only.
5216 # The first IPv6 address of the external IPv6 range associated
5217 # with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
5218 # use a static external IP address, it must be unused and in the same region
5219 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
5220 # assign an external IPv6 address from the instance&#x27;s subnetwork.
5221 &quot;externalIpv6PrefixLength&quot;: 42, # Applies to ipv6AccessConfigs only. The prefix length of the
5222 # external IPv6 range.
5223 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
5224 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. In accessConfigs
5225 # (IPv4), the default and recommended name is External NAT, but
5226 # you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
5227 # recommend name is External IPv6.
5228 &quot;natIP&quot;: &quot;A String&quot;, # Applies to accessConfigs (IPv4) only. Anexternal IP
5229 # address associated with this instance. Specify an unused static
5230 # external IP address available to the project or leave this field undefined
5231 # to use an IP from a shared ephemeral IP address pool. If you specify a
5232 # static external IP address, it must live in the same region as the zone of
5233 # the instance.
5234 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access
5235 # configuration and can only take the following values: PREMIUM,STANDARD.
5236 #
5237 # If an AccessConfig is specified without a valid external IP address, an
5238 # ephemeral IP will be created with this networkTier.
5239 #
5240 # If an AccessConfig with a valid external IP address is specified, it must
5241 # match that of the networkTier associated with the Address resource owning
5242 # that IP.
5243 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record.
5244 #
5245 # 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
5246 # first IP in associated external IPv6 range.
5247 &quot;securityPolicy&quot;: &quot;A String&quot;, # The resource URL for the security policy associated with this access
5248 # config.
5249 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the
5250 # external IP address of the instance to a DNS domain name.
5251 #
5252 # This field is not used in ipv6AccessConfig. A default PTR
5253 # record will be created if the VM has external IPv6 range associated.
5254 &quot;type&quot;: &quot;A String&quot;, # The type of configuration. In accessConfigs (IPv4), the
5255 # default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
5256 },
5257 ],
5258 &quot;ipv6AccessType&quot;: &quot;A String&quot;, # Output only. [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be
5259 # accessed from the Internet. This field is always inherited from its
5260 # subnetwork.
5261 #
5262 # Valid only if stackType is IPV4_IPV6.
5263 &quot;ipv6Address&quot;: &quot;A String&quot;, # An IPv6 internal network address for this network interface. To
5264 # use a static internal IP address, it must be unused and in the same region
5265 # as the instance&#x27;s zone. If not specified, Google Cloud will automatically
5266 # assign an internal IPv6 address from the instance&#x27;s subnetwork.
5267 &quot;kind&quot;: &quot;compute#networkInterface&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#networkInterface for network interfaces.
5268 &quot;macAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] MAC address assigned to this network interface.
5269 &quot;name&quot;: &quot;A String&quot;, # [Output Only] The name of the network interface, which is generated by the
5270 # server. For a VM, the network interface uses the nicN naming
5271 # format. Where N is a value between 0 and7. The default interface value is nic0.
5272 &quot;network&quot;: &quot;A String&quot;, # URL of the VPC network resource for this instance. When creating an
5273 # instance, if neither the network nor the subnetwork is specified, the
5274 # default network global/networks/default is used. If the
5275 # selected project doesn&#x27;t have the default network, you must specify a
5276 # network or subnet. If the network is not specified but the subnetwork is
5277 # specified, the network is inferred.
5278 #
5279 # If you specify this property, you can specify the network as
5280 # a full or partial URL. For example, the following are all valid URLs:
5281 #
5282 #
5283 # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
5284 # - projects/project/global/networks/network
5285 # - global/networks/default
5286 &quot;networkAttachment&quot;: &quot;A String&quot;, # The URL of the network attachment that this interface should connect
5287 # to in the following format:
5288 # projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.
5289 &quot;networkIP&quot;: &quot;A String&quot;, # An IPv4 internal IP address to assign to the instance for this network
5290 # interface. If not specified by the user, an unused internal IP is
5291 # assigned by the system.
5292 &quot;nicType&quot;: &quot;A String&quot;, # The type of vNIC to be used on this interface. This may be gVNIC or
5293 # VirtioNet.
5294 &quot;parentNicName&quot;: &quot;A String&quot;, # Name of the parent network interface of a dynamic network interface.
5295 &quot;queueCount&quot;: 42, # The networking queue count that&#x27;s specified by users for the network
5296 # interface. Both Rx and Tx queues will be set to this number. It&#x27;ll be empty
5297 # if not specified by the users.
5298 &quot;serviceClassId&quot;: &quot;A String&quot;, # Optional. Producer Service&#x27;s Service class Id for the region of this network
5299 # interface. Can only be used with network_attachment. It is not possible to
5300 # use on its own however, network_attachment can be used without
5301 # service_class_id.
5302 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for this network interface. To assign only IPv4 addresses,
5303 # use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, useIPV4_IPV6. If not specified, IPV4_ONLY is used.
5304 #
5305 # This field can be both set at instance creation and update network
5306 # interface operations.
5307 &quot;subnetwork&quot;: &quot;A String&quot;, # The URL of the Subnetwork resource for this instance. If the network
5308 # resource is inlegacy
5309 # mode, do not specify this field. If the network is in auto subnet
5310 # mode, specifying the subnetwork is optional. If the network is in custom
5311 # subnet mode, specifying the subnetwork is required. If you specify this
5312 # field, you can specify the subnetwork as a full or partial URL. For
5313 # example, the following are all valid URLs:
5314 #
5315 #
5316 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
5317 # - regions/region/subnetworks/subnetwork
5318 &quot;vlan&quot;: 42, # VLAN tag of a dynamic network interface, must be an integer in the range
5319 # from 2 to 255 inclusively.
5320 },
5321 ],
5322 &quot;networkPerformanceConfig&quot;: { # Note that for MachineImage, this is not supported yet.
5323 &quot;totalEgressBandwidthTier&quot;: &quot;A String&quot;,
5324 },
5325 &quot;partnerMetadata&quot;: { # Partner Metadata assigned to the instance properties. A map from a
5326 # subdomain (namespace) to entries map.
5327 &quot;a_key&quot;: {
5328 &quot;entries&quot;: { # Map of a partner metadata that belong to the same subdomain.
5329 # It accepts any value including google.protobuf.Struct.
5330 &quot;a_key&quot;: &quot;&quot;,
5331 },
5332 },
5333 },
5334 &quot;postKeyRevocationActionType&quot;: &quot;A String&quot;, # PostKeyRevocationActionType of the instance.
5335 &quot;privateIpv6GoogleAccess&quot;: &quot;A String&quot;, # The private IPv6 google access type for VMs.
5336 # If not specified, use INHERIT_FROM_SUBNETWORK as default.
5337 # Note that for MachineImage, this is not supported yet.
5338 &quot;reservationAffinity&quot;: { # Specifies the reservations that this instance can consume from. # Specifies the reservations that instances can consume from.
5339 # Note that for MachineImage, this is not supported yet.
5340 &quot;consumeReservationType&quot;: &quot;A String&quot;, # Specifies the type of reservation from which this instance can consume
5341 # resources: ANY_RESERVATION (default),SPECIFIC_RESERVATION, or NO_RESERVATION. See
5342 # Consuming reserved instances for examples.
5343 &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
5344 # the name of your reservation as its value.
5345 &quot;values&quot;: [ # Corresponds to the label values of a reservation resource. This can be
5346 # either a name to a reservation in the same project or
5347 # &quot;projects/different-project/reservations/some-reservation-name&quot; to target a
5348 # shared reservation in the same zone but in a different project.
5349 &quot;A String&quot;,
5350 ],
5351 },
5352 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the instance. Tag keys and values
5353 # have the same definition as resource
5354 # manager tags. Keys and values can be either in numeric format,
5355 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
5356 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
5357 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
5358 # PATCH) when empty.
5359 &quot;a_key&quot;: &quot;A String&quot;,
5360 },
5361 &quot;resourcePolicies&quot;: [ # Resource policies (names, not URLs) applied to instances created from
5362 # these properties.
5363 # Note that for MachineImage, this is not supported yet.
5364 &quot;A String&quot;,
5365 ],
5366 &quot;scheduling&quot;: { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from
5367 # these properties.
5368 &quot;automaticRestart&quot;: True or False, # Specifies whether the instance should be automatically restarted if it is
5369 # terminated by Compute Engine (not terminated by a user). You can only set
5370 # the automatic restart option for standard instances.Preemptible instances
5371 # cannot be automatically restarted.
5372 #
5373 # By default, this is set to true so an instance is
5374 # automatically restarted if it is terminated by Compute Engine.
5375 &quot;availabilityDomain&quot;: 42, # Specifies the availability domain to place the instance in. The value
5376 # must be a number between 1 and the number of availability domains
5377 # specified in the spread placement policy attached to the instance.
5378 &quot;gracefulShutdown&quot;: { # The configuration for gracefully shutting down the instance.
5379 &quot;enabled&quot;: True or False, # Opts-in for graceful shutdown.
5380 &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
5381 # graceful shutdown isn&#x27;t complete after this time, then the instance
5382 # transitions to the STOPPING state.
5383 # as a count of seconds and fractions of seconds at nanosecond
5384 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
5385 # or &quot;month&quot;. Range is approximately 10,000 years.
5386 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
5387 # Durations less than one second are represented with a 0
5388 # `seconds` field and a positive `nanos` field. Must be from 0
5389 # to 999,999,999 inclusive.
5390 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
5391 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
5392 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
5393 },
5394 },
5395 &quot;hostErrorTimeoutSeconds&quot;: 42, # Specify the time in seconds for host error detection, the value must be
5396 # within the range of [90, 330] with the increment of 30, if unset, the
5397 # default behavior of host error recovery will be used.
5398 &quot;instanceTerminationAction&quot;: &quot;A String&quot;, # Specifies the termination action for the instance.
5399 &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
5400 # recovery of the Local Ssd state is attempted. Its value should be in
5401 # between 0 and 168 hours with hour granularity and the default value being 1
5402 # hour.
5403 # as a count of seconds and fractions of seconds at nanosecond
5404 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
5405 # or &quot;month&quot;. Range is approximately 10,000 years.
5406 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
5407 # Durations less than one second are represented with a 0
5408 # `seconds` field and a positive `nanos` field. Must be from 0
5409 # to 999,999,999 inclusive.
5410 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
5411 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
5412 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
5413 },
5414 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the instance close to other
5415 # resources.
5416 # This field is for use by internal tools that use the public API.
5417 &quot;maintenanceFreezeDurationHours&quot;: 42, # Specifies the number of hours after VM instance creation where the VM won&#x27;t
5418 # be scheduled for maintenance.
5419 &quot;maintenanceInterval&quot;: &quot;A String&quot;, # Specifies the frequency of planned maintenance events. The accepted values
5420 # are: `PERIODIC`.
5421 &quot;maxRunDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the max run duration for the given instance. If specified,
5422 # the instance termination action will be performed at the end of the run
5423 # duration.
5424 # as a count of seconds and fractions of seconds at nanosecond
5425 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
5426 # or &quot;month&quot;. Range is approximately 10,000 years.
5427 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
5428 # Durations less than one second are represented with a 0
5429 # `seconds` field and a positive `nanos` field. Must be from 0
5430 # to 999,999,999 inclusive.
5431 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
5432 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
5433 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
5434 },
5435 &quot;minNodeCpus&quot;: 42, # The minimum number of virtual CPUs this instance will consume when running
5436 # on a sole-tenant node.
5437 &quot;nodeAffinities&quot;: [ # A set of node affinity and anti-affinity configurations. Refer toConfiguring node
5438 # affinity for more information.
5439 # Overrides reservationAffinity.
5440 { # Node Affinity: the configuration of desired nodes onto which this Instance
5441 # could be scheduled.
5442 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of Node resource.
5443 &quot;operator&quot;: &quot;A String&quot;, # Defines the operation of node selection. Valid operators areIN for affinity and NOT_IN for anti-affinity.
5444 &quot;values&quot;: [ # Corresponds to the label values of Node resource.
5445 &quot;A String&quot;,
5446 ],
5447 },
5448 ],
5449 &quot;onHostMaintenance&quot;: &quot;A String&quot;, # Defines the maintenance behavior for this instance. For standard instances,
5450 # the default behavior is MIGRATE. Forpreemptible instances,
5451 # the default and only possible behavior is TERMINATE. For more
5452 # information, see
5453 # Set
5454 # VM host maintenance policy.
5455 &quot;onInstanceStopAction&quot;: { # Defines the behaviour for instances with the instance_termination_actionSTOP.
5456 &quot;discardLocalSsd&quot;: True or False, # If true, the contents of any attached Local SSD disks will be discarded
5457 # else, the Local SSD data will be preserved when the instance is stopped
5458 # at the end of the run duration/termination time.
5459 },
5460 &quot;preemptible&quot;: True or False, # Defines whether the instance is preemptible. This can only be set during
5461 # instance creation or while the instance isstopped and
5462 # therefore, in a `TERMINATED` state. SeeInstance Life
5463 # Cycle for more information on the possible instance states.
5464 &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
5465 # Off signal is triggered for Spot
5466 # VMs only. If not specified, there will be no wait before the G2 Soft
5467 # Off signal is triggered.
5468 # as a count of seconds and fractions of seconds at nanosecond
5469 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
5470 # or &quot;month&quot;. Range is approximately 10,000 years.
5471 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
5472 # Durations less than one second are represented with a 0
5473 # `seconds` field and a positive `nanos` field. Must be from 0
5474 # to 999,999,999 inclusive.
5475 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
5476 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
5477 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
5478 },
5479 &quot;provisioningModel&quot;: &quot;A String&quot;, # Specifies the provisioning model of the instance.
5480 &quot;skipGuestOsShutdown&quot;: True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
5481 # Off and ACPI G3 Mechanical
5482 # Off for Standard VMs and 30 seconds for Spot VMs.
5483 &quot;terminationTime&quot;: &quot;A String&quot;, # Specifies the timestamp, when the instance will be terminated, inRFC3339 text format. If specified, the instance
5484 # termination action will be performed at the termination time.
5485 },
5486 &quot;serviceAccounts&quot;: [ # A list of service accounts with specified scopes. Access tokens for these
5487 # service accounts are available to the instances that are created from
5488 # these properties. Use metadata queries to obtain the access tokens for
5489 # these instances.
5490 { # A service account.
5491 &quot;email&quot;: &quot;A String&quot;, # Email address of the service account.
5492 &quot;scopes&quot;: [ # The list of scopes to be made available for this service account.
5493 &quot;A String&quot;,
5494 ],
5495 },
5496 ],
5497 &quot;shieldedInstanceConfig&quot;: { # A set of Shielded Instance options. # Note that for MachineImage, this is not supported yet.
5498 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.Enabled by
5499 # default.
5500 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.Disabled by
5501 # default.
5502 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.Enabled by
5503 # default.
5504 },
5505 &quot;shieldedVmConfig&quot;: { # A set of Shielded VM options. # Specifies the Shielded VM options for the instances that are created from
5506 # these properties.
5507 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.
5508 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.
5509 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.
5510 },
5511 &quot;tags&quot;: { # A set of instance tags. # A list of tags to apply to the instances that are created from these
5512 # properties. The tags identify valid sources or targets for network
5513 # firewalls. The setTags method can modify this list of tags. Each tag within
5514 # the list must comply with RFC1035.
5515 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of
5516 # the tags&#x27; contents and used for optimistic locking. The
5517 # fingerprint is initially generated by Compute Engine and changes after
5518 # every request to modify or update tags. You must always provide an
5519 # up-to-date fingerprint hash in order to update or change tags.
5520 #
5521 # To see the latest fingerprint, make get() request to the
5522 # instance.
5523 &quot;items&quot;: [ # An array of tags. Each tag must be 1-63 characters long, and comply
5524 # with RFC1035.
5525 &quot;A String&quot;,
5526 ],
5527 },
5528 &quot;workloadIdentityConfig&quot;: {
5529 &quot;identity&quot;: &quot;A String&quot;,
5530 &quot;identityCertificateEnabled&quot;: True or False,
5531 },
5532 },
5533 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the instance template resides. Only
5534 # applicable for regional resources.
5535 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL for this instance template. The server defines this
5536 # URL.
5537 &quot;sourceInstance&quot;: &quot;A String&quot;, # The source instance used to create the template. You can provide this as a
5538 # partial or full URL to the resource. For example, the following are valid
5539 # values:
5540 #
5541 #
5542 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
5543 # - projects/project/zones/zone/instances/instance
5544 &quot;sourceInstanceParams&quot;: { # A specification of the parameters to use when creating the instance template # The source instance params to use to create this instance template.
5545 # from a source instance.
5546 &quot;diskConfigs&quot;: [ # Attached disks configuration. If not provided, defaults are applied:
5547 # For boot disk and any other R/W disks, the source images for each disk
5548 # will be used. For read-only disks, they will be attached in read-only
5549 # mode. Local SSD disks will be created as blank volumes.
5550 { # A specification of the desired way to instantiate a disk in the instance
5551 # template when its created from a source instance.
5552 &quot;autoDelete&quot;: True or False, # Specifies whether the disk will be auto-deleted when the instance is
5553 # deleted (but not when the disk is detached from the instance).
5554 &quot;customImage&quot;: &quot;A String&quot;, # The custom source image to be used to restore this disk when instantiating
5555 # this instance template.
5556 &quot;deviceName&quot;: &quot;A String&quot;, # Specifies the device name of the disk to which the configurations apply to.
5557 &quot;instantiateFrom&quot;: &quot;A String&quot;, # Specifies whether to include the disk and what image to use. Possible
5558 # values are:
5559 #
5560 #
5561 # - source-image: to use the same image that was used to
5562 # create the source instance&#x27;s corresponding disk. Applicable to the boot
5563 # disk and additional read-write disks.
5564 # - source-image-family: to use the same image family that
5565 # was used to create the source instance&#x27;s corresponding disk. Applicable
5566 # to the boot disk and additional read-write disks.
5567 # - custom-image: to use a user-provided image url for disk
5568 # creation. Applicable to the boot disk and additional read-write
5569 # disks.
5570 # - attach-read-only: to attach a read-only
5571 # disk. Applicable to read-only disks.
5572 # - do-not-include: to exclude a disk from the template.
5573 # Applicable to additional read-write disks, local SSDs, and read-only
5574 # disks.
5575 },
5576 ],
5577 },
5578 },
5579 ],
5580 &quot;kind&quot;: &quot;compute#instanceTemplateList&quot;, # Output only. [Output Only] The resource type, which is alwayscompute#instanceTemplatesListResponse for instance template
5581 # lists.
5582 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
5583 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
5584 # the query parameter pageToken in the next list request.
5585 # Subsequent list requests will have their own nextPageToken to
5586 # continue paging through the results.
5587 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
5588 &quot;warning&quot;: { # [Output Only] Informational warning message.
5589 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
5590 # Engine returns NO_RESULTS_ON_PAGE if there
5591 # are no results in the response.
5592 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
5593 # value format. For example:
5594 #
5595 # &quot;data&quot;: [
5596 # {
5597 # &quot;key&quot;: &quot;scope&quot;,
5598 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
5599 # }
5600 {
5601 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
5602 # returned. For example, for warnings where there are no results in a list
5603 # request for a particular zone, this key might be scope and
5604 # the key value might be the zone name. Other examples might be a key
5605 # indicating a deprecated resource and a suggested replacement, or a
5606 # warning about invalid network settings (for example, if an instance
5607 # attempts to perform IP forwarding but is not enabled for IP forwarding).
5608 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
5609 },
5610 ],
5611 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
5612 },
5613 }</pre>
5614 </div>
5615
5616 <div class="method">
5617 <code class="details" id="list_next">list_next()</code>
5618 <pre>Retrieves the next page of results.
5619
5620 Args:
5621 previous_request: The request for the previous page. (required)
5622 previous_response: The response from the request for the previous page. (required)
5623
5624 Returns:
5625 A request object that you can call &#x27;execute()&#x27; on to request the next
5626 page. Returns None if there are no more items in the collection.
5627 </pre>
5628 </div>
5629
5630 <div class="method">
5631 <code class="details" id="setIamPolicy">setIamPolicy(project, resource, body=None, x__xgafv=None)</code>
5632 <pre>Sets the access control policy on the specified resource.
5633 Replaces any existing policy.
5634
5635 Args:
5636 project: string, Project ID for this request. (required)
5637 resource: string, Name or id of the resource for this request. (required)
5638 body: object, The request body.
5639 The object takes the form of:
5640
5641 {
5642 &quot;bindings&quot;: [ # Flatten Policy to create a backward compatible wire-format.
5643 # Deprecated. Use &#x27;policy&#x27; to specify bindings.
5644 { # Associates `members`, or principals, with a `role`.
5645 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
5646 #
5647 # If the condition evaluates to `true`, then this binding applies to the
5648 # current request.
5649 #
5650 # If the condition evaluates to `false`, then this binding does not apply to
5651 # the current request. However, a different role binding might grant the same
5652 # role to one or more of the principals in this binding.
5653 #
5654 # To learn which resources support conditions in their IAM policies, see the
5655 # [IAM
5656 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
5657 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
5658 # are documented at https://github.com/google/cel-spec.
5659 #
5660 # Example (Comparison):
5661 #
5662 # title: &quot;Summary size limit&quot;
5663 # description: &quot;Determines if a summary is less than 100 chars&quot;
5664 # expression: &quot;document.summary.size() &lt; 100&quot;
5665 #
5666 # Example (Equality):
5667 #
5668 # title: &quot;Requestor is owner&quot;
5669 # description: &quot;Determines if requestor is the document owner&quot;
5670 # expression: &quot;document.owner == request.auth.claims.email&quot;
5671 #
5672 # Example (Logic):
5673 #
5674 # title: &quot;Public documents&quot;
5675 # description: &quot;Determine whether the document should be publicly visible&quot;
5676 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
5677 #
5678 # Example (Data Manipulation):
5679 #
5680 # title: &quot;Notification string&quot;
5681 # description: &quot;Create a notification string with a timestamp.&quot;
5682 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
5683 #
5684 # The exact variables and functions that may be referenced within an expression
5685 # are determined by the service that evaluates it. See the service
5686 # documentation for additional information.
5687 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
5688 # describes the expression, e.g. when hovered over it in a UI.
5689 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
5690 # syntax.
5691 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
5692 # reporting, e.g. a file name and a position in the file.
5693 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
5694 # its purpose. This can be used e.g. in UIs which allow to enter the
5695 # expression.
5696 },
5697 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
5698 # `members` can have the following values:
5699 #
5700 # * `allUsers`: A special identifier that represents anyone who is
5701 # on the internet; with or without a Google account.
5702 #
5703 # * `allAuthenticatedUsers`: A special identifier that represents anyone
5704 # who is authenticated with a Google account or a service account.
5705 # Does not include identities that come from external identity providers
5706 # (IdPs) through identity federation.
5707 #
5708 # * `user:{emailid}`: An email address that represents a specific Google
5709 # account. For example, `[email protected]` .
5710 #
5711 #
5712 # * `serviceAccount:{emailid}`: An email address that represents a Google
5713 # service account. For example,
5714 # `[email protected]`.
5715 #
5716 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
5717 # identifier for a
5718 # [Kubernetes service
5719 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
5720 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
5721 #
5722 # * `group:{emailid}`: An email address that represents a Google group.
5723 # For example, `[email protected]`.
5724 #
5725 #
5726 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
5727 # users of that domain. For example, `google.com` or `example.com`.
5728 #
5729 #
5730 #
5731 #
5732 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
5733 # A single identity in a workforce identity pool.
5734 #
5735 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
5736 # All workforce identities in a group.
5737 #
5738 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
5739 # All workforce identities with a specific attribute value.
5740 #
5741 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
5742 # All identities in a workforce identity pool.
5743 #
5744 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
5745 # A single identity in a workload identity pool.
5746 #
5747 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
5748 # A workload identity pool group.
5749 #
5750 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
5751 # All identities in a workload identity pool with a certain attribute.
5752 #
5753 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
5754 # All identities in a workload identity pool.
5755 #
5756 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
5757 # identifier) representing a user that has been recently deleted. For
5758 # example, `[email protected]?uid=123456789012345678901`. If the user is
5759 # recovered, this value reverts to `user:{emailid}` and the recovered user
5760 # retains the role in the binding.
5761 #
5762 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
5763 # unique identifier) representing a service account that has been recently
5764 # deleted. For example,
5765 # `[email protected]?uid=123456789012345678901`.
5766 # If the service account is undeleted, this value reverts to
5767 # `serviceAccount:{emailid}` and the undeleted service account retains the
5768 # role in the binding.
5769 #
5770 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
5771 # identifier) representing a Google group that has been recently
5772 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
5773 # the group is recovered, this value reverts to `group:{emailid}` and the
5774 # recovered group retains the role in the binding.
5775 #
5776 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
5777 # Deleted single identity in a workforce identity pool. For example,
5778 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
5779 &quot;A String&quot;,
5780 ],
5781 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
5782 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
5783 #
5784 # For an overview of the IAM roles and permissions, see the
5785 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
5786 # a list of the available pre-defined roles, see
5787 # [here](https://cloud.google.com/iam/docs/understanding-roles).
5788 },
5789 ],
5790 &quot;etag&quot;: &quot;A String&quot;, # Flatten Policy to create a backward compatible wire-format.
5791 # Deprecated. Use &#x27;policy&#x27; to specify the etag.
5792 &quot;policy&quot;: { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the &#x27;resource&#x27;. The size of
5793 # the policy is limited to a few 10s of KB. An empty policy is in general a
5794 # valid policy but certain services (like Projects) might reject them.
5795 # controls for Google Cloud resources.
5796 #
5797 #
5798 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
5799 # `members`, or principals, to a single `role`. Principals can be user
5800 # accounts, service accounts, Google groups, and domains (such as G Suite). A
5801 # `role` is a named list of permissions; each `role` can be an IAM predefined
5802 # role or a user-created custom role.
5803 #
5804 # For some types of Google Cloud resources, a `binding` can also specify a
5805 # `condition`, which is a logical expression that allows access to a resource
5806 # only if the expression evaluates to `true`. A condition can add constraints
5807 # based on attributes of the request, the resource, or both. To learn which
5808 # resources support conditions in their IAM policies, see the
5809 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
5810 #
5811 # **JSON example:**
5812 #
5813 # ```
5814 # {
5815 # &quot;bindings&quot;: [
5816 # {
5817 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
5818 # &quot;members&quot;: [
5819 # &quot;user:[email protected]&quot;,
5820 # &quot;group:[email protected]&quot;,
5821 # &quot;domain:google.com&quot;,
5822 # &quot;serviceAccount:[email protected]&quot;
5823 # ]
5824 # },
5825 # {
5826 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
5827 # &quot;members&quot;: [
5828 # &quot;user:[email protected]&quot;
5829 # ],
5830 # &quot;condition&quot;: {
5831 # &quot;title&quot;: &quot;expirable access&quot;,
5832 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
5833 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
5834 # }
5835 # }
5836 # ],
5837 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
5838 # &quot;version&quot;: 3
5839 # }
5840 # ```
5841 #
5842 # **YAML example:**
5843 #
5844 # ```
5845 # bindings:
5846 # - members:
5847 # - user:[email protected]
5848 # - group:[email protected]
5849 # - domain:google.com
5850 # - serviceAccount:[email protected]
5851 # role: roles/resourcemanager.organizationAdmin
5852 # - members:
5853 # - user:[email protected]
5854 # role: roles/resourcemanager.organizationViewer
5855 # condition:
5856 # title: expirable access
5857 # description: Does not grant access after Sep 2020
5858 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
5859 # etag: BwWWja0YfJA=
5860 # version: 3
5861 # ```
5862 #
5863 # For a description of IAM and its features, see the
5864 # [IAM documentation](https://cloud.google.com/iam/docs/).
5865 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
5866 { # Specifies the audit configuration for a service.
5867 # The configuration determines which permission types are logged, and what
5868 # identities, if any, are exempted from logging.
5869 # An AuditConfig must have one or more AuditLogConfigs.
5870 #
5871 # If there are AuditConfigs for both `allServices` and a specific service,
5872 # the union of the two AuditConfigs is used for that service: the log_types
5873 # specified in each AuditConfig are enabled, and the exempted_members in each
5874 # AuditLogConfig are exempted.
5875 #
5876 # Example Policy with multiple AuditConfigs:
5877 #
5878 # {
5879 # &quot;audit_configs&quot;: [
5880 # {
5881 # &quot;service&quot;: &quot;allServices&quot;,
5882 # &quot;audit_log_configs&quot;: [
5883 # {
5884 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
5885 # &quot;exempted_members&quot;: [
5886 # &quot;user:[email protected]&quot;
5887 # ]
5888 # },
5889 # {
5890 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
5891 # },
5892 # {
5893 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
5894 # }
5895 # ]
5896 # },
5897 # {
5898 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
5899 # &quot;audit_log_configs&quot;: [
5900 # {
5901 # &quot;log_type&quot;: &quot;DATA_READ&quot;
5902 # },
5903 # {
5904 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
5905 # &quot;exempted_members&quot;: [
5906 # &quot;user:[email protected]&quot;
5907 # ]
5908 # }
5909 # ]
5910 # }
5911 # ]
5912 # }
5913 #
5914 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
5915 # logging. It also exempts `[email protected]` from DATA_READ logging, and
5916 # `[email protected]` from DATA_WRITE logging.
5917 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
5918 { # Provides the configuration for logging a type of permissions.
5919 # Example:
5920 #
5921 # {
5922 # &quot;audit_log_configs&quot;: [
5923 # {
5924 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
5925 # &quot;exempted_members&quot;: [
5926 # &quot;user:[email protected]&quot;
5927 # ]
5928 # },
5929 # {
5930 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
5931 # }
5932 # ]
5933 # }
5934 #
5935 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
5936 # [email protected] from DATA_READ logging.
5937 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
5938 # permission.
5939 # Follows the same format of Binding.members.
5940 &quot;A String&quot;,
5941 ],
5942 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
5943 },
5944 ],
5945 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
5946 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
5947 # `allServices` is a special value that covers all services.
5948 },
5949 ],
5950 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
5951 # may specify a `condition` that determines how and when the `bindings` are
5952 # applied. Each of the `bindings` must contain at least one principal.
5953 #
5954 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
5955 # of these principals can be Google groups. Each occurrence of a principal
5956 # counts towards these limits. For example, if the `bindings` grant 50
5957 # different roles to `user:[email protected]`, and not to any other
5958 # principal, then you can add another 1,450 principals to the `bindings` in
5959 # the `Policy`.
5960 { # Associates `members`, or principals, with a `role`.
5961 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
5962 #
5963 # If the condition evaluates to `true`, then this binding applies to the
5964 # current request.
5965 #
5966 # If the condition evaluates to `false`, then this binding does not apply to
5967 # the current request. However, a different role binding might grant the same
5968 # role to one or more of the principals in this binding.
5969 #
5970 # To learn which resources support conditions in their IAM policies, see the
5971 # [IAM
5972 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
5973 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
5974 # are documented at https://github.com/google/cel-spec.
5975 #
5976 # Example (Comparison):
5977 #
5978 # title: &quot;Summary size limit&quot;
5979 # description: &quot;Determines if a summary is less than 100 chars&quot;
5980 # expression: &quot;document.summary.size() &lt; 100&quot;
5981 #
5982 # Example (Equality):
5983 #
5984 # title: &quot;Requestor is owner&quot;
5985 # description: &quot;Determines if requestor is the document owner&quot;
5986 # expression: &quot;document.owner == request.auth.claims.email&quot;
5987 #
5988 # Example (Logic):
5989 #
5990 # title: &quot;Public documents&quot;
5991 # description: &quot;Determine whether the document should be publicly visible&quot;
5992 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
5993 #
5994 # Example (Data Manipulation):
5995 #
5996 # title: &quot;Notification string&quot;
5997 # description: &quot;Create a notification string with a timestamp.&quot;
5998 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
5999 #
6000 # The exact variables and functions that may be referenced within an expression
6001 # are determined by the service that evaluates it. See the service
6002 # documentation for additional information.
6003 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
6004 # describes the expression, e.g. when hovered over it in a UI.
6005 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
6006 # syntax.
6007 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
6008 # reporting, e.g. a file name and a position in the file.
6009 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
6010 # its purpose. This can be used e.g. in UIs which allow to enter the
6011 # expression.
6012 },
6013 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
6014 # `members` can have the following values:
6015 #
6016 # * `allUsers`: A special identifier that represents anyone who is
6017 # on the internet; with or without a Google account.
6018 #
6019 # * `allAuthenticatedUsers`: A special identifier that represents anyone
6020 # who is authenticated with a Google account or a service account.
6021 # Does not include identities that come from external identity providers
6022 # (IdPs) through identity federation.
6023 #
6024 # * `user:{emailid}`: An email address that represents a specific Google
6025 # account. For example, `[email protected]` .
6026 #
6027 #
6028 # * `serviceAccount:{emailid}`: An email address that represents a Google
6029 # service account. For example,
6030 # `[email protected]`.
6031 #
6032 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
6033 # identifier for a
6034 # [Kubernetes service
6035 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
6036 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
6037 #
6038 # * `group:{emailid}`: An email address that represents a Google group.
6039 # For example, `[email protected]`.
6040 #
6041 #
6042 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
6043 # users of that domain. For example, `google.com` or `example.com`.
6044 #
6045 #
6046 #
6047 #
6048 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
6049 # A single identity in a workforce identity pool.
6050 #
6051 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
6052 # All workforce identities in a group.
6053 #
6054 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
6055 # All workforce identities with a specific attribute value.
6056 #
6057 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
6058 # All identities in a workforce identity pool.
6059 #
6060 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
6061 # A single identity in a workload identity pool.
6062 #
6063 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
6064 # A workload identity pool group.
6065 #
6066 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
6067 # All identities in a workload identity pool with a certain attribute.
6068 #
6069 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
6070 # All identities in a workload identity pool.
6071 #
6072 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
6073 # identifier) representing a user that has been recently deleted. For
6074 # example, `[email protected]?uid=123456789012345678901`. If the user is
6075 # recovered, this value reverts to `user:{emailid}` and the recovered user
6076 # retains the role in the binding.
6077 #
6078 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
6079 # unique identifier) representing a service account that has been recently
6080 # deleted. For example,
6081 # `[email protected]?uid=123456789012345678901`.
6082 # If the service account is undeleted, this value reverts to
6083 # `serviceAccount:{emailid}` and the undeleted service account retains the
6084 # role in the binding.
6085 #
6086 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
6087 # identifier) representing a Google group that has been recently
6088 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
6089 # the group is recovered, this value reverts to `group:{emailid}` and the
6090 # recovered group retains the role in the binding.
6091 #
6092 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
6093 # Deleted single identity in a workforce identity pool. For example,
6094 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
6095 &quot;A String&quot;,
6096 ],
6097 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
6098 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
6099 #
6100 # For an overview of the IAM roles and permissions, see the
6101 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
6102 # a list of the available pre-defined roles, see
6103 # [here](https://cloud.google.com/iam/docs/understanding-roles).
6104 },
6105 ],
6106 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
6107 # prevent simultaneous updates of a policy from overwriting each other.
6108 # It is strongly suggested that systems make use of the `etag` in the
6109 # read-modify-write cycle to perform policy updates in order to avoid race
6110 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
6111 # systems are expected to put that etag in the request to `setIamPolicy` to
6112 # ensure that their change will be applied to the same version of the policy.
6113 #
6114 # **Important:** If you use IAM Conditions, you must include the `etag` field
6115 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
6116 # you to overwrite a version `3` policy with a version `1` policy, and all of
6117 # the conditions in the version `3` policy are lost.
6118 &quot;version&quot;: 42, # Specifies the format of the policy.
6119 #
6120 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
6121 # are rejected.
6122 #
6123 # Any operation that affects conditional role bindings must specify version
6124 # `3`. This requirement applies to the following operations:
6125 #
6126 # * Getting a policy that includes a conditional role binding
6127 # * Adding a conditional role binding to a policy
6128 # * Changing a conditional role binding in a policy
6129 # * Removing any role binding, with or without a condition, from a policy
6130 # that includes conditions
6131 #
6132 # **Important:** If you use IAM Conditions, you must include the `etag` field
6133 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
6134 # you to overwrite a version `3` policy with a version `1` policy, and all of
6135 # the conditions in the version `3` policy are lost.
6136 #
6137 # If a policy does not include any conditions, operations on that policy may
6138 # specify any valid version or leave the field unset.
6139 #
6140 # To learn which resources support conditions in their IAM policies, see the
6141 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
6142 },
6143 }
6144
6145 x__xgafv: string, V1 error format.
6146 Allowed values
6147 1 - v1 error format
6148 2 - v2 error format
6149
6150 Returns:
6151 An object of the form:
6152
6153 { # An Identity and Access Management (IAM) policy, which specifies access
6154 # controls for Google Cloud resources.
6155 #
6156 #
6157 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
6158 # `members`, or principals, to a single `role`. Principals can be user
6159 # accounts, service accounts, Google groups, and domains (such as G Suite). A
6160 # `role` is a named list of permissions; each `role` can be an IAM predefined
6161 # role or a user-created custom role.
6162 #
6163 # For some types of Google Cloud resources, a `binding` can also specify a
6164 # `condition`, which is a logical expression that allows access to a resource
6165 # only if the expression evaluates to `true`. A condition can add constraints
6166 # based on attributes of the request, the resource, or both. To learn which
6167 # resources support conditions in their IAM policies, see the
6168 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
6169 #
6170 # **JSON example:**
6171 #
6172 # ```
6173 # {
6174 # &quot;bindings&quot;: [
6175 # {
6176 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
6177 # &quot;members&quot;: [
6178 # &quot;user:[email protected]&quot;,
6179 # &quot;group:[email protected]&quot;,
6180 # &quot;domain:google.com&quot;,
6181 # &quot;serviceAccount:[email protected]&quot;
6182 # ]
6183 # },
6184 # {
6185 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
6186 # &quot;members&quot;: [
6187 # &quot;user:[email protected]&quot;
6188 # ],
6189 # &quot;condition&quot;: {
6190 # &quot;title&quot;: &quot;expirable access&quot;,
6191 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
6192 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
6193 # }
6194 # }
6195 # ],
6196 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
6197 # &quot;version&quot;: 3
6198 # }
6199 # ```
6200 #
6201 # **YAML example:**
6202 #
6203 # ```
6204 # bindings:
6205 # - members:
6206 # - user:[email protected]
6207 # - group:[email protected]
6208 # - domain:google.com
6209 # - serviceAccount:[email protected]
6210 # role: roles/resourcemanager.organizationAdmin
6211 # - members:
6212 # - user:[email protected]
6213 # role: roles/resourcemanager.organizationViewer
6214 # condition:
6215 # title: expirable access
6216 # description: Does not grant access after Sep 2020
6217 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
6218 # etag: BwWWja0YfJA=
6219 # version: 3
6220 # ```
6221 #
6222 # For a description of IAM and its features, see the
6223 # [IAM documentation](https://cloud.google.com/iam/docs/).
6224 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
6225 { # Specifies the audit configuration for a service.
6226 # The configuration determines which permission types are logged, and what
6227 # identities, if any, are exempted from logging.
6228 # An AuditConfig must have one or more AuditLogConfigs.
6229 #
6230 # If there are AuditConfigs for both `allServices` and a specific service,
6231 # the union of the two AuditConfigs is used for that service: the log_types
6232 # specified in each AuditConfig are enabled, and the exempted_members in each
6233 # AuditLogConfig are exempted.
6234 #
6235 # Example Policy with multiple AuditConfigs:
6236 #
6237 # {
6238 # &quot;audit_configs&quot;: [
6239 # {
6240 # &quot;service&quot;: &quot;allServices&quot;,
6241 # &quot;audit_log_configs&quot;: [
6242 # {
6243 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
6244 # &quot;exempted_members&quot;: [
6245 # &quot;user:[email protected]&quot;
6246 # ]
6247 # },
6248 # {
6249 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
6250 # },
6251 # {
6252 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
6253 # }
6254 # ]
6255 # },
6256 # {
6257 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
6258 # &quot;audit_log_configs&quot;: [
6259 # {
6260 # &quot;log_type&quot;: &quot;DATA_READ&quot;
6261 # },
6262 # {
6263 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
6264 # &quot;exempted_members&quot;: [
6265 # &quot;user:[email protected]&quot;
6266 # ]
6267 # }
6268 # ]
6269 # }
6270 # ]
6271 # }
6272 #
6273 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
6274 # logging. It also exempts `[email protected]` from DATA_READ logging, and
6275 # `[email protected]` from DATA_WRITE logging.
6276 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
6277 { # Provides the configuration for logging a type of permissions.
6278 # Example:
6279 #
6280 # {
6281 # &quot;audit_log_configs&quot;: [
6282 # {
6283 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
6284 # &quot;exempted_members&quot;: [
6285 # &quot;user:[email protected]&quot;
6286 # ]
6287 # },
6288 # {
6289 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
6290 # }
6291 # ]
6292 # }
6293 #
6294 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
6295 # [email protected] from DATA_READ logging.
6296 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
6297 # permission.
6298 # Follows the same format of Binding.members.
6299 &quot;A String&quot;,
6300 ],
6301 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
6302 },
6303 ],
6304 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
6305 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
6306 # `allServices` is a special value that covers all services.
6307 },
6308 ],
6309 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
6310 # may specify a `condition` that determines how and when the `bindings` are
6311 # applied. Each of the `bindings` must contain at least one principal.
6312 #
6313 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
6314 # of these principals can be Google groups. Each occurrence of a principal
6315 # counts towards these limits. For example, if the `bindings` grant 50
6316 # different roles to `user:[email protected]`, and not to any other
6317 # principal, then you can add another 1,450 principals to the `bindings` in
6318 # the `Policy`.
6319 { # Associates `members`, or principals, with a `role`.
6320 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
6321 #
6322 # If the condition evaluates to `true`, then this binding applies to the
6323 # current request.
6324 #
6325 # If the condition evaluates to `false`, then this binding does not apply to
6326 # the current request. However, a different role binding might grant the same
6327 # role to one or more of the principals in this binding.
6328 #
6329 # To learn which resources support conditions in their IAM policies, see the
6330 # [IAM
6331 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
6332 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
6333 # are documented at https://github.com/google/cel-spec.
6334 #
6335 # Example (Comparison):
6336 #
6337 # title: &quot;Summary size limit&quot;
6338 # description: &quot;Determines if a summary is less than 100 chars&quot;
6339 # expression: &quot;document.summary.size() &lt; 100&quot;
6340 #
6341 # Example (Equality):
6342 #
6343 # title: &quot;Requestor is owner&quot;
6344 # description: &quot;Determines if requestor is the document owner&quot;
6345 # expression: &quot;document.owner == request.auth.claims.email&quot;
6346 #
6347 # Example (Logic):
6348 #
6349 # title: &quot;Public documents&quot;
6350 # description: &quot;Determine whether the document should be publicly visible&quot;
6351 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
6352 #
6353 # Example (Data Manipulation):
6354 #
6355 # title: &quot;Notification string&quot;
6356 # description: &quot;Create a notification string with a timestamp.&quot;
6357 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
6358 #
6359 # The exact variables and functions that may be referenced within an expression
6360 # are determined by the service that evaluates it. See the service
6361 # documentation for additional information.
6362 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
6363 # describes the expression, e.g. when hovered over it in a UI.
6364 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
6365 # syntax.
6366 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
6367 # reporting, e.g. a file name and a position in the file.
6368 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
6369 # its purpose. This can be used e.g. in UIs which allow to enter the
6370 # expression.
6371 },
6372 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
6373 # `members` can have the following values:
6374 #
6375 # * `allUsers`: A special identifier that represents anyone who is
6376 # on the internet; with or without a Google account.
6377 #
6378 # * `allAuthenticatedUsers`: A special identifier that represents anyone
6379 # who is authenticated with a Google account or a service account.
6380 # Does not include identities that come from external identity providers
6381 # (IdPs) through identity federation.
6382 #
6383 # * `user:{emailid}`: An email address that represents a specific Google
6384 # account. For example, `[email protected]` .
6385 #
6386 #
6387 # * `serviceAccount:{emailid}`: An email address that represents a Google
6388 # service account. For example,
6389 # `[email protected]`.
6390 #
6391 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
6392 # identifier for a
6393 # [Kubernetes service
6394 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
6395 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
6396 #
6397 # * `group:{emailid}`: An email address that represents a Google group.
6398 # For example, `[email protected]`.
6399 #
6400 #
6401 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
6402 # users of that domain. For example, `google.com` or `example.com`.
6403 #
6404 #
6405 #
6406 #
6407 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
6408 # A single identity in a workforce identity pool.
6409 #
6410 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
6411 # All workforce identities in a group.
6412 #
6413 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
6414 # All workforce identities with a specific attribute value.
6415 #
6416 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
6417 # All identities in a workforce identity pool.
6418 #
6419 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
6420 # A single identity in a workload identity pool.
6421 #
6422 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
6423 # A workload identity pool group.
6424 #
6425 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
6426 # All identities in a workload identity pool with a certain attribute.
6427 #
6428 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
6429 # All identities in a workload identity pool.
6430 #
6431 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
6432 # identifier) representing a user that has been recently deleted. For
6433 # example, `[email protected]?uid=123456789012345678901`. If the user is
6434 # recovered, this value reverts to `user:{emailid}` and the recovered user
6435 # retains the role in the binding.
6436 #
6437 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
6438 # unique identifier) representing a service account that has been recently
6439 # deleted. For example,
6440 # `[email protected]?uid=123456789012345678901`.
6441 # If the service account is undeleted, this value reverts to
6442 # `serviceAccount:{emailid}` and the undeleted service account retains the
6443 # role in the binding.
6444 #
6445 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
6446 # identifier) representing a Google group that has been recently
6447 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
6448 # the group is recovered, this value reverts to `group:{emailid}` and the
6449 # recovered group retains the role in the binding.
6450 #
6451 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
6452 # Deleted single identity in a workforce identity pool. For example,
6453 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
6454 &quot;A String&quot;,
6455 ],
6456 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
6457 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
6458 #
6459 # For an overview of the IAM roles and permissions, see the
6460 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
6461 # a list of the available pre-defined roles, see
6462 # [here](https://cloud.google.com/iam/docs/understanding-roles).
6463 },
6464 ],
6465 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
6466 # prevent simultaneous updates of a policy from overwriting each other.
6467 # It is strongly suggested that systems make use of the `etag` in the
6468 # read-modify-write cycle to perform policy updates in order to avoid race
6469 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
6470 # systems are expected to put that etag in the request to `setIamPolicy` to
6471 # ensure that their change will be applied to the same version of the policy.
6472 #
6473 # **Important:** If you use IAM Conditions, you must include the `etag` field
6474 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
6475 # you to overwrite a version `3` policy with a version `1` policy, and all of
6476 # the conditions in the version `3` policy are lost.
6477 &quot;version&quot;: 42, # Specifies the format of the policy.
6478 #
6479 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
6480 # are rejected.
6481 #
6482 # Any operation that affects conditional role bindings must specify version
6483 # `3`. This requirement applies to the following operations:
6484 #
6485 # * Getting a policy that includes a conditional role binding
6486 # * Adding a conditional role binding to a policy
6487 # * Changing a conditional role binding in a policy
6488 # * Removing any role binding, with or without a condition, from a policy
6489 # that includes conditions
6490 #
6491 # **Important:** If you use IAM Conditions, you must include the `etag` field
6492 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
6493 # you to overwrite a version `3` policy with a version `1` policy, and all of
6494 # the conditions in the version `3` policy are lost.
6495 #
6496 # If a policy does not include any conditions, operations on that policy may
6497 # specify any valid version or leave the field unset.
6498 #
6499 # To learn which resources support conditions in their IAM policies, see the
6500 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
6501 }</pre>
6502 </div>
6503
6504 <div class="method">
6505 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</code>
6506 <pre>Returns permissions that a caller has on the specified resource.
6507
6508 Args:
6509 project: string, Project ID for this request. (required)
6510 resource: string, Name or id of the resource for this request. (required)
6511 body: object, The request body.
6512 The object takes the form of:
6513
6514 {
6515 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with
6516 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
6517 &quot;A String&quot;,
6518 ],
6519 }
6520
6521 x__xgafv: string, V1 error format.
6522 Allowed values
6523 1 - v1 error format
6524 2 - v2 error format
6525
6526 Returns:
6527 An object of the form:
6528
6529 {
6530 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
6531 # allowed.
6532 &quot;A String&quot;,
6533 ],
6534 }</pre>
6535 </div>
6536
6537 </body></html>