Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c3f86757bccb6b42552f87d37a645651c58d6c7a / . / docs / dyn / compute_beta.instances.html
blob: 658a8a072b0b18b8f33144be5ace8aa8ced68ca4 [file] [log] [blame]
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="compute_beta.html">Compute Engine API</a> . <a href="compute_beta.instances.html">instances</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]78 <code><a href="#addAccessConfig">addAccessConfig(project, zone, instance, networkInterface, body=None, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]79<p class="firstline">Adds an access config to an instance's network interface.</p>
80<p class="toc_element">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]81 <code><a href="#addResourcePolicies">addResourcePolicies(project, zone, instance, body=None, requestId=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]82<p class="firstline">Adds existing resource policies to an instance. You can only add one policy right now which will be applied to this instance for scheduling live migrations.</p>
83<p class="toc_element">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]84 <code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]85<p class="firstline">Retrieves aggregated list of all of the instances in your project across all regions and zones.</p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]86<p class="toc_element">
87 <code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<p class="toc_element">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]90 <code><a href="#attachDisk">attachDisk(project, zone, instance, body=None, forceAttach=None, requestId=None)</a></code></p>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]91<p class="firstline">Attaches an existing Disk resource to an instance. You must first create the disk before you can attach it. It is not possible to create and attach a disk at the same time. For more information, read Adding a persistent disk to your instance.</p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]92<p class="toc_element">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]93 <code><a href="#bulkInsert">bulkInsert(project, zone, body=None, requestId=None)</a></code></p>
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]94<p class="firstline">Creates multiple instances. Count specifies the number of instances to create.</p>
95<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]96 <code><a href="#close">close()</a></code></p>
97<p class="firstline">Close httplib2 connections.</p>
98<p class="toc_element">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]99 <code><a href="#delete">delete(project, zone, instance, requestId=None)</a></code></p>
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame]100<p class="firstline">Deletes the specified Instance resource. For more information, see Deleting an instance.</p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]101<p class="toc_element">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]102 <code><a href="#deleteAccessConfig">deleteAccessConfig(project, zone, instance, accessConfig, networkInterface, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]103<p class="firstline">Deletes an access config from an instance's network interface.</p>
104<p class="toc_element">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]105 <code><a href="#detachDisk">detachDisk(project, zone, instance, deviceName, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]106<p class="firstline">Detaches a disk from an instance.</p>
107<p class="toc_element">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]108 <code><a href="#get">get(project, zone, instance)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]109<p class="firstline">Returns the specified Instance resource. Gets a list of available instances by making a list() request.</p>
110<p class="toc_element">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]111 <code><a href="#getEffectiveFirewalls">getEffectiveFirewalls(project, zone, instance, networkInterface)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]112<p class="firstline">Returns effective firewalls applied to an interface of the instance.</p>
113<p class="toc_element">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]114 <code><a href="#getGuestAttributes">getGuestAttributes(project, zone, instance, queryPath=None, variableKey=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]115<p class="firstline">Returns the specified guest attributes entry.</p>
116<p class="toc_element">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]117 <code><a href="#getIamPolicy">getIamPolicy(project, zone, resource, optionsRequestedPolicyVersion=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]118<p class="firstline">Gets the access control policy for a resource. May be empty if no such policy or resource exists.</p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]119<p class="toc_element">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]120 <code><a href="#getScreenshot">getScreenshot(project, zone, instance)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]121<p class="firstline">Returns the screenshot from the specified instance.</p>
122<p class="toc_element">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]123 <code><a href="#getSerialPortOutput">getSerialPortOutput(project, zone, instance, port=None, start=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]124<p class="firstline">Returns the last 1 MB of serial port output from the specified instance.</p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]125<p class="toc_element">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]126 <code><a href="#getShieldedInstanceIdentity">getShieldedInstanceIdentity(project, zone, instance)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]127<p class="firstline">Returns the Shielded Instance Identity of an instance</p>
128<p class="toc_element">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]129 <code><a href="#getShieldedVmIdentity">getShieldedVmIdentity(project, zone, instance)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]130<p class="firstline">Returns the Shielded VM Identity of an instance</p>
131<p class="toc_element">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]132 <code><a href="#insert">insert(project, zone, body=None, requestId=None, sourceInstanceTemplate=None, sourceMachineImage=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]133<p class="firstline">Creates an instance resource in the specified project using the data included in the request.</p>
134<p class="toc_element">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]135 <code><a href="#list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]136<p class="firstline">Retrieves the list of instances contained within the specified zone.</p>
137<p class="toc_element">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]138 <code><a href="#listReferrers">listReferrers(project, zone, instance, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]139<p class="firstline">Retrieves a list of resources that refer to the VM instance specified in the request. For example, if the VM instance is part of a managed or unmanaged instance group, the referrers list includes the instance group. For more information, read Viewing referrers to VM instances.</p>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]140<p class="toc_element">
141 <code><a href="#listReferrers_next">listReferrers_next(previous_request, previous_response)</a></code></p>
142<p class="firstline">Retrieves the next page of results.</p>
143<p class="toc_element">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]144 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
145<p class="firstline">Retrieves the next page of results.</p>
146<p class="toc_element">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]147 <code><a href="#removeResourcePolicies">removeResourcePolicies(project, zone, instance, body=None, requestId=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]148<p class="firstline">Removes resource policies from an instance.</p>
149<p class="toc_element">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]150 <code><a href="#reset">reset(project, zone, instance, requestId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]151<p class="firstline">Performs a reset on the instance. This is a hard reset the VM does not do a graceful shutdown. For more information, see Resetting an instance.</p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]152<p class="toc_element">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]153 <code><a href="#resume">resume(project, zone, instance, body=None, requestId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]154<p class="firstline">Resumes an instance that was suspended using the instances().suspend method.</p>
155<p class="toc_element">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]156 <code><a href="#setDeletionProtection">setDeletionProtection(project, zone, resource, deletionProtection=None, requestId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]157<p class="firstline">Sets deletion protection on the instance.</p>
158<p class="toc_element">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]159 <code><a href="#setDiskAutoDelete">setDiskAutoDelete(project, zone, instance, autoDelete, deviceName, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]160<p class="firstline">Sets the auto-delete flag for a disk attached to an instance.</p>
161<p class="toc_element">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]162 <code><a href="#setIamPolicy">setIamPolicy(project, zone, resource, body=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]163<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]164<p class="toc_element">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]165 <code><a href="#setLabels">setLabels(project, zone, instance, body=None, requestId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]166<p class="firstline">Sets labels on an instance. To learn more about labels, read the Labeling Resources documentation.</p>
167<p class="toc_element">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]168 <code><a href="#setMachineResources">setMachineResources(project, zone, instance, body=None, requestId=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]169<p class="firstline">Changes the number and/or type of accelerator for a stopped instance to the values specified in the request.</p>
170<p class="toc_element">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]171 <code><a href="#setMachineType">setMachineType(project, zone, instance, body=None, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]172<p class="firstline">Changes the machine type for a stopped instance to the machine type specified in the request.</p>
173<p class="toc_element">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]174 <code><a href="#setMetadata">setMetadata(project, zone, instance, body=None, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]175<p class="firstline">Sets metadata for the specified instance to the data included in the request.</p>
176<p class="toc_element">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]177 <code><a href="#setMinCpuPlatform">setMinCpuPlatform(project, zone, instance, body=None, requestId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]178<p class="firstline">Changes the minimum CPU platform that this instance should use. This method can only be called on a stopped instance. For more information, read Specifying a Minimum CPU Platform.</p>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]179<p class="toc_element">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]180 <code><a href="#setName">setName(project, zone, instance, body=None, requestId=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]181<p class="firstline">Sets name of an instance.</p>
182<p class="toc_element">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]183 <code><a href="#setScheduling">setScheduling(project, zone, instance, body=None, requestId=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]184<p class="firstline">Sets an instance's scheduling options. You can only call this method on a stopped instance, that is, a VM instance that is in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.</p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]185<p class="toc_element">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]186 <code><a href="#setServiceAccount">setServiceAccount(project, zone, instance, body=None, requestId=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]187<p class="firstline">Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance.</p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]188<p class="toc_element">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]189 <code><a href="#setShieldedInstanceIntegrityPolicy">setShieldedInstanceIntegrityPolicy(project, zone, instance, body=None, requestId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]190<p class="firstline">Sets the Shielded Instance integrity policy for an instance. You can only use this method on a running instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.</p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]191<p class="toc_element">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]192 <code><a href="#setShieldedVmIntegrityPolicy">setShieldedVmIntegrityPolicy(project, zone, instance, body=None, requestId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]193<p class="firstline">Sets the Shielded VM integrity policy for a VM instance. You can only use this method on a running VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.</p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]194<p class="toc_element">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]195 <code><a href="#setTags">setTags(project, zone, instance, body=None, requestId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]196<p class="firstline">Sets network tags for the specified instance to the data included in the request.</p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]197<p class="toc_element">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]198 <code><a href="#simulateMaintenanceEvent">simulateMaintenanceEvent(project, zone, instance)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]199<p class="firstline">Simulates a maintenance event on the instance.</p>
200<p class="toc_element">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]201 <code><a href="#start">start(project, zone, instance, requestId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]202<p class="firstline">Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance.</p>
203<p class="toc_element">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]204 <code><a href="#startWithEncryptionKey">startWithEncryptionKey(project, zone, instance, body=None, requestId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]205<p class="firstline">Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance.</p>
206<p class="toc_element">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]207 <code><a href="#stop">stop(project, zone, instance, requestId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]208<p class="firstline">Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur VM usage charges while they are stopped. However, resources that the VM is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance.</p>
209<p class="toc_element">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]210 <code><a href="#suspend">suspend(project, zone, instance, discardLocalSsd=None, requestId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]211<p class="firstline">This method suspends a running instance, saving its state to persistent storage, and allows you to resume the instance at a later time. Suspended instances incur reduced per-minute, virtual machine usage charges while they are suspended. Any resources the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted.</p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]212<p class="toc_element">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]213 <code><a href="#testIamPermissions">testIamPermissions(project, zone, resource, body=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]214<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]215<p class="toc_element">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]216 <code><a href="#update">update(project, zone, instance, body=None, minimalAction=None, mostDisruptiveAllowedAction=None, requestId=None)</a></code></p>
217<p class="firstline">Updates an instance only if the necessary resources are available. This method can update only a specific set of instance properties. See Updating a running instance for a list of updatable instance properties.</p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]218<p class="toc_element">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]219 <code><a href="#updateAccessConfig">updateAccessConfig(project, zone, instance, networkInterface, body=None, requestId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]220<p class="firstline">Updates the specified access config from an instance's network interface with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.</p>
221<p class="toc_element">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]222 <code><a href="#updateDisplayDevice">updateDisplayDevice(project, zone, instance, body=None, requestId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]223<p class="firstline">Updates the Display config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.</p>
224<p class="toc_element">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]225 <code><a href="#updateNetworkInterface">updateNetworkInterface(project, zone, instance, networkInterface, body=None, requestId=None)</a></code></p>
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]226<p class="firstline">Updates an instance's network interface. This method can only update an interface's alias IP range and attached network. See Modifying alias IP ranges for an existing instance for instructions on changing alias IP ranges. See Migrating a VM between networks for instructions on migrating an interface. This method follows PATCH semantics.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]227<p class="toc_element">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]228 <code><a href="#updateShieldedInstanceConfig">updateShieldedInstanceConfig(project, zone, instance, body=None, requestId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]229<p class="firstline">Updates the Shielded Instance config for an instance. You can only use this method on a stopped instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.</p>
230<p class="toc_element">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]231 <code><a href="#updateShieldedVmConfig">updateShieldedVmConfig(project, zone, instance, body=None, requestId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]232<p class="firstline">Updates the Shielded VM config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.</p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]233<h3>Method Details</h3>
234<div class="method">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]235 <code class="details" id="addAccessConfig">addAccessConfig(project, zone, instance, networkInterface, body=None, requestId=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]236 <pre>Adds an access config to an instance&#x27;s network interface.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]237
238Args:
239 project: string, Project ID for this request. (required)
240 zone: string, The name of the zone for this request. (required)
241 instance: string, The instance name for this request. (required)
242 networkInterface: string, The name of the network interface to add to this instance. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]243 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]244 The object takes the form of:
245
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]246{ # An access configuration attached to an instance&#x27;s network interface. Only one access config per instance is supported.
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700[diff] [blame]247 &quot;externalIpv6&quot;: &quot;A String&quot;, # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.
248 &quot;externalIpv6PrefixLength&quot;: 42, # [Output Only] The prefix length of the external IPv6 range.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]249 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
250 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access.
251 &quot;natIP&quot;: &quot;A String&quot;, # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]252 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.
253 #
254 # If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.
255 #
256 # If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]257 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.
258 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the external IP address of the instance to a DNS domain name.
259 &quot;type&quot;: &quot;ONE_TO_ONE_NAT&quot;, # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]260}
261
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]262 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
263
264For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
265
266The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]267
268Returns:
269 An object of the form:
270
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]271 { # Represents an Operation resource.
272 #
273 # Google Compute Engine has three Operation resources:
274 #
275 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
276 #
277 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
278 #
279 # Operations can be global, regional or zonal.
280 # - For global operations, use the `globalOperations` resource.
281 # - For regional operations, use the `regionOperations` resource.
282 # - For zonal operations, use the `zonalOperations` resource.
283 #
284 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]285 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
286 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
287 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
288 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
289 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
290 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]291 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]292 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
293 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
294 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]295 },
296 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]297 },
298 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
299 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
300 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
301 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
302 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
303 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]304 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]305 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
306 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
307 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
308 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
309 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
310 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
311 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
312 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
313 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
314 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
315 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
316 {
317 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]318 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
319 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]320 {
321 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
322 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
323 },
324 ],
325 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
326 },
327 ],
328 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
329}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]330</div>
331
332<div class="method">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]333 <code class="details" id="addResourcePolicies">addResourcePolicies(project, zone, instance, body=None, requestId=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]334 <pre>Adds existing resource policies to an instance. You can only add one policy right now which will be applied to this instance for scheduling live migrations.
335
336Args:
337 project: string, Project ID for this request. (required)
338 zone: string, The name of the zone for this request. (required)
339 instance: string, The instance name for this request. (required)
340 body: object, The request body.
341 The object takes the form of:
342
343{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]344 &quot;resourcePolicies&quot;: [ # Resource policies to be added to this instance.
345 &quot;A String&quot;,
346 ],
347}
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]348
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]349 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
350
351For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
352
353The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]354
355Returns:
356 An object of the form:
357
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]358 { # Represents an Operation resource.
359 #
360 # Google Compute Engine has three Operation resources:
361 #
362 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
363 #
364 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
365 #
366 # Operations can be global, regional or zonal.
367 # - For global operations, use the `globalOperations` resource.
368 # - For regional operations, use the `regionOperations` resource.
369 # - For zonal operations, use the `zonalOperations` resource.
370 #
371 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]372 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
373 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
374 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
375 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
376 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
377 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]378 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]379 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
380 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
381 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]382 },
383 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]384 },
385 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
386 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
387 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
388 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
389 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
390 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]391 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]392 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
393 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
394 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
395 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
396 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
397 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
398 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
399 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
400 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
401 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
402 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
403 {
404 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]405 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
406 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]407 {
408 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
409 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
410 },
411 ],
412 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
413 },
414 ],
415 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
416}</pre>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]417</div>
418
419<div class="method">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]420 <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]421 <pre>Retrieves aggregated list of all of the instances in your project across all regions and zones.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]422
423Args:
424 project: string, Project ID for this request. (required)
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]425 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `&gt;`, or `&lt;`.
426
427For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
428
429You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
430
431To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = &quot;Intel Skylake&quot;) ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = &quot;Intel Skylake&quot;) OR (cpuPlatform = &quot;Intel Broadwell&quot;) AND (scheduling.automaticRestart = true) ```
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]432 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]433 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]434 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
435
436You can also sort results in descending order based on the creation timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
437
438Currently, only sorting by `name` or `creationTimestamp desc` is supported.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]439 pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]440 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]441
442Returns:
443 An object of the form:
444
445 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]446 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
447 &quot;items&quot;: { # An object that contains a list of instances scoped by zone.
448 &quot;a_key&quot;: { # [Output Only] Name of the scope containing this set of instances.
449 &quot;instances&quot;: [ # [Output Only] A list of instances contained in this scope.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]450 { # Represents an Instance resource.
451 #
452 # An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. (== resource_for {$api_version}.instances ==)
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]453 &quot;advancedMachineFeatures&quot;: { # Specifies options for controlling advanced machine features. Options that would traditionally be configured in a BIOS belong here. Features that require operating system support may have corresponding entries in the GuestOsFeatures of an Image (e.g., whether or not the OS in the Image supports nested virtualization being enabled or disabled). # Controls for advanced machine-related behavior features.
454 &quot;enableNestedVirtualization&quot;: True or False, # Whether to enable nested virtualization or not (default is false).
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame]455 &quot;threadsPerCore&quot;: 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]456 },
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]457 &quot;canIpForward&quot;: True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]458 &quot;confidentialInstanceConfig&quot;: { # A set of Confidential Instance options.
459 &quot;enableConfidentialCompute&quot;: True or False, # Defines whether the instance should have confidential compute enabled.
460 },
461 &quot;cpuPlatform&quot;: &quot;A String&quot;, # [Output Only] The CPU platform used by this instance.
462 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
463 &quot;deletionProtection&quot;: True or False, # Whether the resource should be protected against deletion.
464 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
465 &quot;disks&quot;: [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
466 { # An instance-attached disk resource.
467 &quot;autoDelete&quot;: True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
468 &quot;boot&quot;: True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]469 &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 running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
470 #
471 # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
472 &quot;diskEncryptionKey&quot;: { # Encrypts or decrypts a disk using a customer-supplied encryption key.
473 #
474 # If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
475 #
476 # If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
477 #
478 # If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
479 #
480 # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]481 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
482 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
483 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]484 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
485 #
486 # The key must meet the following requirements before you can provide it to Compute Engine:
487 # - The key is wrapped using a RSA public key certificate provided by Google.
488 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:
489 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]490 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
491 },
492 &quot;diskSizeGb&quot;: &quot;A String&quot;, # The size of the disk in GB.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]493 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]494 { # Guest OS features.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]495 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]496 },
497 ],
498 &quot;index&quot;: 42, # [Output Only] A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]499 &quot;initializeParams&quot;: { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
500 #
501 # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
502 #
503 # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]504 &quot;description&quot;: &quot;A String&quot;, # An optional description. Provide this property when creating the disk.
505 &quot;diskName&quot;: &quot;A String&quot;, # Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created.
506 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]507 &quot;diskType&quot;: &quot;A String&quot;, # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
508 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
509 #
510 #
511 # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
512 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
513 # - projects/project/zones/zone/diskTypes/diskType
514 # - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.
515 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.
516 #
517 # Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]518 { # Guest OS features.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]519 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]520 },
521 ],
522 &quot;labels&quot;: { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.
523 &quot;a_key&quot;: &quot;A String&quot;,
524 },
525 &quot;multiWriter&quot;: True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.
526 &quot;onUpdateAction&quot;: &quot;A String&quot;, # Specifies which action to take on instance update with this disk. Default is to use the existing disk.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]527 &quot;provisionedIops&quot;: &quot;A String&quot;, # Indicates how many IOPS must be provisioned for the disk.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]528 &quot;resourcePolicies&quot;: [ # Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name.
529 &quot;A String&quot;,
530 ],
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]531 &quot;sourceImage&quot;: &quot;A String&quot;, # The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD.
532 #
533 # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image:
534 # projects/debian-cloud/global/images/family/debian-9
535 #
536 #
537 # Alternatively, use a specific version of a public operating system image:
538 # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
539 #
540 #
541 # To create a disk with a custom image that you created, specify the image name in the following format:
542 # global/images/my-custom-image
543 #
544 #
545 # You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
546 # global/images/family/my-image-family
547 #
548 #
549 # If the source image is deleted later, this field will not be set.
550 &quot;sourceImageEncryptionKey&quot;: { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
551 #
552 # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]553 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
554 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
555 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]556 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
557 #
558 # The key must meet the following requirements before you can provide it to Compute Engine:
559 # - The key is wrapped using a RSA public key certificate provided by Google.
560 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:
561 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]562 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]563 },
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]564 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD.
565 #
566 # To create a disk with a snapshot that you created, specify the snapshot name in the following format:
567 # global/snapshots/my-backup
568 #
569 #
570 # If the source snapshot is deleted later, this field will not be set.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]571 &quot;sourceSnapshotEncryptionKey&quot;: { # The customer-supplied encryption key of the source snapshot.
572 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
573 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
574 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]575 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
576 #
577 # The key must meet the following requirements before you can provide it to Compute Engine:
578 # - The key is wrapped using a RSA public key certificate provided by Google.
579 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:
580 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]581 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]582 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]583 },
584 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
585 &quot;kind&quot;: &quot;compute#attachedDisk&quot;, # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
586 &quot;licenses&quot;: [ # [Output Only] Any valid publicly visible licenses.
587 &quot;A String&quot;,
588 ],
589 &quot;mode&quot;: &quot;A String&quot;, # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
590 &quot;shieldedInstanceInitialState&quot;: { # Initial State for shielded instance, these are public keys which are safe to store in public # [Output Only] shielded vm initial state stored on disk
591 &quot;dbs&quot;: [ # The Key Database (db).
592 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]593 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
594 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]595 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]596 ],
597 &quot;dbxs&quot;: [ # The forbidden key database (dbx).
598 {
599 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
600 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
601 },
602 ],
603 &quot;keks&quot;: [ # The Key Exchange Key (KEK).
604 {
605 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
606 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
607 },
608 ],
609 &quot;pk&quot;: { # The Platform Key (PK).
610 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
611 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]612 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]613 },
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]614 &quot;source&quot;: &quot;A String&quot;, # Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD.
615 #
616 # If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.
617 #
618 # Note that for InstanceTemplate, specify the disk name, not the URL for the disk.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]619 &quot;type&quot;: &quot;A String&quot;, # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]620 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]621 ],
622 &quot;displayDevice&quot;: { # A set of Display Device options # Enables display device for the instance.
623 &quot;enableDisplay&quot;: True or False, # Defines whether the instance has Display enabled.
624 },
625 &quot;eraseWindowsVssSignature&quot;: True or False, # Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]626 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this resource, which is essentially a hash of the instance&#x27;s contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update the instance. You must always provide an up-to-date fingerprint hash in order to update the instance.
627 #
628 # To see the latest fingerprint, make get() request to the instance.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]629 &quot;guestAccelerators&quot;: [ # A list of the type and count of accelerator cards attached to the instance.
630 { # A specification of the type and number of accelerator cards attached to the instance.
631 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
632 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.
633 },
634 ],
635 &quot;hostname&quot;: &quot;A String&quot;, # Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.
636 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
637 &quot;kind&quot;: &quot;compute#instance&quot;, # [Output Only] Type of the resource. Always compute#instance for instances.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]638 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for this request, which is essentially a hash of the label&#x27;s contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
639 #
640 # To see the latest fingerprint, make get() request to the instance.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]641 &quot;labels&quot;: { # Labels to apply to this instance. These can be later modified by the setLabels method.
642 &quot;a_key&quot;: &quot;A String&quot;,
643 },
644 &quot;lastStartTimestamp&quot;: &quot;A String&quot;, # [Output Only] Last start timestamp in RFC3339 text format.
645 &quot;lastStopTimestamp&quot;: &quot;A String&quot;, # [Output Only] Last stop timestamp in RFC3339 text format.
646 &quot;lastSuspendedTimestamp&quot;: &quot;A String&quot;, # [Output Only] Last suspended timestamp in RFC3339 text format.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]647 &quot;machineType&quot;: &quot;A String&quot;, # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:
648 # zones/us-central1-f/machineTypes/n1-standard-1
649 #
650 #
651 # To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):
652 # zones/zone/machineTypes/custom-CPUS-MEMORY
653 #
654 #
655 # For example: zones/us-central1-f/machineTypes/custom-4-5120
656 #
657 # For a full list of restrictions, read the Specifications for custom machine types.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]658 &quot;metadata&quot;: { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]659 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of the metadata&#x27;s contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet.
660 #
661 # To see the latest fingerprint, make a get() request to retrieve the resource.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]662 &quot;items&quot;: [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]663 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]664 &quot;key&quot;: &quot;A String&quot;, # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
665 &quot;value&quot;: &quot;A String&quot;, # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]666 },
667 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]668 &quot;kind&quot;: &quot;compute#metadata&quot;, # [Output Only] Type of the resource. Always compute#metadata for metadata.
669 },
670 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: &quot;Intel Haswell&quot; or minCpuPlatform: &quot;Intel Sandy Bridge&quot;.
671 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
672 &quot;networkInterfaces&quot;: [ # An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance.
673 { # A network interface resource attached to an instance.
674 &quot;accessConfigs&quot;: [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.
675 { # An access configuration attached to an instance&#x27;s network interface. Only one access config per instance is supported.
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700[diff] [blame]676 &quot;externalIpv6&quot;: &quot;A String&quot;, # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.
677 &quot;externalIpv6PrefixLength&quot;: 42, # [Output Only] The prefix length of the external IPv6 range.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]678 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
679 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access.
680 &quot;natIP&quot;: &quot;A String&quot;, # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]681 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.
682 #
683 # If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.
684 #
685 # If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]686 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.
687 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the external IP address of the instance to a DNS domain name.
688 &quot;type&quot;: &quot;ONE_TO_ONE_NAT&quot;, # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
689 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]690 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]691 &quot;aliasIpRanges&quot;: [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.
692 { # An alias IP range attached to an instance&#x27;s network interface.
693 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (such as 10.2.3.4), a netmask (such as /24) or a CIDR-formatted string (such as 10.1.2.0/24).
694 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used.
695 },
696 ],
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]697 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700[diff] [blame]698 &quot;ipv6AccessConfigs&quot;: [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access.
699 { # An access configuration attached to an instance&#x27;s network interface. Only one access config per instance is supported.
700 &quot;externalIpv6&quot;: &quot;A String&quot;, # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.
701 &quot;externalIpv6PrefixLength&quot;: 42, # [Output Only] The prefix length of the external IPv6 range.
702 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
703 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access.
704 &quot;natIP&quot;: &quot;A String&quot;, # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]705 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.
706 #
707 # If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.
708 #
709 # If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700[diff] [blame]710 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.
711 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the external IP address of the instance to a DNS domain name.
712 &quot;type&quot;: &quot;ONE_TO_ONE_NAT&quot;, # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
713 },
714 ],
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]715 &quot;ipv6AccessType&quot;: &quot;A String&quot;, # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork.
716 #
717 # Valid only if stackType is IPV4_IPV6.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]718 &quot;ipv6Address&quot;: &quot;A String&quot;, # [Output Only] An IPv6 internal network address for this network interface.
719 &quot;kind&quot;: &quot;compute#networkInterface&quot;, # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.
720 &quot;name&quot;: &quot;A String&quot;, # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]721 &quot;network&quot;: &quot;A String&quot;, # URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred.
722 #
723 # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
724 # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
725 # - projects/project/global/networks/network
726 # - global/networks/default
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]727 &quot;networkIP&quot;: &quot;A String&quot;, # An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]728 &quot;nicType&quot;: &quot;A String&quot;, # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]729 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for this network interface to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used.
730 #
731 # This field can be both set at instance creation and update network interface operations.
732 &quot;subnetwork&quot;: &quot;A String&quot;, # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
733 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
734 # - regions/region/subnetworks/subnetwork
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]735 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]736 ],
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]737 &quot;networkPerformanceConfig&quot;: {
738 &quot;totalEgressBandwidthTier&quot;: &quot;A String&quot;,
739 },
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]740 &quot;postKeyRevocationActionType&quot;: &quot;A String&quot;, # PostKeyRevocationActionType of the instance.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]741 &quot;privateIpv6GoogleAccess&quot;: &quot;A String&quot;, # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]742 &quot;reservationAffinity&quot;: { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]743 &quot;consumeReservationType&quot;: &quot;A String&quot;, # Specifies the type of reservation from which this instance can consume resources: ANY_RESERVATION (default), SPECIFIC_RESERVATION, or NO_RESERVATION. See Consuming reserved instances for examples.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]744 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify googleapis.com/reservation-name as the key and specify the name of your reservation as its value.
yoshi-code-bot73a0aa32021-05-25 00:30:03 -0700[diff] [blame]745 &quot;values&quot;: [ # Corresponds to the label values of a reservation resource. This can be either a name to a reservation in the same project or &quot;projects/different-project/reservations/some-reservation-name&quot; to target a shared reservation in the same zone but in a different project.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]746 &quot;A String&quot;,
747 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]748 },
749 &quot;resourcePolicies&quot;: [ # Resource policies applied to this instance.
750 &quot;A String&quot;,
751 ],
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]752 &quot;satisfiesPzs&quot;: True or False, # [Output Only] Reserved for future use.
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700[diff] [blame]753 &quot;scheduling&quot;: { # Sets the scheduling options for an Instance. NextID: 21 # Sets the scheduling options for this instance.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]754 &quot;automaticRestart&quot;: True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
755 #
756 # By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.
yoshi-code-bot73a0aa32021-05-25 00:30:03 -0700[diff] [blame]757 &quot;hostErrorTimeoutSeconds&quot;: 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]758 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API.
yoshi-code-bot9e2cde22021-04-29 03:48:05 -0700[diff] [blame]759 &quot;maintenanceFreezeDurationHours&quot;: 42, # Specifies the number of hours after VM instance creation where the VM won&#x27;t be scheduled for maintenance.
760 &quot;maintenanceInterval&quot;: &quot;A String&quot;, # For more information about maintenance intervals, see Setting maintenance intervals.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]761 &quot;minNodeCpus&quot;: 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.
762 &quot;nodeAffinities&quot;: [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.
763 { # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.
764 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of Node resource.
765 &quot;operator&quot;: &quot;A String&quot;, # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.
766 &quot;values&quot;: [ # Corresponds to the label values of Node resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]767 &quot;A String&quot;,
768 ],
769 },
770 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]771 &quot;onHostMaintenance&quot;: &quot;A String&quot;, # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
772 &quot;preemptible&quot;: True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.
773 },
774 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]775 &quot;serviceAccounts&quot;: [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.
776 #
777 # Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]778 { # A service account.
779 &quot;email&quot;: &quot;A String&quot;, # Email address of the service account.
780 &quot;scopes&quot;: [ # The list of scopes to be made available for this service account.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]781 &quot;A String&quot;,
782 ],
783 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]784 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]785 &quot;shieldedInstanceConfig&quot;: { # A set of Shielded Instance options.
786 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.
787 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.
788 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.
789 },
790 &quot;shieldedInstanceIntegrityPolicy&quot;: { # The policy describes the baseline against which Instance boot integrity is measured.
791 &quot;updateAutoLearnPolicy&quot;: True or False, # Updates the integrity policy baseline using the measurements from the VM instance&#x27;s most recent boot.
792 },
793 &quot;shieldedVmConfig&quot;: { # A set of Shielded VM options. # Deprecating, please use shielded_instance_config.
794 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.
795 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.
796 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.
797 },
798 &quot;shieldedVmIntegrityPolicy&quot;: { # The policy describes the baseline against which VM instance boot integrity is measured. # Deprecating, please use shielded_instance_integrity_policy.
799 &quot;updateAutoLearnPolicy&quot;: True or False, # Updates the integrity policy baseline using the measurements from the VM instance&#x27;s most recent boot.
800 },
801 &quot;sourceMachineImage&quot;: &quot;A String&quot;, # Source machine image
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]802 &quot;sourceMachineImageEncryptionKey&quot;: { # Source machine image encryption key when creating an instance from a machine image.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]803 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
804 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
805 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]806 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
807 #
808 # The key must meet the following requirements before you can provide it to Compute Engine:
809 # - The key is wrapped using a RSA public key certificate provided by Google.
810 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:
811 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]812 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
813 },
814 &quot;startRestricted&quot;: True or False, # [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]815 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]816 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable explanation of the status.
817 &quot;tags&quot;: { # A set of instance tags. # Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. Multiple tags can be specified via the &#x27;tags.items&#x27; field.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]818 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of the tags&#x27; contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update tags. You must always provide an up-to-date fingerprint hash in order to update or change tags.
819 #
820 # To see the latest fingerprint, make get() request to the instance.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]821 &quot;items&quot;: [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
822 &quot;A String&quot;,
823 ],
824 },
825 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]826 },
827 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]828 &quot;warning&quot;: { # [Output Only] Informational warning which replaces the list of instances when the list is empty.
829 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]830 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
831 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]832 {
833 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
834 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
835 },
836 ],
837 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
838 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]839 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]840 },
841 &quot;kind&quot;: &quot;compute#instanceAggregatedList&quot;, # [Output Only] Type of resource. Always compute#instanceAggregatedList for aggregated lists of Instance resources.
842 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
843 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
844 &quot;unreachables&quot;: [ # [Output Only] Unreachable resources.
845 &quot;A String&quot;,
846 ],
847 &quot;warning&quot;: { # [Output Only] Informational warning message.
848 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]849 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
850 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]851 {
852 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
853 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
854 },
855 ],
856 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
857 },
858}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]859</div>
860
861<div class="method">
862 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
863 <pre>Retrieves the next page of results.
864
865Args:
866 previous_request: The request for the previous page. (required)
867 previous_response: The response from the request for the previous page. (required)
868
869Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]870 A request object that you can call &#x27;execute()&#x27; on to request the next
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]871 page. Returns None if there are no more items in the collection.
872 </pre>
873</div>
874
875<div class="method">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]876 <code class="details" id="attachDisk">attachDisk(project, zone, instance, body=None, forceAttach=None, requestId=None)</code>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]877 <pre>Attaches an existing Disk resource to an instance. You must first create the disk before you can attach it. It is not possible to create and attach a disk at the same time. For more information, read Adding a persistent disk to your instance.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]878
879Args:
880 project: string, Project ID for this request. (required)
881 zone: string, The name of the zone for this request. (required)
882 instance: string, The instance name for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]883 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]884 The object takes the form of:
885
886{ # An instance-attached disk resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]887 &quot;autoDelete&quot;: True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
888 &quot;boot&quot;: True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]889 &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 running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
890 #
891 # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
892 &quot;diskEncryptionKey&quot;: { # Encrypts or decrypts a disk using a customer-supplied encryption key.
893 #
894 # If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
895 #
896 # If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
897 #
898 # If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
899 #
900 # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]901 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
902 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
903 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]904 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
905 #
906 # The key must meet the following requirements before you can provide it to Compute Engine:
907 # - The key is wrapped using a RSA public key certificate provided by Google.
908 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:
909 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]910 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]911 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]912 &quot;diskSizeGb&quot;: &quot;A String&quot;, # The size of the disk in GB.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]913 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]914 { # Guest OS features.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]915 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]916 },
917 ],
918 &quot;index&quot;: 42, # [Output Only] A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]919 &quot;initializeParams&quot;: { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
920 #
921 # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
922 #
923 # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]924 &quot;description&quot;: &quot;A String&quot;, # An optional description. Provide this property when creating the disk.
925 &quot;diskName&quot;: &quot;A String&quot;, # Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created.
926 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]927 &quot;diskType&quot;: &quot;A String&quot;, # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
928 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
929 #
930 #
931 # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
932 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
933 # - projects/project/zones/zone/diskTypes/diskType
934 # - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.
935 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.
936 #
937 # Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]938 { # Guest OS features.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]939 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]940 },
941 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]942 &quot;labels&quot;: { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.
943 &quot;a_key&quot;: &quot;A String&quot;,
944 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]945 &quot;multiWriter&quot;: True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]946 &quot;onUpdateAction&quot;: &quot;A String&quot;, # Specifies which action to take on instance update with this disk. Default is to use the existing disk.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]947 &quot;provisionedIops&quot;: &quot;A String&quot;, # Indicates how many IOPS must be provisioned for the disk.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]948 &quot;resourcePolicies&quot;: [ # Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name.
949 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]950 ],
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]951 &quot;sourceImage&quot;: &quot;A String&quot;, # The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD.
952 #
953 # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image:
954 # projects/debian-cloud/global/images/family/debian-9
955 #
956 #
957 # Alternatively, use a specific version of a public operating system image:
958 # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
959 #
960 #
961 # To create a disk with a custom image that you created, specify the image name in the following format:
962 # global/images/my-custom-image
963 #
964 #
965 # You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
966 # global/images/family/my-image-family
967 #
968 #
969 # If the source image is deleted later, this field will not be set.
970 &quot;sourceImageEncryptionKey&quot;: { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
971 #
972 # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]973 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
974 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
975 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]976 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
977 #
978 # The key must meet the following requirements before you can provide it to Compute Engine:
979 # - The key is wrapped using a RSA public key certificate provided by Google.
980 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:
981 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]982 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
983 },
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]984 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD.
985 #
986 # To create a disk with a snapshot that you created, specify the snapshot name in the following format:
987 # global/snapshots/my-backup
988 #
989 #
990 # If the source snapshot is deleted later, this field will not be set.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]991 &quot;sourceSnapshotEncryptionKey&quot;: { # The customer-supplied encryption key of the source snapshot.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]992 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
993 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
994 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]995 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
996 #
997 # The key must meet the following requirements before you can provide it to Compute Engine:
998 # - The key is wrapped using a RSA public key certificate provided by Google.
999 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:
1000 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1001 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1002 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1003 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1004 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
1005 &quot;kind&quot;: &quot;compute#attachedDisk&quot;, # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
1006 &quot;licenses&quot;: [ # [Output Only] Any valid publicly visible licenses.
1007 &quot;A String&quot;,
1008 ],
1009 &quot;mode&quot;: &quot;A String&quot;, # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
1010 &quot;shieldedInstanceInitialState&quot;: { # Initial State for shielded instance, these are public keys which are safe to store in public # [Output Only] shielded vm initial state stored on disk
1011 &quot;dbs&quot;: [ # The Key Database (db).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1012 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1013 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
1014 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1015 },
1016 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1017 &quot;dbxs&quot;: [ # The forbidden key database (dbx).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1018 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1019 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
1020 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1021 },
1022 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1023 &quot;keks&quot;: [ # The Key Exchange Key (KEK).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1024 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1025 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
1026 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1027 },
1028 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1029 &quot;pk&quot;: { # The Platform Key (PK).
1030 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
1031 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1032 },
1033 },
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1034 &quot;source&quot;: &quot;A String&quot;, # Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD.
1035 #
1036 # If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.
1037 #
1038 # Note that for InstanceTemplate, specify the disk name, not the URL for the disk.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1039 &quot;type&quot;: &quot;A String&quot;, # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1040}
1041
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1042 forceAttach: boolean, Whether to force attach the regional disk even if it&#x27;s currently attached to another instance. If you try to force attach a zonal disk to an instance, you will receive an error.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1043 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
1044
1045For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
1046
1047The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1048
1049Returns:
1050 An object of the form:
1051
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1052 { # Represents an Operation resource.
1053 #
1054 # Google Compute Engine has three Operation resources:
1055 #
1056 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
1057 #
1058 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
1059 #
1060 # Operations can be global, regional or zonal.
1061 # - For global operations, use the `globalOperations` resource.
1062 # - For regional operations, use the `regionOperations` resource.
1063 # - For zonal operations, use the `zonalOperations` resource.
1064 #
1065 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1066 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
1067 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1068 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
1069 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
1070 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
1071 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1072 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1073 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1074 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
1075 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1076 },
1077 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1078 },
1079 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
1080 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
1081 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
1082 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
1083 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
1084 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]1085 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
1086 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
1087 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
1088 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
1089 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1090 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
1091 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
1092 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
1093 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
1094 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
1095 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
1096 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
1097 {
1098 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1099 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
1100 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]1101 {
1102 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
1103 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1104 },
1105 ],
1106 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1107 },
1108 ],
1109 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
1110}</pre>
1111</div>
1112
1113<div class="method">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1114 <code class="details" id="bulkInsert">bulkInsert(project, zone, body=None, requestId=None)</code>
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]1115 <pre>Creates multiple instances. Count specifies the number of instances to create.
1116
1117Args:
1118 project: string, Project ID for this request. (required)
1119 zone: string, The name of the zone for this request. (required)
1120 body: object, The request body.
1121 The object takes the form of:
1122
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700[diff] [blame]1123{ # A transient resource used in compute.instances.bulkInsert and compute.regionInstances.bulkInsert and compute.regionInstances.recommendLocations. This resource is not persisted anywhere, it is used only for processing the requests.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]1124 &quot;count&quot;: &quot;A String&quot;, # The maximum number of instances to create.
1125 &quot;instanceProperties&quot;: { # The instance properties defining the VM instances to be created. Required if sourceInstanceTemplate is not provided.
1126 &quot;advancedMachineFeatures&quot;: { # Specifies options for controlling advanced machine features. Options that would traditionally be configured in a BIOS belong here. Features that require operating system support may have corresponding entries in the GuestOsFeatures of an Image (e.g., whether or not the OS in the Image supports nested virtualization being enabled or disabled). # Controls for advanced machine-related behavior features.
1127 &quot;enableNestedVirtualization&quot;: True or False, # Whether to enable nested virtualization or not (default is false).
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame]1128 &quot;threadsPerCore&quot;: 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]1129 },
1130 &quot;canIpForward&quot;: True or False, # Enables instances created based on these properties to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding documentation for more information.
1131 &quot;confidentialInstanceConfig&quot;: { # A set of Confidential Instance options. # Specifies the Confidential Instance options.
1132 &quot;enableConfidentialCompute&quot;: True or False, # Defines whether the instance should have confidential compute enabled.
1133 },
1134 &quot;description&quot;: &quot;A String&quot;, # An optional text description for the instances that are created from these properties.
1135 &quot;disks&quot;: [ # An array of disks that are associated with the instances that are created from these properties.
1136 { # An instance-attached disk resource.
1137 &quot;autoDelete&quot;: True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
1138 &quot;boot&quot;: True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1139 &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 running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
1140 #
1141 # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
1142 &quot;diskEncryptionKey&quot;: { # Encrypts or decrypts a disk using a customer-supplied encryption key.
1143 #
1144 # If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
1145 #
1146 # If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
1147 #
1148 # If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
1149 #
1150 # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]1151 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
1152 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
1153 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1154 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
1155 #
1156 # The key must meet the following requirements before you can provide it to Compute Engine:
1157 # - The key is wrapped using a RSA public key certificate provided by Google.
1158 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:
1159 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]1160 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
1161 },
1162 &quot;diskSizeGb&quot;: &quot;A String&quot;, # The size of the disk in GB.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1163 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]1164 { # Guest OS features.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1165 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]1166 },
1167 ],
1168 &quot;index&quot;: 42, # [Output Only] A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1169 &quot;initializeParams&quot;: { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
1170 #
1171 # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
1172 #
1173 # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]1174 &quot;description&quot;: &quot;A String&quot;, # An optional description. Provide this property when creating the disk.
1175 &quot;diskName&quot;: &quot;A String&quot;, # Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created.
1176 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1177 &quot;diskType&quot;: &quot;A String&quot;, # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
1178 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
1179 #
1180 #
1181 # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
1182 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
1183 # - projects/project/zones/zone/diskTypes/diskType
1184 # - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.
1185 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.
1186 #
1187 # Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]1188 { # Guest OS features.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1189 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]1190 },
1191 ],
1192 &quot;labels&quot;: { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.
1193 &quot;a_key&quot;: &quot;A String&quot;,
1194 },
1195 &quot;multiWriter&quot;: True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.
1196 &quot;onUpdateAction&quot;: &quot;A String&quot;, # Specifies which action to take on instance update with this disk. Default is to use the existing disk.
1197 &quot;provisionedIops&quot;: &quot;A String&quot;, # Indicates how many IOPS must be provisioned for the disk.
1198 &quot;resourcePolicies&quot;: [ # Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name.
1199 &quot;A String&quot;,
1200 ],
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1201 &quot;sourceImage&quot;: &quot;A String&quot;, # The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD.
1202 #
1203 # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image:
1204 # projects/debian-cloud/global/images/family/debian-9
1205 #
1206 #
1207 # Alternatively, use a specific version of a public operating system image:
1208 # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
1209 #
1210 #
1211 # To create a disk with a custom image that you created, specify the image name in the following format:
1212 # global/images/my-custom-image
1213 #
1214 #
1215 # You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
1216 # global/images/family/my-image-family
1217 #
1218 #
1219 # If the source image is deleted later, this field will not be set.
1220 &quot;sourceImageEncryptionKey&quot;: { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
1221 #
1222 # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]1223 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
1224 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
1225 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1226 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
1227 #
1228 # The key must meet the following requirements before you can provide it to Compute Engine:
1229 # - The key is wrapped using a RSA public key certificate provided by Google.
1230 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:
1231 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]1232 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
1233 },
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1234 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD.
1235 #
1236 # To create a disk with a snapshot that you created, specify the snapshot name in the following format:
1237 # global/snapshots/my-backup
1238 #
1239 #
1240 # If the source snapshot is deleted later, this field will not be set.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]1241 &quot;sourceSnapshotEncryptionKey&quot;: { # The customer-supplied encryption key of the source snapshot.
1242 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
1243 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
1244 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1245 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
1246 #
1247 # The key must meet the following requirements before you can provide it to Compute Engine:
1248 # - The key is wrapped using a RSA public key certificate provided by Google.
1249 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:
1250 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]1251 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
1252 },
1253 },
1254 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
1255 &quot;kind&quot;: &quot;compute#attachedDisk&quot;, # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
1256 &quot;licenses&quot;: [ # [Output Only] Any valid publicly visible licenses.
1257 &quot;A String&quot;,
1258 ],
1259 &quot;mode&quot;: &quot;A String&quot;, # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
1260 &quot;shieldedInstanceInitialState&quot;: { # Initial State for shielded instance, these are public keys which are safe to store in public # [Output Only] shielded vm initial state stored on disk
1261 &quot;dbs&quot;: [ # The Key Database (db).
1262 {
1263 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
1264 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
1265 },
1266 ],
1267 &quot;dbxs&quot;: [ # The forbidden key database (dbx).
1268 {
1269 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
1270 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
1271 },
1272 ],
1273 &quot;keks&quot;: [ # The Key Exchange Key (KEK).
1274 {
1275 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
1276 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
1277 },
1278 ],
1279 &quot;pk&quot;: { # The Platform Key (PK).
1280 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
1281 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
1282 },
1283 },
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1284 &quot;source&quot;: &quot;A String&quot;, # Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD.
1285 #
1286 # If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.
1287 #
1288 # Note that for InstanceTemplate, specify the disk name, not the URL for the disk.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]1289 &quot;type&quot;: &quot;A String&quot;, # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
1290 },
1291 ],
1292 &quot;displayDevice&quot;: { # A set of Display Device options # Display Device properties to enable support for remote display products like: Teradici, VNC and TeamViewer
1293 &quot;enableDisplay&quot;: True or False, # Defines whether the instance has Display enabled.
1294 },
1295 &quot;guestAccelerators&quot;: [ # A list of guest accelerator cards&#x27; type and count to use for instances created from these properties.
1296 { # A specification of the type and number of accelerator cards attached to the instance.
1297 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
1298 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.
1299 },
1300 ],
1301 &quot;labels&quot;: { # Labels to apply to instances that are created from these properties.
1302 &quot;a_key&quot;: &quot;A String&quot;,
1303 },
1304 &quot;machineType&quot;: &quot;A String&quot;, # The machine type to use for instances that are created from these properties.
1305 &quot;metadata&quot;: { # A metadata key/value entry. # The metadata key/value pairs to assign to instances that are created from these properties. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1306 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of the metadata&#x27;s contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet.
1307 #
1308 # To see the latest fingerprint, make a get() request to retrieve the resource.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]1309 &quot;items&quot;: [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1310 {
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]1311 &quot;key&quot;: &quot;A String&quot;, # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
1312 &quot;value&quot;: &quot;A String&quot;, # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB).
1313 },
1314 ],
1315 &quot;kind&quot;: &quot;compute#metadata&quot;, # [Output Only] Type of the resource. Always compute#metadata for metadata.
1316 },
1317 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Minimum cpu/platform to be used by instances. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: &quot;Intel Haswell&quot; or minCpuPlatform: &quot;Intel Sandy Bridge&quot;. For more information, read Specifying a Minimum CPU Platform.
1318 &quot;networkInterfaces&quot;: [ # An array of network access configurations for this interface.
1319 { # A network interface resource attached to an instance.
1320 &quot;accessConfigs&quot;: [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.
1321 { # An access configuration attached to an instance&#x27;s network interface. Only one access config per instance is supported.
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700[diff] [blame]1322 &quot;externalIpv6&quot;: &quot;A String&quot;, # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.
1323 &quot;externalIpv6PrefixLength&quot;: 42, # [Output Only] The prefix length of the external IPv6 range.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]1324 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
1325 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access.
1326 &quot;natIP&quot;: &quot;A String&quot;, # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1327 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.
1328 #
1329 # If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.
1330 #
1331 # If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]1332 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.
1333 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the external IP address of the instance to a DNS domain name.
1334 &quot;type&quot;: &quot;ONE_TO_ONE_NAT&quot;, # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
1335 },
1336 ],
1337 &quot;aliasIpRanges&quot;: [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.
1338 { # An alias IP range attached to an instance&#x27;s network interface.
1339 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (such as 10.2.3.4), a netmask (such as /24) or a CIDR-formatted string (such as 10.1.2.0/24).
1340 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used.
1341 },
1342 ],
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]1343 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700[diff] [blame]1344 &quot;ipv6AccessConfigs&quot;: [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access.
1345 { # An access configuration attached to an instance&#x27;s network interface. Only one access config per instance is supported.
1346 &quot;externalIpv6&quot;: &quot;A String&quot;, # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.
1347 &quot;externalIpv6PrefixLength&quot;: 42, # [Output Only] The prefix length of the external IPv6 range.
1348 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
1349 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access.
1350 &quot;natIP&quot;: &quot;A String&quot;, # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1351 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.
1352 #
1353 # If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.
1354 #
1355 # If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700[diff] [blame]1356 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.
1357 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the external IP address of the instance to a DNS domain name.
1358 &quot;type&quot;: &quot;ONE_TO_ONE_NAT&quot;, # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
1359 },
1360 ],
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1361 &quot;ipv6AccessType&quot;: &quot;A String&quot;, # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork.
1362 #
1363 # Valid only if stackType is IPV4_IPV6.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]1364 &quot;ipv6Address&quot;: &quot;A String&quot;, # [Output Only] An IPv6 internal network address for this network interface.
1365 &quot;kind&quot;: &quot;compute#networkInterface&quot;, # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.
1366 &quot;name&quot;: &quot;A String&quot;, # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1367 &quot;network&quot;: &quot;A String&quot;, # URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred.
1368 #
1369 # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
1370 # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
1371 # - projects/project/global/networks/network
1372 # - global/networks/default
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]1373 &quot;networkIP&quot;: &quot;A String&quot;, # An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
1374 &quot;nicType&quot;: &quot;A String&quot;, # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1375 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for this network interface to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used.
1376 #
1377 # This field can be both set at instance creation and update network interface operations.
1378 &quot;subnetwork&quot;: &quot;A String&quot;, # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
1379 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
1380 # - regions/region/subnetworks/subnetwork
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]1381 },
1382 ],
1383 &quot;networkPerformanceConfig&quot;: {
1384 &quot;totalEgressBandwidthTier&quot;: &quot;A String&quot;,
1385 },
1386 &quot;postKeyRevocationActionType&quot;: &quot;A String&quot;, # PostKeyRevocationActionType of the instance.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1387 &quot;privateIpv6GoogleAccess&quot;: &quot;A String&quot;, # The private IPv6 google access type for VMs. If not specified, use INHERIT_FROM_SUBNETWORK as default.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]1388 &quot;reservationAffinity&quot;: { # Specifies the reservations that this instance can consume from. # Specifies the reservations that instances can consume from.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1389 &quot;consumeReservationType&quot;: &quot;A String&quot;, # Specifies the type of reservation from which this instance can consume resources: ANY_RESERVATION (default), SPECIFIC_RESERVATION, or NO_RESERVATION. See Consuming reserved instances for examples.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]1390 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify googleapis.com/reservation-name as the key and specify the name of your reservation as its value.
yoshi-code-bot73a0aa32021-05-25 00:30:03 -0700[diff] [blame]1391 &quot;values&quot;: [ # Corresponds to the label values of a reservation resource. This can be either a name to a reservation in the same project or &quot;projects/different-project/reservations/some-reservation-name&quot; to target a shared reservation in the same zone but in a different project.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]1392 &quot;A String&quot;,
1393 ],
1394 },
1395 &quot;resourcePolicies&quot;: [ # Resource policies (names, not ULRs) applied to instances created from these properties.
1396 &quot;A String&quot;,
1397 ],
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700[diff] [blame]1398 &quot;scheduling&quot;: { # Sets the scheduling options for an Instance. NextID: 21 # Specifies the scheduling options for the instances that are created from these properties.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1399 &quot;automaticRestart&quot;: True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
1400 #
1401 # By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.
yoshi-code-bot73a0aa32021-05-25 00:30:03 -0700[diff] [blame]1402 &quot;hostErrorTimeoutSeconds&quot;: 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]1403 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API.
yoshi-code-bot9e2cde22021-04-29 03:48:05 -0700[diff] [blame]1404 &quot;maintenanceFreezeDurationHours&quot;: 42, # Specifies the number of hours after VM instance creation where the VM won&#x27;t be scheduled for maintenance.
1405 &quot;maintenanceInterval&quot;: &quot;A String&quot;, # For more information about maintenance intervals, see Setting maintenance intervals.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]1406 &quot;minNodeCpus&quot;: 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.
1407 &quot;nodeAffinities&quot;: [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.
1408 { # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.
1409 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of Node resource.
1410 &quot;operator&quot;: &quot;A String&quot;, # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.
1411 &quot;values&quot;: [ # Corresponds to the label values of Node resource.
1412 &quot;A String&quot;,
1413 ],
1414 },
1415 ],
1416 &quot;onHostMaintenance&quot;: &quot;A String&quot;, # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
1417 &quot;preemptible&quot;: True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.
1418 },
1419 &quot;serviceAccounts&quot;: [ # A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from these properties. Use metadata queries to obtain the access tokens for these instances.
1420 { # A service account.
1421 &quot;email&quot;: &quot;A String&quot;, # Email address of the service account.
1422 &quot;scopes&quot;: [ # The list of scopes to be made available for this service account.
1423 &quot;A String&quot;,
1424 ],
1425 },
1426 ],
1427 &quot;shieldedInstanceConfig&quot;: { # A set of Shielded Instance options.
1428 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.
1429 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.
1430 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.
1431 },
1432 &quot;shieldedVmConfig&quot;: { # A set of Shielded VM options. # Specifies the Shielded VM options for the instances that are created from these properties.
1433 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.
1434 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.
1435 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.
1436 },
1437 &quot;tags&quot;: { # A set of instance tags. # A list of tags to apply to the instances that are created from these properties. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1438 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of the tags&#x27; contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update tags. You must always provide an up-to-date fingerprint hash in order to update or change tags.
1439 #
1440 # To see the latest fingerprint, make get() request to the instance.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]1441 &quot;items&quot;: [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
1442 &quot;A String&quot;,
1443 ],
1444 },
1445 },
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame]1446 &quot;locationPolicy&quot;: { # Configuration for location policy among multiple possible locations (e.g. preferences for zone selection among zones in a single region). # Policy for chosing target zone.
1447 &quot;locations&quot;: { # Location configurations mapped by location name. Currently only zone names are supported and must be represented as valid internal URLs, such as zones/us-central1-a.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]1448 &quot;a_key&quot;: {
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700[diff] [blame]1449 &quot;preference&quot;: &quot;A String&quot;, # Preference for a given location: ALLOW or DENY.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]1450 },
1451 },
1452 },
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame]1453 &quot;minCount&quot;: &quot;A String&quot;, # The minimum number of instances to create. If no min_count is specified then count is used as the default value. If min_count instances cannot be created, then no instances will be created and instances already created will be deleted.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1454 &quot;namePattern&quot;: &quot;A String&quot;, # The string pattern used for the names of the VMs. Either name_pattern or per_instance_properties must be set. The pattern should contain one continuous sequence of placeholder hash characters (#) with each character corresponding to one digit of the generated instance name. Example: name_pattern of inst-#### will generate instance names such as inst-0001, inst-0002, ... . If there already exist instance(s) whose names match the name pattern in the same project and zone, then the generated instance numbers will start after the biggest existing number. For example, if there exists an instance with name inst-0050, then instance names generated using the pattern inst-#### will be inst-0051, inst-0052, etc. The name pattern placeholder #...# can contain up to 18 characters.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]1455 &quot;perInstanceProperties&quot;: { # Per-instance properties to be set on individual instances. Keys of this map specify requested instance names. Can be empty if name_pattern is used.
1456 &quot;a_key&quot;: { # Per-instance properties to be set on individual instances. To be extended in the future.
1457 &quot;name&quot;: &quot;A String&quot;, # This field is only temporary. It will be removed. Do not use it.
1458 },
1459 },
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1460 &quot;sourceInstanceTemplate&quot;: &quot;A String&quot;, # Specifies the instance template from which to create instances. You may combine sourceInstanceTemplate with instanceProperties to override specific values from an existing instance template. Bulk API follows the semantics of JSON Merge Patch described by RFC 7396.
1461 #
1462 # It can be a full or partial URL. For example, the following are all valid URLs to an instance template:
1463 # - https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate
1464 # - projects/project/global/instanceTemplates/instanceTemplate
1465 # - global/instanceTemplates/instanceTemplate
1466 #
1467 # This field is optional.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]1468}
1469
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1470 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
1471
1472For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
1473
1474The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]1475
1476Returns:
1477 An object of the form:
1478
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1479 { # Represents an Operation resource.
1480 #
1481 # Google Compute Engine has three Operation resources:
1482 #
1483 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
1484 #
1485 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
1486 #
1487 # Operations can be global, regional or zonal.
1488 # - For global operations, use the `globalOperations` resource.
1489 # - For regional operations, use the `regionOperations` resource.
1490 # - For zonal operations, use the `zonalOperations` resource.
1491 #
1492 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]1493 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
1494 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1495 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
1496 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
1497 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
1498 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
1499 {
1500 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1501 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
1502 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1503 },
1504 ],
1505 },
1506 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
1507 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
1508 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
1509 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
1510 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
1511 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1512 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1513 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
1514 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
1515 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
1516 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1517 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
1518 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
1519 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
1520 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
1521 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
1522 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
1523 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
1524 {
1525 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1526 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
1527 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1528 {
1529 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
1530 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1531 },
1532 ],
1533 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1534 },
1535 ],
1536 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
1537}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1538</div>
1539
1540<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1541 <code class="details" id="close">close()</code>
1542 <pre>Close httplib2 connections.</pre>
1543</div>
1544
1545<div class="method">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1546 <code class="details" id="delete">delete(project, zone, instance, requestId=None)</code>
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame]1547 <pre>Deletes the specified Instance resource. For more information, see Deleting an instance.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1548
1549Args:
1550 project: string, Project ID for this request. (required)
1551 zone: string, The name of the zone for this request. (required)
1552 instance: string, Name of the instance resource to delete. (required)
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1553 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
1554
1555For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
1556
1557The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1558
1559Returns:
1560 An object of the form:
1561
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1562 { # Represents an Operation resource.
1563 #
1564 # Google Compute Engine has three Operation resources:
1565 #
1566 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
1567 #
1568 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
1569 #
1570 # Operations can be global, regional or zonal.
1571 # - For global operations, use the `globalOperations` resource.
1572 # - For regional operations, use the `regionOperations` resource.
1573 # - For zonal operations, use the `zonalOperations` resource.
1574 #
1575 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1576 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
1577 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1578 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
1579 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
1580 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
1581 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1582 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1583 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1584 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
1585 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1586 },
1587 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1588 },
1589 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
1590 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
1591 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
1592 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
1593 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
1594 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]1595 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1596 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
1597 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
1598 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
1599 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1600 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
1601 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
1602 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
1603 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
1604 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
1605 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
1606 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
1607 {
1608 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1609 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
1610 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1611 {
1612 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
1613 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1614 },
1615 ],
1616 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1617 },
1618 ],
1619 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
1620}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1621</div>
1622
1623<div class="method">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1624 <code class="details" id="deleteAccessConfig">deleteAccessConfig(project, zone, instance, accessConfig, networkInterface, requestId=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1625 <pre>Deletes an access config from an instance&#x27;s network interface.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1626
1627Args:
1628 project: string, Project ID for this request. (required)
1629 zone: string, The name of the zone for this request. (required)
1630 instance: string, The instance name for this request. (required)
1631 accessConfig: string, The name of the access config to delete. (required)
1632 networkInterface: string, The name of the network interface. (required)
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1633 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
1634
1635For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
1636
1637The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1638
1639Returns:
1640 An object of the form:
1641
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1642 { # Represents an Operation resource.
1643 #
1644 # Google Compute Engine has three Operation resources:
1645 #
1646 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
1647 #
1648 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
1649 #
1650 # Operations can be global, regional or zonal.
1651 # - For global operations, use the `globalOperations` resource.
1652 # - For regional operations, use the `regionOperations` resource.
1653 # - For zonal operations, use the `zonalOperations` resource.
1654 #
1655 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1656 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
1657 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1658 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
1659 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
1660 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
1661 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1662 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1663 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1664 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
1665 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1666 },
1667 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1668 },
1669 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
1670 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
1671 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
1672 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
1673 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
1674 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]1675 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1676 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
1677 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
1678 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
1679 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1680 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
1681 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
1682 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
1683 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
1684 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
1685 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
1686 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
1687 {
1688 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1689 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
1690 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1691 {
1692 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
1693 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1694 },
1695 ],
1696 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1697 },
1698 ],
1699 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
1700}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1701</div>
1702
1703<div class="method">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1704 <code class="details" id="detachDisk">detachDisk(project, zone, instance, deviceName, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1705 <pre>Detaches a disk from an instance.
1706
1707Args:
1708 project: string, Project ID for this request. (required)
1709 zone: string, The name of the zone for this request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1710 instance: string, Instance name for this request. (required)
1711 deviceName: string, The device name of the disk to detach. Make a get() request on the instance to view currently attached disks and device names. (required)
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1712 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
1713
1714For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
1715
1716The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1717
1718Returns:
1719 An object of the form:
1720
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1721 { # Represents an Operation resource.
1722 #
1723 # Google Compute Engine has three Operation resources:
1724 #
1725 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
1726 #
1727 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
1728 #
1729 # Operations can be global, regional or zonal.
1730 # - For global operations, use the `globalOperations` resource.
1731 # - For regional operations, use the `regionOperations` resource.
1732 # - For zonal operations, use the `zonalOperations` resource.
1733 #
1734 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1735 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
1736 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1737 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
1738 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
1739 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
1740 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1741 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1742 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1743 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
1744 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1745 },
1746 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1747 },
1748 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
1749 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
1750 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
1751 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
1752 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
1753 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]1754 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1755 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
1756 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
1757 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
1758 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1759 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
1760 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
1761 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
1762 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
1763 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
1764 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
1765 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
1766 {
1767 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1768 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
1769 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1770 {
1771 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
1772 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1773 },
1774 ],
1775 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1776 },
1777 ],
1778 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
1779}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1780</div>
1781
1782<div class="method">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1783 <code class="details" id="get">get(project, zone, instance)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1784 <pre>Returns the specified Instance resource. Gets a list of available instances by making a list() request.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1785
1786Args:
1787 project: string, Project ID for this request. (required)
1788 zone: string, The name of the zone for this request. (required)
1789 instance: string, Name of the instance resource to return. (required)
1790
1791Returns:
1792 An object of the form:
1793
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1794 { # Represents an Instance resource.
1795 #
1796 # An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. (== resource_for {$api_version}.instances ==)
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]1797 &quot;advancedMachineFeatures&quot;: { # Specifies options for controlling advanced machine features. Options that would traditionally be configured in a BIOS belong here. Features that require operating system support may have corresponding entries in the GuestOsFeatures of an Image (e.g., whether or not the OS in the Image supports nested virtualization being enabled or disabled). # Controls for advanced machine-related behavior features.
1798 &quot;enableNestedVirtualization&quot;: True or False, # Whether to enable nested virtualization or not (default is false).
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame]1799 &quot;threadsPerCore&quot;: 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]1800 },
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1801 &quot;canIpForward&quot;: True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1802 &quot;confidentialInstanceConfig&quot;: { # A set of Confidential Instance options.
1803 &quot;enableConfidentialCompute&quot;: True or False, # Defines whether the instance should have confidential compute enabled.
1804 },
1805 &quot;cpuPlatform&quot;: &quot;A String&quot;, # [Output Only] The CPU platform used by this instance.
1806 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
1807 &quot;deletionProtection&quot;: True or False, # Whether the resource should be protected against deletion.
1808 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
1809 &quot;disks&quot;: [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
1810 { # An instance-attached disk resource.
1811 &quot;autoDelete&quot;: True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
1812 &quot;boot&quot;: True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1813 &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 running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
1814 #
1815 # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
1816 &quot;diskEncryptionKey&quot;: { # Encrypts or decrypts a disk using a customer-supplied encryption key.
1817 #
1818 # If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
1819 #
1820 # If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
1821 #
1822 # If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
1823 #
1824 # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1825 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
1826 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
1827 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1828 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
1829 #
1830 # The key must meet the following requirements before you can provide it to Compute Engine:
1831 # - The key is wrapped using a RSA public key certificate provided by Google.
1832 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:
1833 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1834 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
1835 },
1836 &quot;diskSizeGb&quot;: &quot;A String&quot;, # The size of the disk in GB.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1837 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1838 { # Guest OS features.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1839 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1840 },
1841 ],
1842 &quot;index&quot;: 42, # [Output Only] A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1843 &quot;initializeParams&quot;: { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
1844 #
1845 # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
1846 #
1847 # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1848 &quot;description&quot;: &quot;A String&quot;, # An optional description. Provide this property when creating the disk.
1849 &quot;diskName&quot;: &quot;A String&quot;, # Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created.
1850 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1851 &quot;diskType&quot;: &quot;A String&quot;, # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
1852 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
1853 #
1854 #
1855 # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
1856 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
1857 # - projects/project/zones/zone/diskTypes/diskType
1858 # - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.
1859 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.
1860 #
1861 # Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1862 { # Guest OS features.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1863 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1864 },
1865 ],
1866 &quot;labels&quot;: { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.
1867 &quot;a_key&quot;: &quot;A String&quot;,
1868 },
1869 &quot;multiWriter&quot;: True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.
1870 &quot;onUpdateAction&quot;: &quot;A String&quot;, # Specifies which action to take on instance update with this disk. Default is to use the existing disk.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]1871 &quot;provisionedIops&quot;: &quot;A String&quot;, # Indicates how many IOPS must be provisioned for the disk.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1872 &quot;resourcePolicies&quot;: [ # Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name.
1873 &quot;A String&quot;,
1874 ],
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1875 &quot;sourceImage&quot;: &quot;A String&quot;, # The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD.
1876 #
1877 # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image:
1878 # projects/debian-cloud/global/images/family/debian-9
1879 #
1880 #
1881 # Alternatively, use a specific version of a public operating system image:
1882 # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
1883 #
1884 #
1885 # To create a disk with a custom image that you created, specify the image name in the following format:
1886 # global/images/my-custom-image
1887 #
1888 #
1889 # You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
1890 # global/images/family/my-image-family
1891 #
1892 #
1893 # If the source image is deleted later, this field will not be set.
1894 &quot;sourceImageEncryptionKey&quot;: { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
1895 #
1896 # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1897 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
1898 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
1899 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1900 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
1901 #
1902 # The key must meet the following requirements before you can provide it to Compute Engine:
1903 # - The key is wrapped using a RSA public key certificate provided by Google.
1904 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:
1905 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1906 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1907 },
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1908 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD.
1909 #
1910 # To create a disk with a snapshot that you created, specify the snapshot name in the following format:
1911 # global/snapshots/my-backup
1912 #
1913 #
1914 # If the source snapshot is deleted later, this field will not be set.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1915 &quot;sourceSnapshotEncryptionKey&quot;: { # The customer-supplied encryption key of the source snapshot.
1916 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
1917 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
1918 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1919 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
1920 #
1921 # The key must meet the following requirements before you can provide it to Compute Engine:
1922 # - The key is wrapped using a RSA public key certificate provided by Google.
1923 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:
1924 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1925 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1926 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1927 },
1928 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
1929 &quot;kind&quot;: &quot;compute#attachedDisk&quot;, # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
1930 &quot;licenses&quot;: [ # [Output Only] Any valid publicly visible licenses.
1931 &quot;A String&quot;,
1932 ],
1933 &quot;mode&quot;: &quot;A String&quot;, # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
1934 &quot;shieldedInstanceInitialState&quot;: { # Initial State for shielded instance, these are public keys which are safe to store in public # [Output Only] shielded vm initial state stored on disk
1935 &quot;dbs&quot;: [ # The Key Database (db).
1936 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1937 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
1938 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1939 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1940 ],
1941 &quot;dbxs&quot;: [ # The forbidden key database (dbx).
1942 {
1943 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
1944 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
1945 },
1946 ],
1947 &quot;keks&quot;: [ # The Key Exchange Key (KEK).
1948 {
1949 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
1950 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
1951 },
1952 ],
1953 &quot;pk&quot;: { # The Platform Key (PK).
1954 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
1955 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1956 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1957 },
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1958 &quot;source&quot;: &quot;A String&quot;, # Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD.
1959 #
1960 # If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.
1961 #
1962 # Note that for InstanceTemplate, specify the disk name, not the URL for the disk.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1963 &quot;type&quot;: &quot;A String&quot;, # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1964 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1965 ],
1966 &quot;displayDevice&quot;: { # A set of Display Device options # Enables display device for the instance.
1967 &quot;enableDisplay&quot;: True or False, # Defines whether the instance has Display enabled.
1968 },
1969 &quot;eraseWindowsVssSignature&quot;: True or False, # Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1970 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this resource, which is essentially a hash of the instance&#x27;s contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update the instance. You must always provide an up-to-date fingerprint hash in order to update the instance.
1971 #
1972 # To see the latest fingerprint, make get() request to the instance.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1973 &quot;guestAccelerators&quot;: [ # A list of the type and count of accelerator cards attached to the instance.
1974 { # A specification of the type and number of accelerator cards attached to the instance.
1975 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
1976 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.
1977 },
1978 ],
1979 &quot;hostname&quot;: &quot;A String&quot;, # Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.
1980 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
1981 &quot;kind&quot;: &quot;compute#instance&quot;, # [Output Only] Type of the resource. Always compute#instance for instances.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1982 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for this request, which is essentially a hash of the label&#x27;s contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
1983 #
1984 # To see the latest fingerprint, make get() request to the instance.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1985 &quot;labels&quot;: { # Labels to apply to this instance. These can be later modified by the setLabels method.
1986 &quot;a_key&quot;: &quot;A String&quot;,
1987 },
1988 &quot;lastStartTimestamp&quot;: &quot;A String&quot;, # [Output Only] Last start timestamp in RFC3339 text format.
1989 &quot;lastStopTimestamp&quot;: &quot;A String&quot;, # [Output Only] Last stop timestamp in RFC3339 text format.
1990 &quot;lastSuspendedTimestamp&quot;: &quot;A String&quot;, # [Output Only] Last suspended timestamp in RFC3339 text format.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]1991 &quot;machineType&quot;: &quot;A String&quot;, # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:
1992 # zones/us-central1-f/machineTypes/n1-standard-1
1993 #
1994 #
1995 # To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):
1996 # zones/zone/machineTypes/custom-CPUS-MEMORY
1997 #
1998 #
1999 # For example: zones/us-central1-f/machineTypes/custom-4-5120
2000 #
2001 # For a full list of restrictions, read the Specifications for custom machine types.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2002 &quot;metadata&quot;: { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2003 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of the metadata&#x27;s contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet.
2004 #
2005 # To see the latest fingerprint, make a get() request to retrieve the resource.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2006 &quot;items&quot;: [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2007 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2008 &quot;key&quot;: &quot;A String&quot;, # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
2009 &quot;value&quot;: &quot;A String&quot;, # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2010 },
2011 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2012 &quot;kind&quot;: &quot;compute#metadata&quot;, # [Output Only] Type of the resource. Always compute#metadata for metadata.
2013 },
2014 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: &quot;Intel Haswell&quot; or minCpuPlatform: &quot;Intel Sandy Bridge&quot;.
2015 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
2016 &quot;networkInterfaces&quot;: [ # An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance.
2017 { # A network interface resource attached to an instance.
2018 &quot;accessConfigs&quot;: [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.
2019 { # An access configuration attached to an instance&#x27;s network interface. Only one access config per instance is supported.
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700[diff] [blame]2020 &quot;externalIpv6&quot;: &quot;A String&quot;, # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.
2021 &quot;externalIpv6PrefixLength&quot;: 42, # [Output Only] The prefix length of the external IPv6 range.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2022 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
2023 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access.
2024 &quot;natIP&quot;: &quot;A String&quot;, # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2025 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.
2026 #
2027 # If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.
2028 #
2029 # If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2030 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.
2031 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the external IP address of the instance to a DNS domain name.
2032 &quot;type&quot;: &quot;ONE_TO_ONE_NAT&quot;, # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
2033 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2034 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2035 &quot;aliasIpRanges&quot;: [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.
2036 { # An alias IP range attached to an instance&#x27;s network interface.
2037 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (such as 10.2.3.4), a netmask (such as /24) or a CIDR-formatted string (such as 10.1.2.0/24).
2038 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used.
2039 },
2040 ],
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]2041 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700[diff] [blame]2042 &quot;ipv6AccessConfigs&quot;: [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access.
2043 { # An access configuration attached to an instance&#x27;s network interface. Only one access config per instance is supported.
2044 &quot;externalIpv6&quot;: &quot;A String&quot;, # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.
2045 &quot;externalIpv6PrefixLength&quot;: 42, # [Output Only] The prefix length of the external IPv6 range.
2046 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
2047 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access.
2048 &quot;natIP&quot;: &quot;A String&quot;, # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2049 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.
2050 #
2051 # If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.
2052 #
2053 # If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700[diff] [blame]2054 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.
2055 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the external IP address of the instance to a DNS domain name.
2056 &quot;type&quot;: &quot;ONE_TO_ONE_NAT&quot;, # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
2057 },
2058 ],
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2059 &quot;ipv6AccessType&quot;: &quot;A String&quot;, # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork.
2060 #
2061 # Valid only if stackType is IPV4_IPV6.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2062 &quot;ipv6Address&quot;: &quot;A String&quot;, # [Output Only] An IPv6 internal network address for this network interface.
2063 &quot;kind&quot;: &quot;compute#networkInterface&quot;, # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.
2064 &quot;name&quot;: &quot;A String&quot;, # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2065 &quot;network&quot;: &quot;A String&quot;, # URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred.
2066 #
2067 # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
2068 # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
2069 # - projects/project/global/networks/network
2070 # - global/networks/default
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2071 &quot;networkIP&quot;: &quot;A String&quot;, # An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]2072 &quot;nicType&quot;: &quot;A String&quot;, # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2073 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for this network interface to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used.
2074 #
2075 # This field can be both set at instance creation and update network interface operations.
2076 &quot;subnetwork&quot;: &quot;A String&quot;, # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
2077 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
2078 # - regions/region/subnetworks/subnetwork
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2079 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2080 ],
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]2081 &quot;networkPerformanceConfig&quot;: {
2082 &quot;totalEgressBandwidthTier&quot;: &quot;A String&quot;,
2083 },
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]2084 &quot;postKeyRevocationActionType&quot;: &quot;A String&quot;, # PostKeyRevocationActionType of the instance.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2085 &quot;privateIpv6GoogleAccess&quot;: &quot;A String&quot;, # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2086 &quot;reservationAffinity&quot;: { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2087 &quot;consumeReservationType&quot;: &quot;A String&quot;, # Specifies the type of reservation from which this instance can consume resources: ANY_RESERVATION (default), SPECIFIC_RESERVATION, or NO_RESERVATION. See Consuming reserved instances for examples.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2088 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify googleapis.com/reservation-name as the key and specify the name of your reservation as its value.
yoshi-code-bot73a0aa32021-05-25 00:30:03 -0700[diff] [blame]2089 &quot;values&quot;: [ # Corresponds to the label values of a reservation resource. This can be either a name to a reservation in the same project or &quot;projects/different-project/reservations/some-reservation-name&quot; to target a shared reservation in the same zone but in a different project.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2090 &quot;A String&quot;,
2091 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2092 },
2093 &quot;resourcePolicies&quot;: [ # Resource policies applied to this instance.
2094 &quot;A String&quot;,
2095 ],
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]2096 &quot;satisfiesPzs&quot;: True or False, # [Output Only] Reserved for future use.
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700[diff] [blame]2097 &quot;scheduling&quot;: { # Sets the scheduling options for an Instance. NextID: 21 # Sets the scheduling options for this instance.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2098 &quot;automaticRestart&quot;: True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
2099 #
2100 # By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.
yoshi-code-bot73a0aa32021-05-25 00:30:03 -0700[diff] [blame]2101 &quot;hostErrorTimeoutSeconds&quot;: 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]2102 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API.
yoshi-code-bot9e2cde22021-04-29 03:48:05 -0700[diff] [blame]2103 &quot;maintenanceFreezeDurationHours&quot;: 42, # Specifies the number of hours after VM instance creation where the VM won&#x27;t be scheduled for maintenance.
2104 &quot;maintenanceInterval&quot;: &quot;A String&quot;, # For more information about maintenance intervals, see Setting maintenance intervals.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2105 &quot;minNodeCpus&quot;: 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.
2106 &quot;nodeAffinities&quot;: [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.
2107 { # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.
2108 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of Node resource.
2109 &quot;operator&quot;: &quot;A String&quot;, # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.
2110 &quot;values&quot;: [ # Corresponds to the label values of Node resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2111 &quot;A String&quot;,
2112 ],
2113 },
2114 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2115 &quot;onHostMaintenance&quot;: &quot;A String&quot;, # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
2116 &quot;preemptible&quot;: True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.
2117 },
2118 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2119 &quot;serviceAccounts&quot;: [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.
2120 #
2121 # Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2122 { # A service account.
2123 &quot;email&quot;: &quot;A String&quot;, # Email address of the service account.
2124 &quot;scopes&quot;: [ # The list of scopes to be made available for this service account.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2125 &quot;A String&quot;,
2126 ],
2127 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2128 ],
2129 &quot;shieldedInstanceConfig&quot;: { # A set of Shielded Instance options.
2130 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.
2131 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.
2132 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.
2133 },
2134 &quot;shieldedInstanceIntegrityPolicy&quot;: { # The policy describes the baseline against which Instance boot integrity is measured.
2135 &quot;updateAutoLearnPolicy&quot;: True or False, # Updates the integrity policy baseline using the measurements from the VM instance&#x27;s most recent boot.
2136 },
2137 &quot;shieldedVmConfig&quot;: { # A set of Shielded VM options. # Deprecating, please use shielded_instance_config.
2138 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.
2139 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.
2140 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.
2141 },
2142 &quot;shieldedVmIntegrityPolicy&quot;: { # The policy describes the baseline against which VM instance boot integrity is measured. # Deprecating, please use shielded_instance_integrity_policy.
2143 &quot;updateAutoLearnPolicy&quot;: True or False, # Updates the integrity policy baseline using the measurements from the VM instance&#x27;s most recent boot.
2144 },
2145 &quot;sourceMachineImage&quot;: &quot;A String&quot;, # Source machine image
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]2146 &quot;sourceMachineImageEncryptionKey&quot;: { # Source machine image encryption key when creating an instance from a machine image.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2147 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
2148 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
2149 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2150 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
2151 #
2152 # The key must meet the following requirements before you can provide it to Compute Engine:
2153 # - The key is wrapped using a RSA public key certificate provided by Google.
2154 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:
2155 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2156 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
2157 },
2158 &quot;startRestricted&quot;: True or False, # [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2159 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2160 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable explanation of the status.
2161 &quot;tags&quot;: { # A set of instance tags. # Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. Multiple tags can be specified via the &#x27;tags.items&#x27; field.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2162 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of the tags&#x27; contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update tags. You must always provide an up-to-date fingerprint hash in order to update or change tags.
2163 #
2164 # To see the latest fingerprint, make get() request to the instance.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2165 &quot;items&quot;: [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
2166 &quot;A String&quot;,
2167 ],
2168 },
2169 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
2170}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]2171</div>
2172
2173<div class="method">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2174 <code class="details" id="getEffectiveFirewalls">getEffectiveFirewalls(project, zone, instance, networkInterface)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2175 <pre>Returns effective firewalls applied to an interface of the instance.
2176
2177Args:
2178 project: string, Project ID for this request. (required)
2179 zone: string, The name of the zone for this request. (required)
2180 instance: string, Name of the instance scoping this request. (required)
2181 networkInterface: string, The name of the network interface to get the effective firewalls. (required)
2182
2183Returns:
2184 An object of the form:
2185
2186 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2187 &quot;firewallPolicys&quot;: [ # Effective firewalls from firewall policies.
2188 {
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]2189 &quot;displayName&quot;: &quot;A String&quot;, # [Output Only] Deprecated, please use short name instead. The display name of the firewall policy.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2190 &quot;name&quot;: &quot;A String&quot;, # [Output Only] The name of the firewall policy.
2191 &quot;rules&quot;: [ # The rules that apply to the network.
2192 { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).
2193 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule. Can currently be either &quot;allow&quot; or &quot;deny()&quot; where valid values for status are 403, 404, and 502.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]2194 &quot;description&quot;: &quot;A String&quot;, # An optional description for this resource.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2195 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies.
2196 &quot;disabled&quot;: True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.
2197 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on &quot;goto_next&quot; rules.
2198 &quot;kind&quot;: &quot;compute#firewallPolicyRule&quot;, # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]2199 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2200 &quot;destIpRanges&quot;: [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 256.
2201 &quot;A String&quot;,
2202 ],
2203 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
2204 {
2205 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2206 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
2207 #
2208 # Example inputs include: [&quot;22&quot;], [&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2209 &quot;A String&quot;,
2210 ],
2211 },
2212 ],
2213 &quot;srcIpRanges&quot;: [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 256.
2214 &quot;A String&quot;,
2215 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2216 },
2217 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.
2218 &quot;ruleTupleCount&quot;: 42, # [Output Only] Calculation of the complexity of a single firewall policy rule.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]2219 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field allows you to control which network&#x27;s VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2220 &quot;A String&quot;,
2221 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2222 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are applied with this rule.
2223 &quot;A String&quot;,
2224 ],
2225 },
2226 ],
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]2227 &quot;shortName&quot;: &quot;A String&quot;, # [Output Only] The short name of the firewall policy.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2228 &quot;type&quot;: &quot;A String&quot;, # [Output Only] The type of the firewall policy.
2229 },
2230 ],
2231 &quot;firewalls&quot;: [ # Effective firewalls on the instance.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2232 { # Represents a Firewall Rule resource.
2233 #
2234 # Firewall rules allow or deny ingress traffic to, and egress traffic from your instances. For more information, read Firewall rules.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2235 &quot;allowed&quot;: [ # The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
2236 {
2237 &quot;IPProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp) or the IP protocol number.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2238 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
2239 #
2240 # Example inputs include: [&quot;22&quot;], [&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2241 &quot;A String&quot;,
2242 ],
2243 },
2244 ],
2245 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
2246 &quot;denied&quot;: [ # The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.
2247 {
2248 &quot;IPProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp) or the IP protocol number.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2249 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
2250 #
2251 # Example inputs include: [&quot;22&quot;], [&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2252 &quot;A String&quot;,
2253 ],
2254 },
2255 ],
2256 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this field when you create the resource.
2257 &quot;destinationRanges&quot;: [ # If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Only IPv4 is supported.
2258 &quot;A String&quot;,
2259 ],
2260 &quot;direction&quot;: &quot;A String&quot;, # Direction of traffic to which this firewall applies, either `INGRESS` or `EGRESS`. The default is `INGRESS`. For `INGRESS` traffic, you cannot specify the destinationRanges field, and for `EGRESS` traffic, you cannot specify the sourceRanges or sourceTags fields.
2261 &quot;disabled&quot;: True or False, # Denotes whether the firewall rule is disabled. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled.
2262 &quot;enableLogging&quot;: True or False, # Deprecated in favor of enable in LogConfig. This field denotes whether to enable logging for a particular firewall rule. If logging is enabled, logs will be exported t Cloud Logging.
2263 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
2264 &quot;kind&quot;: &quot;compute#firewall&quot;, # [Output Only] Type of the resource. Always compute#firewall for firewall rules.
2265 &quot;logConfig&quot;: { # The available logging options for a firewall rule. # This field denotes the logging options for a particular firewall rule. If logging is enabled, logs will be exported to Cloud Logging.
2266 &quot;enable&quot;: True or False, # This field denotes whether to enable logging for a particular firewall rule.
2267 &quot;metadata&quot;: &quot;A String&quot;, # This field can only be specified for a particular firewall rule if logging is enabled for that rule. This field denotes whether to include or exclude metadata for firewall logs.
2268 },
2269 &quot;name&quot;: &quot;A String&quot;, # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2270 &quot;network&quot;: &quot;A String&quot;, # URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used:
2271 # global/networks/default
2272 # If you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
2273 # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
2274 # - projects/myproject/global/networks/my-network
2275 # - global/networks/default
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2276 &quot;priority&quot;: 42, # Priority for this rule. This is an integer between `0` and `65535`, both inclusive. The default value is `1000`. Relative priorities determine which rule takes effect if multiple rules apply. Lower values indicate higher priority. For example, a rule with priority `0` has higher precedence than a rule with priority `1`. DENY rules take precedence over ALLOW rules if they have equal priority. Note that VPC networks have implied rules with a priority of `65535`. To avoid conflicts with the implied rules, use a priority number less than `65535`.
2277 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2278 &quot;sourceRanges&quot;: [ # If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the rule to apply. Only IPv4 is supported.
2279 &quot;A String&quot;,
2280 ],
2281 &quot;sourceServiceAccounts&quot;: [ # If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance&#x27;s external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall applies to traffic that has a source IP address within the sourceRanges OR a source IP that belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both fields for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags.
2282 &quot;A String&quot;,
2283 ],
2284 &quot;sourceTags&quot;: [ # If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance&#x27;s external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both fields are set, the firewall applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the firewall to apply.
2285 &quot;A String&quot;,
2286 ],
2287 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network.
2288 &quot;A String&quot;,
2289 ],
2290 &quot;targetTags&quot;: [ # A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
2291 &quot;A String&quot;,
2292 ],
2293 },
2294 ],
2295 &quot;organizationFirewalls&quot;: [ # Effective firewalls from organization policies.
2296 { # A pruned SecurityPolicy containing ID and any applicable firewall rules.
2297 &quot;id&quot;: &quot;A String&quot;, # The unique identifier for the security policy. This identifier is defined by the server.
2298 &quot;rules&quot;: [ # The rules that apply to the network.
2299 { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame]2300 &quot;action&quot;: &quot;A String&quot;, # The Action to perform when the client connection triggers the rule. Can currently be either &quot;allow&quot; or &quot;deny()&quot; where valid values for status are 403, 404, and 502.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2301 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
2302 &quot;direction&quot;: &quot;A String&quot;, # The direction in which this rule applies. This field may only be specified when versioned_expr is set to FIREWALL.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2303 &quot;enableLogging&quot;: True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on &quot;goto_next&quot; rules.
2304 #
2305 # This field may only be specified when the versioned_expr is set to FIREWALL.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2306 &quot;kind&quot;: &quot;compute#securityPolicyRule&quot;, # [Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules
2307 &quot;match&quot;: { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding &#x27;action&#x27; is enforced.
2308 &quot;config&quot;: { # The configuration options available when specifying versioned_expr. This field must be specified if versioned_expr is specified and cannot be specified if versioned_expr is not specified.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2309 &quot;destIpRanges&quot;: [ # CIDR IP address range.
2310 #
2311 # This field may only be specified when versioned_expr is set to FIREWALL.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2312 &quot;A String&quot;,
2313 ],
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2314 &quot;layer4Configs&quot;: [ # Pairs of IP protocols and ports that the rule should match.
2315 #
2316 # This field may only be specified when versioned_expr is set to FIREWALL.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2317 {
2318 &quot;ipProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2319 &quot;ports&quot;: [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
2320 #
2321 # Example inputs include: [&quot;22&quot;], [&quot;80&quot;,&quot;443&quot;], and [&quot;12345-12349&quot;].
2322 #
2323 # This field may only be specified when versioned_expr is set to FIREWALL.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2324 &quot;A String&quot;,
2325 ],
2326 },
2327 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2328 &quot;srcIpRanges&quot;: [ # CIDR IP address range. Maximum number of src_ip_ranges allowed is 10.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2329 &quot;A String&quot;,
2330 ],
2331 },
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2332 &quot;expr&quot;: { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. # User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header.
2333 #
2334 # Example (Comparison):
2335 #
2336 # title: &quot;Summary size limit&quot; description: &quot;Determines if a summary is less than 100 chars&quot; expression: &quot;document.summary.size() &lt; 100&quot;
2337 #
2338 # Example (Equality):
2339 #
2340 # title: &quot;Requestor is owner&quot; description: &quot;Determines if requestor is the document owner&quot; expression: &quot;document.owner == request.auth.claims.email&quot;
2341 #
2342 # Example (Logic):
2343 #
2344 # title: &quot;Public documents&quot; description: &quot;Determine whether the document should be publicly visible&quot; expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
2345 #
2346 # Example (Data Manipulation):
2347 #
2348 # title: &quot;Notification string&quot; description: &quot;Create a notification string with a timestamp.&quot; expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
2349 #
2350 # The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2351 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
2352 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
2353 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
2354 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
2355 },
2356 &quot;versionedExpr&quot;: &quot;A String&quot;, # Preconfigured versioned expression. If this field is specified, config must also be specified. Available preconfigured expressions along with their requirements are: SRC_IPS_V1 - must specify the corresponding src_ip_range field in config.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2357 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2358 &quot;preview&quot;: True or False, # If set to true, the specified action is not enforced.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]2359 &quot;priority&quot;: 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2360 &quot;ruleNumber&quot;: &quot;A String&quot;, # Identifier for the rule. This is only unique within the given security policy. This can only be set during rule creation, if rule number is not specified it will be generated by the server.
2361 &quot;ruleTupleCount&quot;: 42, # [Output Only] Calculation of the complexity of a single firewall security policy rule.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2362 &quot;targetResources&quot;: [ # A list of network resource URLs to which this rule applies. This field allows you to control which network&#x27;s VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.
2363 #
2364 # This field may only be specified when versioned_expr is set to FIREWALL.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2365 &quot;A String&quot;,
2366 ],
2367 &quot;targetServiceAccounts&quot;: [ # A list of service accounts indicating the sets of instances that are applied with this rule.
2368 &quot;A String&quot;,
2369 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2370 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2371 ],
2372 },
2373 ],
2374}</pre>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2375</div>
2376
2377<div class="method">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2378 <code class="details" id="getGuestAttributes">getGuestAttributes(project, zone, instance, queryPath=None, variableKey=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2379 <pre>Returns the specified guest attributes entry.
2380
2381Args:
2382 project: string, Project ID for this request. (required)
2383 zone: string, The name of the zone for this request. (required)
2384 instance: string, Name of the instance scoping this request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2385 queryPath: string, Specifies the guest attributes path to be queried.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2386 variableKey: string, Specifies the key for the guest attributes entry.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2387
2388Returns:
2389 An object of the form:
2390
2391 { # A guest attributes entry.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2392 &quot;kind&quot;: &quot;compute#guestAttributes&quot;, # [Output Only] Type of the resource. Always compute#guestAttributes for guest attributes entry.
2393 &quot;queryPath&quot;: &quot;A String&quot;, # The path to be queried. This can be the default namespace (&#x27;/&#x27;) or a nested namespace (&#x27;/\/&#x27;) or a specified key (&#x27;/\/\&#x27;)
2394 &quot;queryValue&quot;: { # Array of guest attribute namespace/key/value tuples. # [Output Only] The value of the requested queried path.
2395 &quot;items&quot;: [
2396 { # A guest attributes namespace/key/value entry.
2397 &quot;key&quot;: &quot;A String&quot;, # Key for the guest attribute entry.
2398 &quot;namespace&quot;: &quot;A String&quot;, # Namespace for the guest attribute entry.
2399 &quot;value&quot;: &quot;A String&quot;, # Value for the guest attribute entry.
2400 },
2401 ],
2402 },
2403 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
2404 &quot;variableKey&quot;: &quot;A String&quot;, # The key to search for.
2405 &quot;variableValue&quot;: &quot;A String&quot;, # [Output Only] The value found for the requested key.
2406}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2407</div>
2408
2409<div class="method">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2410 <code class="details" id="getIamPolicy">getIamPolicy(project, zone, resource, optionsRequestedPolicyVersion=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2411 <pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists.
2412
2413Args:
2414 project: string, Project ID for this request. (required)
2415 zone: string, The name of the zone for this request. (required)
2416 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2417 optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2418
2419Returns:
2420 An object of the form:
2421
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2422 { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.
2423 #
2424 #
2425 #
2426 # A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role.
2427 #
2428 # For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
2429 #
2430 # **JSON example:**
2431 #
2432 # { &quot;bindings&quot;: [ { &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;, &quot;members&quot;: [ &quot;user:mike@example.com&quot;, &quot;group:admins@example.com&quot;, &quot;domain:google.com&quot;, &quot;serviceAccount:my-project-id@appspot.gserviceaccount.com&quot; ] }, { &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;, &quot;members&quot;: [ &quot;user:eve@example.com&quot; ], &quot;condition&quot;: { &quot;title&quot;: &quot;expirable access&quot;, &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;, &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;, } } ], &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;, &quot;version&quot;: 3 }
2433 #
2434 # **YAML example:**
2435 #
2436 # bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;) - etag: BwWWja0YfJA= - version: 3
2437 #
2438 # For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2439 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2440 { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.
2441 #
2442 # If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.
2443 #
2444 # Example Policy with multiple AuditConfigs:
2445 #
2446 # { &quot;audit_configs&quot;: [ { &quot;service&quot;: &quot;allServices&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:jose@example.com&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; }, { &quot;log_type&quot;: &quot;ADMIN_READ&quot; } ] }, { &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot; }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot;, &quot;exempted_members&quot;: [ &quot;user:aliya@example.com&quot; ] } ] } ] }
2447 #
2448 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2449 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2450 { # Provides the configuration for logging a type of permissions. Example:
2451 #
2452 # { &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:jose@example.com&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; } ] }
2453 #
2454 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting jose@example.com from DATA_READ logging.
2455 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2456 &quot;A String&quot;,
2457 ],
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2458 &quot;ignoreChildExemptions&quot;: True or False,
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2459 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2460 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2461 ],
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2462 &quot;exemptedMembers&quot;: [
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2463 &quot;A String&quot;,
2464 ],
2465 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
2466 },
2467 ],
2468 &quot;bindings&quot;: [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.
2469 { # Associates `members` with a `role`.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2470 &quot;bindingId&quot;: &quot;A String&quot;,
2471 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. # The condition that is associated with this binding.
2472 #
2473 # If the condition evaluates to `true`, then this binding applies to the current request.
2474 #
2475 # If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.
2476 #
2477 # To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
2478 #
2479 # Example (Comparison):
2480 #
2481 # title: &quot;Summary size limit&quot; description: &quot;Determines if a summary is less than 100 chars&quot; expression: &quot;document.summary.size() &lt; 100&quot;
2482 #
2483 # Example (Equality):
2484 #
2485 # title: &quot;Requestor is owner&quot; description: &quot;Determines if requestor is the document owner&quot; expression: &quot;document.owner == request.auth.claims.email&quot;
2486 #
2487 # Example (Logic):
2488 #
2489 # title: &quot;Public documents&quot; description: &quot;Determine whether the document should be publicly visible&quot; expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
2490 #
2491 # Example (Data Manipulation):
2492 #
2493 # title: &quot;Notification string&quot; description: &quot;Create a notification string with a timestamp.&quot; expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
2494 #
2495 # The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2496 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
2497 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
2498 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
2499 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2500 },
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2501 &quot;members&quot;: [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
2502 #
2503 # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
2504 #
2505 # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
2506 #
2507 # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .
2508 #
2509 #
2510 #
2511 # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
2512 #
2513 # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
2514 #
2515 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding.
2516 #
2517 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding.
2518 #
2519 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.
2520 #
2521 #
2522 #
2523 # * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2524 &quot;A String&quot;,
2525 ],
2526 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
2527 },
2528 ],
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2529 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
2530 #
2531 # **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
2532 &quot;iamOwned&quot;: True or False,
2533 &quot;rules&quot;: [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
2534 { # A rule to be applied in a Policy.
2535 &quot;action&quot;: &quot;A String&quot;, # Required
2536 &quot;conditions&quot;: [ # Additional restrictions that must be met. All conditions must pass for the rule to match.
2537 { # A condition to be met.
2538 &quot;iam&quot;: &quot;A String&quot;, # Trusted attributes supplied by the IAM system.
2539 &quot;op&quot;: &quot;A String&quot;, # An operator to apply the subject with.
2540 &quot;svc&quot;: &quot;A String&quot;, # Trusted attributes discharged by the service.
2541 &quot;sys&quot;: &quot;A String&quot;, # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
2542 &quot;values&quot;: [ # The objects of the condition.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2543 &quot;A String&quot;,
2544 ],
2545 },
2546 ],
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2547 &quot;description&quot;: &quot;A String&quot;, # Human-readable description of the rule.
2548 &quot;ins&quot;: [ # If one or more &#x27;in&#x27; clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2549 &quot;A String&quot;,
2550 ],
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2551 &quot;logConfigs&quot;: [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
2552 { # Specifies what kind of log the caller must write
2553 &quot;cloudAudit&quot;: { # Write a Cloud Audit log # Cloud audit options.
2554 &quot;authorizationLoggingOptions&quot;: { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.
2555 &quot;permissionType&quot;: &quot;A String&quot;, # The type of the permission that was checked.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2556 },
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2557 &quot;logName&quot;: &quot;A String&quot;, # The log_name to populate in the Cloud Audit Record.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2558 },
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2559 &quot;counter&quot;: { # Increment a streamz counter with the specified metric and field names. # Counter options.
2560 #
2561 # Metric names should start with a &#x27;/&#x27;, generally be lowercase-only, and end in &quot;_count&quot;. Field names should not contain an initial slash. The actual exported metric names will have &quot;/iam/policy&quot; prepended.
2562 #
2563 # Field names correspond to IAM request parameters and field values are their respective values.
2564 #
2565 # Supported field names: - &quot;authority&quot;, which is &quot;[token]&quot; if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - &quot;iam_principal&quot;, a representation of IAMContext.principal even if a token or authority selector is present; or - &quot;&quot; (empty string), resulting in a counter with no fields.
2566 #
2567 # Examples: counter { metric: &quot;/debug_access_count&quot; field: &quot;iam_principal&quot; } ==&gt; increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}
2568 &quot;customFields&quot;: [ # Custom fields.
2569 { # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.
2570 &quot;name&quot;: &quot;A String&quot;, # Name is the field name.
2571 &quot;value&quot;: &quot;A String&quot;, # Value is the field value. It is important that in contrast to the CounterOptions.field, the value here is a constant that is not derived from the IAMContext.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2572 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2573 ],
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2574 &quot;field&quot;: &quot;A String&quot;, # The field value to attribute.
2575 &quot;metric&quot;: &quot;A String&quot;, # The metric to update.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2576 },
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2577 &quot;dataAccess&quot;: { # Write a Data Access (Gin) log # Data access options.
2578 &quot;logMode&quot;: &quot;A String&quot;,
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2579 },
2580 },
2581 ],
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2582 &quot;notIns&quot;: [ # If one or more &#x27;not_in&#x27; clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2583 &quot;A String&quot;,
2584 ],
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2585 &quot;permissions&quot;: [ # A permission is a string of form &#x27;..&#x27; (e.g., &#x27;storage.buckets.list&#x27;). A value of &#x27;*&#x27; matches all permissions, and a verb part of &#x27;*&#x27; (e.g., &#x27;storage.buckets.*&#x27;) matches all verbs.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2586 &quot;A String&quot;,
2587 ],
2588 },
2589 ],
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2590 &quot;version&quot;: 42, # Specifies the format of the policy.
2591 #
2592 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.
2593 #
2594 # Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:
2595 #
2596 # * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions
2597 #
2598 # **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
2599 #
2600 # If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.
2601 #
2602 # To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2603}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2604</div>
2605
2606<div class="method">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2607 <code class="details" id="getScreenshot">getScreenshot(project, zone, instance)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2608 <pre>Returns the screenshot from the specified instance.
2609
2610Args:
2611 project: string, Project ID for this request. (required)
2612 zone: string, The name of the zone for this request. (required)
2613 instance: string, Name of the instance scoping this request. (required)
2614
2615Returns:
2616 An object of the form:
2617
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2618 { # An instance&#x27;s screenshot.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2619 &quot;contents&quot;: &quot;A String&quot;, # [Output Only] The Base64-encoded screenshot data.
2620 &quot;kind&quot;: &quot;compute#screenshot&quot;, # [Output Only] Type of the resource. Always compute#screenshot for the screenshots.
2621}</pre>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2622</div>
2623
2624<div class="method">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2625 <code class="details" id="getSerialPortOutput">getSerialPortOutput(project, zone, instance, port=None, start=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2626 <pre>Returns the last 1 MB of serial port output from the specified instance.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]2627
2628Args:
2629 project: string, Project ID for this request. (required)
2630 zone: string, The name of the zone for this request. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]2631 instance: string, Name of the instance for this request. (required)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]2632 port: integer, Specifies which COM or serial port to retrieve data from.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2633 start: string, Specifies the starting byte position of the output to return. To start with the first byte of output to the specified port, omit this field or set it to `0`.
2634
2635If the output for that byte position is available, this field matches the `start` parameter sent with the request. If the amount of serial console output exceeds the size of the buffer (1 MB), the oldest output is discarded and is no longer available. If the requested start position refers to discarded output, the start position is adjusted to the oldest output still available, and the adjusted start position is returned as the `start` property value.
2636
2637You can also provide a negative start position, which translates to the most recent number of bytes written to the serial port. For example, -3 is interpreted as the most recent 3 bytes written to the serial console.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]2638
2639Returns:
2640 An object of the form:
2641
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2642 { # An instance&#x27;s serial console output.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2643 &quot;contents&quot;: &quot;A String&quot;, # [Output Only] The contents of the console output.
2644 &quot;kind&quot;: &quot;compute#serialPortOutput&quot;, # [Output Only] Type of the resource. Always compute#serialPortOutput for serial port output.
2645 &quot;next&quot;: &quot;A String&quot;, # [Output Only] The position of the next byte of content, regardless of whether the content exists, following the output returned in the `contents` property. Use this value in the next request as the start parameter.
2646 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
2647 &quot;start&quot;: &quot;A String&quot;, # The starting byte position of the output that was returned. This should match the start parameter sent with the request. If the serial console output exceeds the size of the buffer (1 MB), older output is overwritten by newer content. The output start value will indicate the byte position of the output that was returned, which might be different than the `start` value that was specified in the request.
2648}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]2649</div>
2650
2651<div class="method">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2652 <code class="details" id="getShieldedInstanceIdentity">getShieldedInstanceIdentity(project, zone, instance)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2653 <pre>Returns the Shielded Instance Identity of an instance
2654
2655Args:
2656 project: string, Project ID for this request. (required)
2657 zone: string, The name of the zone for this request. (required)
2658 instance: string, Name or id of the instance scoping this request. (required)
2659
2660Returns:
2661 An object of the form:
2662
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2663 { # A shielded Instance identity entry.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2664 &quot;encryptionKey&quot;: { # A Shielded Instance Identity Entry. # An Endorsement Key (EK) made by the RSA 2048 algorithm issued to the Shielded Instance&#x27;s vTPM.
2665 &quot;ekCert&quot;: &quot;A String&quot;, # A PEM-encoded X.509 certificate. This field can be empty.
2666 &quot;ekPub&quot;: &quot;A String&quot;, # A PEM-encoded public key.
2667 },
2668 &quot;kind&quot;: &quot;compute#shieldedInstanceIdentity&quot;, # [Output Only] Type of the resource. Always compute#shieldedInstanceIdentity for shielded Instance identity entry.
2669 &quot;signingKey&quot;: { # A Shielded Instance Identity Entry. # An Attestation Key (AK) made by the RSA 2048 algorithm issued to the Shielded Instance&#x27;s vTPM.
2670 &quot;ekCert&quot;: &quot;A String&quot;, # A PEM-encoded X.509 certificate. This field can be empty.
2671 &quot;ekPub&quot;: &quot;A String&quot;, # A PEM-encoded public key.
2672 },
2673}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2674</div>
2675
2676<div class="method">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2677 <code class="details" id="getShieldedVmIdentity">getShieldedVmIdentity(project, zone, instance)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2678 <pre>Returns the Shielded VM Identity of an instance
2679
2680Args:
2681 project: string, Project ID for this request. (required)
2682 zone: string, The name of the zone for this request. (required)
2683 instance: string, Name of the instance scoping this request. (required)
2684
2685Returns:
2686 An object of the form:
2687
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2688 { # A shielded VM identity entry.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2689 &quot;encryptionKey&quot;: { # A Shielded Instance Identity Entry. # An Endorsement Key (EK) issued to the Shielded VM&#x27;s vTPM.
2690 &quot;ekCert&quot;: &quot;A String&quot;, # A PEM-encoded X.509 certificate. This field can be empty.
2691 &quot;ekPub&quot;: &quot;A String&quot;, # A PEM-encoded public key.
2692 },
2693 &quot;kind&quot;: &quot;compute#shieldedVmIdentity&quot;, # [Output Only] Type of the resource. Always compute#shieldedVmIdentity for shielded VM identity entry.
2694 &quot;signingKey&quot;: { # A Shielded Instance Identity Entry. # An Attestation Key (AK) issued to the Shielded VM&#x27;s vTPM.
2695 &quot;ekCert&quot;: &quot;A String&quot;, # A PEM-encoded X.509 certificate. This field can be empty.
2696 &quot;ekPub&quot;: &quot;A String&quot;, # A PEM-encoded public key.
2697 },
2698}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2699</div>
2700
2701<div class="method">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2702 <code class="details" id="insert">insert(project, zone, body=None, requestId=None, sourceInstanceTemplate=None, sourceMachineImage=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]2703 <pre>Creates an instance resource in the specified project using the data included in the request.
2704
2705Args:
2706 project: string, Project ID for this request. (required)
2707 zone: string, The name of the zone for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2708 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]2709 The object takes the form of:
2710
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2711{ # Represents an Instance resource.
2712 #
2713 # An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. (== resource_for {$api_version}.instances ==)
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]2714 &quot;advancedMachineFeatures&quot;: { # Specifies options for controlling advanced machine features. Options that would traditionally be configured in a BIOS belong here. Features that require operating system support may have corresponding entries in the GuestOsFeatures of an Image (e.g., whether or not the OS in the Image supports nested virtualization being enabled or disabled). # Controls for advanced machine-related behavior features.
2715 &quot;enableNestedVirtualization&quot;: True or False, # Whether to enable nested virtualization or not (default is false).
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame]2716 &quot;threadsPerCore&quot;: 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]2717 },
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2718 &quot;canIpForward&quot;: True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]2719 &quot;confidentialInstanceConfig&quot;: { # A set of Confidential Instance options.
2720 &quot;enableConfidentialCompute&quot;: True or False, # Defines whether the instance should have confidential compute enabled.
2721 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2722 &quot;cpuPlatform&quot;: &quot;A String&quot;, # [Output Only] The CPU platform used by this instance.
2723 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
2724 &quot;deletionProtection&quot;: True or False, # Whether the resource should be protected against deletion.
2725 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
2726 &quot;disks&quot;: [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]2727 { # An instance-attached disk resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2728 &quot;autoDelete&quot;: True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
2729 &quot;boot&quot;: True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2730 &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 running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
2731 #
2732 # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
2733 &quot;diskEncryptionKey&quot;: { # Encrypts or decrypts a disk using a customer-supplied encryption key.
2734 #
2735 # If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
2736 #
2737 # If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
2738 #
2739 # If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
2740 #
2741 # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2742 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
2743 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
2744 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2745 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
2746 #
2747 # The key must meet the following requirements before you can provide it to Compute Engine:
2748 # - The key is wrapped using a RSA public key certificate provided by Google.
2749 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:
2750 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2751 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]2752 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2753 &quot;diskSizeGb&quot;: &quot;A String&quot;, # The size of the disk in GB.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2754 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2755 { # Guest OS features.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2756 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2757 },
2758 ],
2759 &quot;index&quot;: 42, # [Output Only] A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2760 &quot;initializeParams&quot;: { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
2761 #
2762 # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
2763 #
2764 # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2765 &quot;description&quot;: &quot;A String&quot;, # An optional description. Provide this property when creating the disk.
2766 &quot;diskName&quot;: &quot;A String&quot;, # Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created.
2767 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2768 &quot;diskType&quot;: &quot;A String&quot;, # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
2769 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
2770 #
2771 #
2772 # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
2773 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
2774 # - projects/project/zones/zone/diskTypes/diskType
2775 # - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.
2776 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.
2777 #
2778 # Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2779 { # Guest OS features.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2780 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2781 },
2782 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2783 &quot;labels&quot;: { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.
2784 &quot;a_key&quot;: &quot;A String&quot;,
2785 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]2786 &quot;multiWriter&quot;: True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2787 &quot;onUpdateAction&quot;: &quot;A String&quot;, # Specifies which action to take on instance update with this disk. Default is to use the existing disk.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]2788 &quot;provisionedIops&quot;: &quot;A String&quot;, # Indicates how many IOPS must be provisioned for the disk.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2789 &quot;resourcePolicies&quot;: [ # Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name.
2790 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2791 ],
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2792 &quot;sourceImage&quot;: &quot;A String&quot;, # The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD.
2793 #
2794 # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image:
2795 # projects/debian-cloud/global/images/family/debian-9
2796 #
2797 #
2798 # Alternatively, use a specific version of a public operating system image:
2799 # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
2800 #
2801 #
2802 # To create a disk with a custom image that you created, specify the image name in the following format:
2803 # global/images/my-custom-image
2804 #
2805 #
2806 # You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
2807 # global/images/family/my-image-family
2808 #
2809 #
2810 # If the source image is deleted later, this field will not be set.
2811 &quot;sourceImageEncryptionKey&quot;: { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
2812 #
2813 # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2814 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
2815 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
2816 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2817 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
2818 #
2819 # The key must meet the following requirements before you can provide it to Compute Engine:
2820 # - The key is wrapped using a RSA public key certificate provided by Google.
2821 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:
2822 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2823 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
2824 },
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2825 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD.
2826 #
2827 # To create a disk with a snapshot that you created, specify the snapshot name in the following format:
2828 # global/snapshots/my-backup
2829 #
2830 #
2831 # If the source snapshot is deleted later, this field will not be set.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]2832 &quot;sourceSnapshotEncryptionKey&quot;: { # The customer-supplied encryption key of the source snapshot.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2833 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
2834 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
2835 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2836 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
2837 #
2838 # The key must meet the following requirements before you can provide it to Compute Engine:
2839 # - The key is wrapped using a RSA public key certificate provided by Google.
2840 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:
2841 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2842 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2843 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]2844 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2845 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
2846 &quot;kind&quot;: &quot;compute#attachedDisk&quot;, # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
2847 &quot;licenses&quot;: [ # [Output Only] Any valid publicly visible licenses.
2848 &quot;A String&quot;,
2849 ],
2850 &quot;mode&quot;: &quot;A String&quot;, # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
2851 &quot;shieldedInstanceInitialState&quot;: { # Initial State for shielded instance, these are public keys which are safe to store in public # [Output Only] shielded vm initial state stored on disk
2852 &quot;dbs&quot;: [ # The Key Database (db).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2853 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2854 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
2855 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2856 },
2857 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2858 &quot;dbxs&quot;: [ # The forbidden key database (dbx).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2859 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2860 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
2861 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2862 },
2863 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2864 &quot;keks&quot;: [ # The Key Exchange Key (KEK).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2865 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2866 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
2867 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2868 },
2869 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2870 &quot;pk&quot;: { # The Platform Key (PK).
2871 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
2872 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2873 },
2874 },
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2875 &quot;source&quot;: &quot;A String&quot;, # Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD.
2876 #
2877 # If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.
2878 #
2879 # Note that for InstanceTemplate, specify the disk name, not the URL for the disk.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2880 &quot;type&quot;: &quot;A String&quot;, # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]2881 },
2882 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2883 &quot;displayDevice&quot;: { # A set of Display Device options # Enables display device for the instance.
2884 &quot;enableDisplay&quot;: True or False, # Defines whether the instance has Display enabled.
2885 },
2886 &quot;eraseWindowsVssSignature&quot;: True or False, # Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2887 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this resource, which is essentially a hash of the instance&#x27;s contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update the instance. You must always provide an up-to-date fingerprint hash in order to update the instance.
2888 #
2889 # To see the latest fingerprint, make get() request to the instance.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2890 &quot;guestAccelerators&quot;: [ # A list of the type and count of accelerator cards attached to the instance.
2891 { # A specification of the type and number of accelerator cards attached to the instance.
2892 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
2893 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.
2894 },
2895 ],
2896 &quot;hostname&quot;: &quot;A String&quot;, # Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.
2897 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
2898 &quot;kind&quot;: &quot;compute#instance&quot;, # [Output Only] Type of the resource. Always compute#instance for instances.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2899 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for this request, which is essentially a hash of the label&#x27;s contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
2900 #
2901 # To see the latest fingerprint, make get() request to the instance.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2902 &quot;labels&quot;: { # Labels to apply to this instance. These can be later modified by the setLabels method.
2903 &quot;a_key&quot;: &quot;A String&quot;,
2904 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]2905 &quot;lastStartTimestamp&quot;: &quot;A String&quot;, # [Output Only] Last start timestamp in RFC3339 text format.
2906 &quot;lastStopTimestamp&quot;: &quot;A String&quot;, # [Output Only] Last stop timestamp in RFC3339 text format.
2907 &quot;lastSuspendedTimestamp&quot;: &quot;A String&quot;, # [Output Only] Last suspended timestamp in RFC3339 text format.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2908 &quot;machineType&quot;: &quot;A String&quot;, # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:
2909 # zones/us-central1-f/machineTypes/n1-standard-1
2910 #
2911 #
2912 # To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):
2913 # zones/zone/machineTypes/custom-CPUS-MEMORY
2914 #
2915 #
2916 # For example: zones/us-central1-f/machineTypes/custom-4-5120
2917 #
2918 # For a full list of restrictions, read the Specifications for custom machine types.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2919 &quot;metadata&quot;: { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2920 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of the metadata&#x27;s contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet.
2921 #
2922 # To see the latest fingerprint, make a get() request to retrieve the resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2923 &quot;items&quot;: [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2924 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2925 &quot;key&quot;: &quot;A String&quot;, # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
2926 &quot;value&quot;: &quot;A String&quot;, # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB).
2927 },
2928 ],
2929 &quot;kind&quot;: &quot;compute#metadata&quot;, # [Output Only] Type of the resource. Always compute#metadata for metadata.
2930 },
2931 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: &quot;Intel Haswell&quot; or minCpuPlatform: &quot;Intel Sandy Bridge&quot;.
2932 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
2933 &quot;networkInterfaces&quot;: [ # An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance.
2934 { # A network interface resource attached to an instance.
2935 &quot;accessConfigs&quot;: [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.
2936 { # An access configuration attached to an instance&#x27;s network interface. Only one access config per instance is supported.
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700[diff] [blame]2937 &quot;externalIpv6&quot;: &quot;A String&quot;, # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.
2938 &quot;externalIpv6PrefixLength&quot;: 42, # [Output Only] The prefix length of the external IPv6 range.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2939 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
2940 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access.
2941 &quot;natIP&quot;: &quot;A String&quot;, # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2942 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.
2943 #
2944 # If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.
2945 #
2946 # If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2947 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.
2948 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the external IP address of the instance to a DNS domain name.
2949 &quot;type&quot;: &quot;ONE_TO_ONE_NAT&quot;, # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
2950 },
2951 ],
2952 &quot;aliasIpRanges&quot;: [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.
2953 { # An alias IP range attached to an instance&#x27;s network interface.
2954 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (such as 10.2.3.4), a netmask (such as /24) or a CIDR-formatted string (such as 10.1.2.0/24).
2955 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used.
2956 },
2957 ],
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]2958 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700[diff] [blame]2959 &quot;ipv6AccessConfigs&quot;: [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access.
2960 { # An access configuration attached to an instance&#x27;s network interface. Only one access config per instance is supported.
2961 &quot;externalIpv6&quot;: &quot;A String&quot;, # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.
2962 &quot;externalIpv6PrefixLength&quot;: 42, # [Output Only] The prefix length of the external IPv6 range.
2963 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
2964 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access.
2965 &quot;natIP&quot;: &quot;A String&quot;, # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2966 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.
2967 #
2968 # If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.
2969 #
2970 # If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700[diff] [blame]2971 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.
2972 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the external IP address of the instance to a DNS domain name.
2973 &quot;type&quot;: &quot;ONE_TO_ONE_NAT&quot;, # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
2974 },
2975 ],
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2976 &quot;ipv6AccessType&quot;: &quot;A String&quot;, # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork.
2977 #
2978 # Valid only if stackType is IPV4_IPV6.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2979 &quot;ipv6Address&quot;: &quot;A String&quot;, # [Output Only] An IPv6 internal network address for this network interface.
2980 &quot;kind&quot;: &quot;compute#networkInterface&quot;, # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.
2981 &quot;name&quot;: &quot;A String&quot;, # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2982 &quot;network&quot;: &quot;A String&quot;, # URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred.
2983 #
2984 # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
2985 # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
2986 # - projects/project/global/networks/network
2987 # - global/networks/default
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2988 &quot;networkIP&quot;: &quot;A String&quot;, # An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]2989 &quot;nicType&quot;: &quot;A String&quot;, # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]2990 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for this network interface to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used.
2991 #
2992 # This field can be both set at instance creation and update network interface operations.
2993 &quot;subnetwork&quot;: &quot;A String&quot;, # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
2994 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
2995 # - regions/region/subnetworks/subnetwork
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2996 },
2997 ],
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]2998 &quot;networkPerformanceConfig&quot;: {
2999 &quot;totalEgressBandwidthTier&quot;: &quot;A String&quot;,
3000 },
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]3001 &quot;postKeyRevocationActionType&quot;: &quot;A String&quot;, # PostKeyRevocationActionType of the instance.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3002 &quot;privateIpv6GoogleAccess&quot;: &quot;A String&quot;, # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3003 &quot;reservationAffinity&quot;: { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3004 &quot;consumeReservationType&quot;: &quot;A String&quot;, # Specifies the type of reservation from which this instance can consume resources: ANY_RESERVATION (default), SPECIFIC_RESERVATION, or NO_RESERVATION. See Consuming reserved instances for examples.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3005 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify googleapis.com/reservation-name as the key and specify the name of your reservation as its value.
yoshi-code-bot73a0aa32021-05-25 00:30:03 -0700[diff] [blame]3006 &quot;values&quot;: [ # Corresponds to the label values of a reservation resource. This can be either a name to a reservation in the same project or &quot;projects/different-project/reservations/some-reservation-name&quot; to target a shared reservation in the same zone but in a different project.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3007 &quot;A String&quot;,
3008 ],
3009 },
3010 &quot;resourcePolicies&quot;: [ # Resource policies applied to this instance.
3011 &quot;A String&quot;,
3012 ],
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]3013 &quot;satisfiesPzs&quot;: True or False, # [Output Only] Reserved for future use.
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700[diff] [blame]3014 &quot;scheduling&quot;: { # Sets the scheduling options for an Instance. NextID: 21 # Sets the scheduling options for this instance.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3015 &quot;automaticRestart&quot;: True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
3016 #
3017 # By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.
yoshi-code-bot73a0aa32021-05-25 00:30:03 -0700[diff] [blame]3018 &quot;hostErrorTimeoutSeconds&quot;: 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]3019 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API.
yoshi-code-bot9e2cde22021-04-29 03:48:05 -0700[diff] [blame]3020 &quot;maintenanceFreezeDurationHours&quot;: 42, # Specifies the number of hours after VM instance creation where the VM won&#x27;t be scheduled for maintenance.
3021 &quot;maintenanceInterval&quot;: &quot;A String&quot;, # For more information about maintenance intervals, see Setting maintenance intervals.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3022 &quot;minNodeCpus&quot;: 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.
3023 &quot;nodeAffinities&quot;: [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.
3024 { # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.
3025 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of Node resource.
3026 &quot;operator&quot;: &quot;A String&quot;, # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.
3027 &quot;values&quot;: [ # Corresponds to the label values of Node resource.
3028 &quot;A String&quot;,
3029 ],
3030 },
3031 ],
3032 &quot;onHostMaintenance&quot;: &quot;A String&quot;, # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]3033 &quot;preemptible&quot;: True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3034 },
3035 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3036 &quot;serviceAccounts&quot;: [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.
3037 #
3038 # Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3039 { # A service account.
3040 &quot;email&quot;: &quot;A String&quot;, # Email address of the service account.
3041 &quot;scopes&quot;: [ # The list of scopes to be made available for this service account.
3042 &quot;A String&quot;,
3043 ],
3044 },
3045 ],
3046 &quot;shieldedInstanceConfig&quot;: { # A set of Shielded Instance options.
3047 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.
3048 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.
3049 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.
3050 },
3051 &quot;shieldedInstanceIntegrityPolicy&quot;: { # The policy describes the baseline against which Instance boot integrity is measured.
3052 &quot;updateAutoLearnPolicy&quot;: True or False, # Updates the integrity policy baseline using the measurements from the VM instance&#x27;s most recent boot.
3053 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]3054 &quot;shieldedVmConfig&quot;: { # A set of Shielded VM options. # Deprecating, please use shielded_instance_config.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3055 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.
3056 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.
3057 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.
3058 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]3059 &quot;shieldedVmIntegrityPolicy&quot;: { # The policy describes the baseline against which VM instance boot integrity is measured. # Deprecating, please use shielded_instance_integrity_policy.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3060 &quot;updateAutoLearnPolicy&quot;: True or False, # Updates the integrity policy baseline using the measurements from the VM instance&#x27;s most recent boot.
3061 },
3062 &quot;sourceMachineImage&quot;: &quot;A String&quot;, # Source machine image
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]3063 &quot;sourceMachineImageEncryptionKey&quot;: { # Source machine image encryption key when creating an instance from a machine image.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3064 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
3065 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
3066 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3067 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
3068 #
3069 # The key must meet the following requirements before you can provide it to Compute Engine:
3070 # - The key is wrapped using a RSA public key certificate provided by Google.
3071 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:
3072 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3073 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
3074 },
3075 &quot;startRestricted&quot;: True or False, # [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3076 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3077 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable explanation of the status.
3078 &quot;tags&quot;: { # A set of instance tags. # Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. Multiple tags can be specified via the &#x27;tags.items&#x27; field.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3079 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of the tags&#x27; contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update tags. You must always provide an up-to-date fingerprint hash in order to update or change tags.
3080 #
3081 # To see the latest fingerprint, make get() request to the instance.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3082 &quot;items&quot;: [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
3083 &quot;A String&quot;,
3084 ],
3085 },
3086 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]3087}
3088
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3089 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
3090
3091For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
3092
3093The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
3094 sourceInstanceTemplate: string, Specifies instance template to create the instance.
3095
3096This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to an instance template:
3097- https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate
3098- projects/project/global/instanceTemplates/instanceTemplate
3099- global/instanceTemplates/instanceTemplate
3100 sourceMachineImage: string, Specifies the machine image to use to create the instance.
3101
3102This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to a machine image:
3103- https://www.googleapis.com/compute/v1/projects/project/global/global/machineImages/machineImage
3104- projects/project/global/global/machineImages/machineImage
3105- global/machineImages/machineImage
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]3106
3107Returns:
3108 An object of the form:
3109
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3110 { # Represents an Operation resource.
3111 #
3112 # Google Compute Engine has three Operation resources:
3113 #
3114 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
3115 #
3116 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
3117 #
3118 # Operations can be global, regional or zonal.
3119 # - For global operations, use the `globalOperations` resource.
3120 # - For regional operations, use the `regionOperations` resource.
3121 # - For zonal operations, use the `zonalOperations` resource.
3122 #
3123 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3124 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
3125 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
3126 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
3127 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
3128 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
3129 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3130 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3131 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
3132 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
3133 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3134 },
3135 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3136 },
3137 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
3138 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
3139 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
3140 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
3141 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
3142 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]3143 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3144 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
3145 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
3146 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
3147 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
3148 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
3149 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
3150 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
3151 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
3152 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
3153 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
3154 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
3155 {
3156 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3157 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
3158 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3159 {
3160 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
3161 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
3162 },
3163 ],
3164 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
3165 },
3166 ],
3167 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
3168}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]3169</div>
3170
3171<div class="method">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3172 <code class="details" id="list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]3173 <pre>Retrieves the list of instances contained within the specified zone.
3174
3175Args:
3176 project: string, Project ID for this request. (required)
3177 zone: string, The name of the zone for this request. (required)
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3178 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `&gt;`, or `&lt;`.
3179
3180For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
3181
3182You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
3183
3184To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = &quot;Intel Skylake&quot;) ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = &quot;Intel Skylake&quot;) OR (cpuPlatform = &quot;Intel Broadwell&quot;) AND (scheduling.automaticRestart = true) ```
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3185 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3186 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
3187
3188You can also sort results in descending order based on the creation timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
3189
3190Currently, only sorting by `name` or `creationTimestamp desc` is supported.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3191 pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]3192 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]3193
3194Returns:
3195 An object of the form:
3196
3197 { # Contains a list of instances.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3198 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
3199 &quot;items&quot;: [ # A list of Instance resources.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3200 { # Represents an Instance resource.
3201 #
3202 # An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. (== resource_for {$api_version}.instances ==)
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]3203 &quot;advancedMachineFeatures&quot;: { # Specifies options for controlling advanced machine features. Options that would traditionally be configured in a BIOS belong here. Features that require operating system support may have corresponding entries in the GuestOsFeatures of an Image (e.g., whether or not the OS in the Image supports nested virtualization being enabled or disabled). # Controls for advanced machine-related behavior features.
3204 &quot;enableNestedVirtualization&quot;: True or False, # Whether to enable nested virtualization or not (default is false).
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame]3205 &quot;threadsPerCore&quot;: 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]3206 },
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3207 &quot;canIpForward&quot;: True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3208 &quot;confidentialInstanceConfig&quot;: { # A set of Confidential Instance options.
3209 &quot;enableConfidentialCompute&quot;: True or False, # Defines whether the instance should have confidential compute enabled.
3210 },
3211 &quot;cpuPlatform&quot;: &quot;A String&quot;, # [Output Only] The CPU platform used by this instance.
3212 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
3213 &quot;deletionProtection&quot;: True or False, # Whether the resource should be protected against deletion.
3214 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
3215 &quot;disks&quot;: [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
3216 { # An instance-attached disk resource.
3217 &quot;autoDelete&quot;: True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
3218 &quot;boot&quot;: True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3219 &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 running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
3220 #
3221 # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
3222 &quot;diskEncryptionKey&quot;: { # Encrypts or decrypts a disk using a customer-supplied encryption key.
3223 #
3224 # If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
3225 #
3226 # If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
3227 #
3228 # If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
3229 #
3230 # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3231 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
3232 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
3233 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3234 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
3235 #
3236 # The key must meet the following requirements before you can provide it to Compute Engine:
3237 # - The key is wrapped using a RSA public key certificate provided by Google.
3238 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:
3239 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3240 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
3241 },
3242 &quot;diskSizeGb&quot;: &quot;A String&quot;, # The size of the disk in GB.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3243 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3244 { # Guest OS features.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3245 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3246 },
3247 ],
3248 &quot;index&quot;: 42, # [Output Only] A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3249 &quot;initializeParams&quot;: { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
3250 #
3251 # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
3252 #
3253 # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3254 &quot;description&quot;: &quot;A String&quot;, # An optional description. Provide this property when creating the disk.
3255 &quot;diskName&quot;: &quot;A String&quot;, # Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created.
3256 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3257 &quot;diskType&quot;: &quot;A String&quot;, # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
3258 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
3259 #
3260 #
3261 # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
3262 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
3263 # - projects/project/zones/zone/diskTypes/diskType
3264 # - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.
3265 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.
3266 #
3267 # Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3268 { # Guest OS features.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3269 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3270 },
3271 ],
3272 &quot;labels&quot;: { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.
3273 &quot;a_key&quot;: &quot;A String&quot;,
3274 },
3275 &quot;multiWriter&quot;: True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.
3276 &quot;onUpdateAction&quot;: &quot;A String&quot;, # Specifies which action to take on instance update with this disk. Default is to use the existing disk.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]3277 &quot;provisionedIops&quot;: &quot;A String&quot;, # Indicates how many IOPS must be provisioned for the disk.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3278 &quot;resourcePolicies&quot;: [ # Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name.
3279 &quot;A String&quot;,
3280 ],
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3281 &quot;sourceImage&quot;: &quot;A String&quot;, # The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD.
3282 #
3283 # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image:
3284 # projects/debian-cloud/global/images/family/debian-9
3285 #
3286 #
3287 # Alternatively, use a specific version of a public operating system image:
3288 # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
3289 #
3290 #
3291 # To create a disk with a custom image that you created, specify the image name in the following format:
3292 # global/images/my-custom-image
3293 #
3294 #
3295 # You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
3296 # global/images/family/my-image-family
3297 #
3298 #
3299 # If the source image is deleted later, this field will not be set.
3300 &quot;sourceImageEncryptionKey&quot;: { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
3301 #
3302 # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3303 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
3304 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
3305 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3306 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
3307 #
3308 # The key must meet the following requirements before you can provide it to Compute Engine:
3309 # - The key is wrapped using a RSA public key certificate provided by Google.
3310 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:
3311 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3312 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]3313 },
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3314 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD.
3315 #
3316 # To create a disk with a snapshot that you created, specify the snapshot name in the following format:
3317 # global/snapshots/my-backup
3318 #
3319 #
3320 # If the source snapshot is deleted later, this field will not be set.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3321 &quot;sourceSnapshotEncryptionKey&quot;: { # The customer-supplied encryption key of the source snapshot.
3322 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
3323 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
3324 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3325 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
3326 #
3327 # The key must meet the following requirements before you can provide it to Compute Engine:
3328 # - The key is wrapped using a RSA public key certificate provided by Google.
3329 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:
3330 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3331 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]3332 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3333 },
3334 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
3335 &quot;kind&quot;: &quot;compute#attachedDisk&quot;, # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
3336 &quot;licenses&quot;: [ # [Output Only] Any valid publicly visible licenses.
3337 &quot;A String&quot;,
3338 ],
3339 &quot;mode&quot;: &quot;A String&quot;, # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
3340 &quot;shieldedInstanceInitialState&quot;: { # Initial State for shielded instance, these are public keys which are safe to store in public # [Output Only] shielded vm initial state stored on disk
3341 &quot;dbs&quot;: [ # The Key Database (db).
3342 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3343 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
3344 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3345 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3346 ],
3347 &quot;dbxs&quot;: [ # The forbidden key database (dbx).
3348 {
3349 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
3350 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
3351 },
3352 ],
3353 &quot;keks&quot;: [ # The Key Exchange Key (KEK).
3354 {
3355 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
3356 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
3357 },
3358 ],
3359 &quot;pk&quot;: { # The Platform Key (PK).
3360 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
3361 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3362 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]3363 },
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3364 &quot;source&quot;: &quot;A String&quot;, # Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD.
3365 #
3366 # If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.
3367 #
3368 # Note that for InstanceTemplate, specify the disk name, not the URL for the disk.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3369 &quot;type&quot;: &quot;A String&quot;, # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3370 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3371 ],
3372 &quot;displayDevice&quot;: { # A set of Display Device options # Enables display device for the instance.
3373 &quot;enableDisplay&quot;: True or False, # Defines whether the instance has Display enabled.
3374 },
3375 &quot;eraseWindowsVssSignature&quot;: True or False, # Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3376 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this resource, which is essentially a hash of the instance&#x27;s contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update the instance. You must always provide an up-to-date fingerprint hash in order to update the instance.
3377 #
3378 # To see the latest fingerprint, make get() request to the instance.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3379 &quot;guestAccelerators&quot;: [ # A list of the type and count of accelerator cards attached to the instance.
3380 { # A specification of the type and number of accelerator cards attached to the instance.
3381 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
3382 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.
3383 },
3384 ],
3385 &quot;hostname&quot;: &quot;A String&quot;, # Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.
3386 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
3387 &quot;kind&quot;: &quot;compute#instance&quot;, # [Output Only] Type of the resource. Always compute#instance for instances.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3388 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for this request, which is essentially a hash of the label&#x27;s contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
3389 #
3390 # To see the latest fingerprint, make get() request to the instance.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3391 &quot;labels&quot;: { # Labels to apply to this instance. These can be later modified by the setLabels method.
3392 &quot;a_key&quot;: &quot;A String&quot;,
3393 },
3394 &quot;lastStartTimestamp&quot;: &quot;A String&quot;, # [Output Only] Last start timestamp in RFC3339 text format.
3395 &quot;lastStopTimestamp&quot;: &quot;A String&quot;, # [Output Only] Last stop timestamp in RFC3339 text format.
3396 &quot;lastSuspendedTimestamp&quot;: &quot;A String&quot;, # [Output Only] Last suspended timestamp in RFC3339 text format.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3397 &quot;machineType&quot;: &quot;A String&quot;, # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:
3398 # zones/us-central1-f/machineTypes/n1-standard-1
3399 #
3400 #
3401 # To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):
3402 # zones/zone/machineTypes/custom-CPUS-MEMORY
3403 #
3404 #
3405 # For example: zones/us-central1-f/machineTypes/custom-4-5120
3406 #
3407 # For a full list of restrictions, read the Specifications for custom machine types.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3408 &quot;metadata&quot;: { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3409 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of the metadata&#x27;s contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet.
3410 #
3411 # To see the latest fingerprint, make a get() request to retrieve the resource.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3412 &quot;items&quot;: [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3413 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3414 &quot;key&quot;: &quot;A String&quot;, # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
3415 &quot;value&quot;: &quot;A String&quot;, # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3416 },
3417 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3418 &quot;kind&quot;: &quot;compute#metadata&quot;, # [Output Only] Type of the resource. Always compute#metadata for metadata.
3419 },
3420 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: &quot;Intel Haswell&quot; or minCpuPlatform: &quot;Intel Sandy Bridge&quot;.
3421 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
3422 &quot;networkInterfaces&quot;: [ # An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance.
3423 { # A network interface resource attached to an instance.
3424 &quot;accessConfigs&quot;: [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.
3425 { # An access configuration attached to an instance&#x27;s network interface. Only one access config per instance is supported.
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700[diff] [blame]3426 &quot;externalIpv6&quot;: &quot;A String&quot;, # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.
3427 &quot;externalIpv6PrefixLength&quot;: 42, # [Output Only] The prefix length of the external IPv6 range.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3428 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
3429 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access.
3430 &quot;natIP&quot;: &quot;A String&quot;, # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3431 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.
3432 #
3433 # If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.
3434 #
3435 # If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3436 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.
3437 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the external IP address of the instance to a DNS domain name.
3438 &quot;type&quot;: &quot;ONE_TO_ONE_NAT&quot;, # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
3439 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3440 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3441 &quot;aliasIpRanges&quot;: [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.
3442 { # An alias IP range attached to an instance&#x27;s network interface.
3443 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (such as 10.2.3.4), a netmask (such as /24) or a CIDR-formatted string (such as 10.1.2.0/24).
3444 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used.
3445 },
3446 ],
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]3447 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700[diff] [blame]3448 &quot;ipv6AccessConfigs&quot;: [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access.
3449 { # An access configuration attached to an instance&#x27;s network interface. Only one access config per instance is supported.
3450 &quot;externalIpv6&quot;: &quot;A String&quot;, # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.
3451 &quot;externalIpv6PrefixLength&quot;: 42, # [Output Only] The prefix length of the external IPv6 range.
3452 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
3453 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access.
3454 &quot;natIP&quot;: &quot;A String&quot;, # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3455 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.
3456 #
3457 # If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.
3458 #
3459 # If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700[diff] [blame]3460 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.
3461 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the external IP address of the instance to a DNS domain name.
3462 &quot;type&quot;: &quot;ONE_TO_ONE_NAT&quot;, # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
3463 },
3464 ],
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3465 &quot;ipv6AccessType&quot;: &quot;A String&quot;, # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork.
3466 #
3467 # Valid only if stackType is IPV4_IPV6.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3468 &quot;ipv6Address&quot;: &quot;A String&quot;, # [Output Only] An IPv6 internal network address for this network interface.
3469 &quot;kind&quot;: &quot;compute#networkInterface&quot;, # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.
3470 &quot;name&quot;: &quot;A String&quot;, # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3471 &quot;network&quot;: &quot;A String&quot;, # URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred.
3472 #
3473 # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
3474 # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
3475 # - projects/project/global/networks/network
3476 # - global/networks/default
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3477 &quot;networkIP&quot;: &quot;A String&quot;, # An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]3478 &quot;nicType&quot;: &quot;A String&quot;, # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3479 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for this network interface to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used.
3480 #
3481 # This field can be both set at instance creation and update network interface operations.
3482 &quot;subnetwork&quot;: &quot;A String&quot;, # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
3483 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
3484 # - regions/region/subnetworks/subnetwork
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3485 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3486 ],
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]3487 &quot;networkPerformanceConfig&quot;: {
3488 &quot;totalEgressBandwidthTier&quot;: &quot;A String&quot;,
3489 },
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]3490 &quot;postKeyRevocationActionType&quot;: &quot;A String&quot;, # PostKeyRevocationActionType of the instance.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3491 &quot;privateIpv6GoogleAccess&quot;: &quot;A String&quot;, # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3492 &quot;reservationAffinity&quot;: { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3493 &quot;consumeReservationType&quot;: &quot;A String&quot;, # Specifies the type of reservation from which this instance can consume resources: ANY_RESERVATION (default), SPECIFIC_RESERVATION, or NO_RESERVATION. See Consuming reserved instances for examples.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3494 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify googleapis.com/reservation-name as the key and specify the name of your reservation as its value.
yoshi-code-bot73a0aa32021-05-25 00:30:03 -0700[diff] [blame]3495 &quot;values&quot;: [ # Corresponds to the label values of a reservation resource. This can be either a name to a reservation in the same project or &quot;projects/different-project/reservations/some-reservation-name&quot; to target a shared reservation in the same zone but in a different project.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3496 &quot;A String&quot;,
3497 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3498 },
3499 &quot;resourcePolicies&quot;: [ # Resource policies applied to this instance.
3500 &quot;A String&quot;,
3501 ],
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]3502 &quot;satisfiesPzs&quot;: True or False, # [Output Only] Reserved for future use.
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700[diff] [blame]3503 &quot;scheduling&quot;: { # Sets the scheduling options for an Instance. NextID: 21 # Sets the scheduling options for this instance.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3504 &quot;automaticRestart&quot;: True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
3505 #
3506 # By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.
yoshi-code-bot73a0aa32021-05-25 00:30:03 -0700[diff] [blame]3507 &quot;hostErrorTimeoutSeconds&quot;: 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]3508 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API.
yoshi-code-bot9e2cde22021-04-29 03:48:05 -0700[diff] [blame]3509 &quot;maintenanceFreezeDurationHours&quot;: 42, # Specifies the number of hours after VM instance creation where the VM won&#x27;t be scheduled for maintenance.
3510 &quot;maintenanceInterval&quot;: &quot;A String&quot;, # For more information about maintenance intervals, see Setting maintenance intervals.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3511 &quot;minNodeCpus&quot;: 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.
3512 &quot;nodeAffinities&quot;: [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.
3513 { # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.
3514 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of Node resource.
3515 &quot;operator&quot;: &quot;A String&quot;, # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.
3516 &quot;values&quot;: [ # Corresponds to the label values of Node resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3517 &quot;A String&quot;,
3518 ],
3519 },
3520 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3521 &quot;onHostMaintenance&quot;: &quot;A String&quot;, # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
3522 &quot;preemptible&quot;: True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.
3523 },
3524 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3525 &quot;serviceAccounts&quot;: [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.
3526 #
3527 # Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3528 { # A service account.
3529 &quot;email&quot;: &quot;A String&quot;, # Email address of the service account.
3530 &quot;scopes&quot;: [ # The list of scopes to be made available for this service account.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3531 &quot;A String&quot;,
3532 ],
3533 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3534 ],
3535 &quot;shieldedInstanceConfig&quot;: { # A set of Shielded Instance options.
3536 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.
3537 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.
3538 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.
3539 },
3540 &quot;shieldedInstanceIntegrityPolicy&quot;: { # The policy describes the baseline against which Instance boot integrity is measured.
3541 &quot;updateAutoLearnPolicy&quot;: True or False, # Updates the integrity policy baseline using the measurements from the VM instance&#x27;s most recent boot.
3542 },
3543 &quot;shieldedVmConfig&quot;: { # A set of Shielded VM options. # Deprecating, please use shielded_instance_config.
3544 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.
3545 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.
3546 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.
3547 },
3548 &quot;shieldedVmIntegrityPolicy&quot;: { # The policy describes the baseline against which VM instance boot integrity is measured. # Deprecating, please use shielded_instance_integrity_policy.
3549 &quot;updateAutoLearnPolicy&quot;: True or False, # Updates the integrity policy baseline using the measurements from the VM instance&#x27;s most recent boot.
3550 },
3551 &quot;sourceMachineImage&quot;: &quot;A String&quot;, # Source machine image
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]3552 &quot;sourceMachineImageEncryptionKey&quot;: { # Source machine image encryption key when creating an instance from a machine image.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3553 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
3554 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
3555 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3556 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
3557 #
3558 # The key must meet the following requirements before you can provide it to Compute Engine:
3559 # - The key is wrapped using a RSA public key certificate provided by Google.
3560 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:
3561 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3562 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
3563 },
3564 &quot;startRestricted&quot;: True or False, # [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3565 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3566 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable explanation of the status.
3567 &quot;tags&quot;: { # A set of instance tags. # Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. Multiple tags can be specified via the &#x27;tags.items&#x27; field.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3568 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of the tags&#x27; contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update tags. You must always provide an up-to-date fingerprint hash in order to update or change tags.
3569 #
3570 # To see the latest fingerprint, make get() request to the instance.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3571 &quot;items&quot;: [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
3572 &quot;A String&quot;,
3573 ],
3574 },
3575 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
3576 },
3577 ],
3578 &quot;kind&quot;: &quot;compute#instanceList&quot;, # [Output Only] Type of resource. Always compute#instanceList for lists of Instance resources.
3579 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
3580 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
3581 &quot;warning&quot;: { # [Output Only] Informational warning message.
3582 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3583 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
3584 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3585 {
3586 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
3587 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]3588 },
3589 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3590 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
3591 },
3592}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]3593</div>
3594
3595<div class="method">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3596 <code class="details" id="listReferrers">listReferrers(project, zone, instance, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]3597 <pre>Retrieves a list of resources that refer to the VM instance specified in the request. For example, if the VM instance is part of a managed or unmanaged instance group, the referrers list includes the instance group. For more information, read Viewing referrers to VM instances.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]3598
3599Args:
3600 project: string, Project ID for this request. (required)
3601 zone: string, The name of the zone for this request. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3602 instance: string, Name of the target instance scoping this request, or &#x27;-&#x27; if the request should span over all instances in the container. (required)
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3603 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `&gt;`, or `&lt;`.
3604
3605For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
3606
3607You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
3608
3609To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = &quot;Intel Skylake&quot;) ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = &quot;Intel Skylake&quot;) OR (cpuPlatform = &quot;Intel Broadwell&quot;) AND (scheduling.automaticRestart = true) ```
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3610 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3611 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
3612
3613You can also sort results in descending order based on the creation timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
3614
3615Currently, only sorting by `name` or `creationTimestamp desc` is supported.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3616 pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]3617 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]3618
3619Returns:
3620 An object of the form:
3621
3622 { # Contains a list of instance referrers.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3623 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
3624 &quot;items&quot;: [ # A list of Reference resources.
3625 { # Represents a reference to a resource.
3626 &quot;kind&quot;: &quot;compute#reference&quot;, # [Output Only] Type of the resource. Always compute#reference for references.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3627 &quot;referenceType&quot;: &quot;A String&quot;, # A description of the reference type with no implied semantics. Possible values include:
3628 # - MEMBER_OF
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3629 &quot;referrer&quot;: &quot;A String&quot;, # URL of the resource which refers to the target.
3630 &quot;target&quot;: &quot;A String&quot;, # URL of the resource to which this reference points.
3631 },
3632 ],
3633 &quot;kind&quot;: &quot;compute#instanceListReferrers&quot;, # [Output Only] Type of resource. Always compute#instanceListReferrers for lists of Instance referrers.
3634 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
3635 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
3636 &quot;warning&quot;: { # [Output Only] Informational warning message.
3637 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3638 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
3639 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3640 {
3641 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
3642 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]3643 },
3644 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3645 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
3646 },
3647}</pre>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]3648</div>
3649
3650<div class="method">
3651 <code class="details" id="listReferrers_next">listReferrers_next(previous_request, previous_response)</code>
3652 <pre>Retrieves the next page of results.
3653
3654Args:
3655 previous_request: The request for the previous page. (required)
3656 previous_response: The response from the request for the previous page. (required)
3657
3658Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3659 A request object that you can call &#x27;execute()&#x27; on to request the next
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]3660 page. Returns None if there are no more items in the collection.
3661 </pre>
3662</div>
3663
3664<div class="method">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]3665 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
3666 <pre>Retrieves the next page of results.
3667
3668Args:
3669 previous_request: The request for the previous page. (required)
3670 previous_response: The response from the request for the previous page. (required)
3671
3672Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3673 A request object that you can call &#x27;execute()&#x27; on to request the next
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]3674 page. Returns None if there are no more items in the collection.
3675 </pre>
3676</div>
3677
3678<div class="method">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3679 <code class="details" id="removeResourcePolicies">removeResourcePolicies(project, zone, instance, body=None, requestId=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3680 <pre>Removes resource policies from an instance.
3681
3682Args:
3683 project: string, Project ID for this request. (required)
3684 zone: string, The name of the zone for this request. (required)
3685 instance: string, The instance name for this request. (required)
3686 body: object, The request body.
3687 The object takes the form of:
3688
3689{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3690 &quot;resourcePolicies&quot;: [ # Resource policies to be removed from this instance.
3691 &quot;A String&quot;,
3692 ],
3693}
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3694
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3695 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
3696
3697For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
3698
3699The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3700
3701Returns:
3702 An object of the form:
3703
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3704 { # Represents an Operation resource.
3705 #
3706 # Google Compute Engine has three Operation resources:
3707 #
3708 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
3709 #
3710 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
3711 #
3712 # Operations can be global, regional or zonal.
3713 # - For global operations, use the `globalOperations` resource.
3714 # - For regional operations, use the `regionOperations` resource.
3715 # - For zonal operations, use the `zonalOperations` resource.
3716 #
3717 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3718 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
3719 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
3720 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
3721 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
3722 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
3723 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3724 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3725 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
3726 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
3727 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3728 },
3729 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3730 },
3731 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
3732 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
3733 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
3734 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
3735 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
3736 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]3737 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3738 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
3739 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
3740 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
3741 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
3742 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
3743 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
3744 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
3745 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
3746 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
3747 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
3748 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
3749 {
3750 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3751 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
3752 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3753 {
3754 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
3755 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
3756 },
3757 ],
3758 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
3759 },
3760 ],
3761 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
3762}</pre>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3763</div>
3764
3765<div class="method">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3766 <code class="details" id="reset">reset(project, zone, instance, requestId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3767 <pre>Performs a reset on the instance. This is a hard reset the VM does not do a graceful shutdown. For more information, see Resetting an instance.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]3768
3769Args:
3770 project: string, Project ID for this request. (required)
3771 zone: string, The name of the zone for this request. (required)
3772 instance: string, Name of the instance scoping this request. (required)
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3773 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
3774
3775For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
3776
3777The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]3778
3779Returns:
3780 An object of the form:
3781
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3782 { # Represents an Operation resource.
3783 #
3784 # Google Compute Engine has three Operation resources:
3785 #
3786 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
3787 #
3788 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
3789 #
3790 # Operations can be global, regional or zonal.
3791 # - For global operations, use the `globalOperations` resource.
3792 # - For regional operations, use the `regionOperations` resource.
3793 # - For zonal operations, use the `zonalOperations` resource.
3794 #
3795 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3796 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
3797 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
3798 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
3799 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
3800 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
3801 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3802 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3803 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
3804 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
3805 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3806 },
3807 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3808 },
3809 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
3810 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
3811 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
3812 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
3813 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
3814 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]3815 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3816 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
3817 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
3818 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
3819 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
3820 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
3821 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
3822 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
3823 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
3824 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
3825 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
3826 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
3827 {
3828 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3829 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
3830 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3831 {
3832 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
3833 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
3834 },
3835 ],
3836 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
3837 },
3838 ],
3839 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
3840}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]3841</div>
3842
3843<div class="method">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3844 <code class="details" id="resume">resume(project, zone, instance, body=None, requestId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3845 <pre>Resumes an instance that was suspended using the instances().suspend method.
3846
3847Args:
3848 project: string, Project ID for this request. (required)
3849 zone: string, The name of the zone for this request. (required)
3850 instance: string, Name of the instance resource to resume. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3851 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3852 The object takes the form of:
3853
3854{
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3855 &quot;disks&quot;: [ # Array of disks associated with this instance that are protected with a customer-supplied encryption key.
3856 #
3857 # In order to resume the instance, the disk url and its corresponding key must be provided.
3858 #
3859 # If the disk is not protected with a customer-supplied encryption key it should not be specified.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3860 {
3861 &quot;diskEncryptionKey&quot;: { # Decrypts data associated with the disk with a customer-supplied encryption key.
3862 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
3863 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
3864 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3865 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
3866 #
3867 # The key must meet the following requirements before you can provide it to Compute Engine:
3868 # - The key is wrapped using a RSA public key certificate provided by Google.
3869 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:
3870 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3871 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3872 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3873 &quot;source&quot;: &quot;A String&quot;, # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3874 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3875 ],
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3876 &quot;instanceEncryptionKey&quot;: { # Decrypts data associated with an instance that is protected with a customer-supplied encryption key.
3877 #
3878 # If the instance you are starting is protected with a customer-supplied encryption key, the correct key must be provided otherwise the instance resume will not succeed.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3879 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
3880 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
3881 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3882 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
3883 #
3884 # The key must meet the following requirements before you can provide it to Compute Engine:
3885 # - The key is wrapped using a RSA public key certificate provided by Google.
3886 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:
3887 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3888 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
3889 },
3890}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3891
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3892 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
3893
3894For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
3895
3896The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3897
3898Returns:
3899 An object of the form:
3900
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3901 { # Represents an Operation resource.
3902 #
3903 # Google Compute Engine has three Operation resources:
3904 #
3905 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
3906 #
3907 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
3908 #
3909 # Operations can be global, regional or zonal.
3910 # - For global operations, use the `globalOperations` resource.
3911 # - For regional operations, use the `regionOperations` resource.
3912 # - For zonal operations, use the `zonalOperations` resource.
3913 #
3914 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3915 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
3916 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
3917 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
3918 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
3919 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
3920 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3921 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3922 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
3923 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
3924 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3925 },
3926 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3927 },
3928 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
3929 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
3930 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
3931 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
3932 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
3933 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]3934 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3935 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
3936 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
3937 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
3938 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
3939 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
3940 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
3941 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
3942 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
3943 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
3944 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
3945 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
3946 {
3947 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3948 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
3949 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3950 {
3951 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
3952 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
3953 },
3954 ],
3955 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
3956 },
3957 ],
3958 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
3959}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3960</div>
3961
3962<div class="method">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3963 <code class="details" id="setDeletionProtection">setDeletionProtection(project, zone, resource, deletionProtection=None, requestId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3964 <pre>Sets deletion protection on the instance.
3965
3966Args:
3967 project: string, Project ID for this request. (required)
3968 zone: string, The name of the zone for this request. (required)
3969 resource: string, Name or id of the resource for this request. (required)
3970 deletionProtection: boolean, Whether the resource should be protected against deletion.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3971 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
3972
3973For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
3974
3975The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3976
3977Returns:
3978 An object of the form:
3979
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]3980 { # Represents an Operation resource.
3981 #
3982 # Google Compute Engine has three Operation resources:
3983 #
3984 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
3985 #
3986 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
3987 #
3988 # Operations can be global, regional or zonal.
3989 # - For global operations, use the `globalOperations` resource.
3990 # - For regional operations, use the `regionOperations` resource.
3991 # - For zonal operations, use the `zonalOperations` resource.
3992 #
3993 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3994 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
3995 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
3996 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
3997 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
3998 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
3999 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4000 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4001 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
4002 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
4003 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4004 },
4005 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4006 },
4007 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
4008 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
4009 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
4010 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
4011 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
4012 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]4013 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4014 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
4015 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
4016 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
4017 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
4018 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
4019 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
4020 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
4021 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
4022 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
4023 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
4024 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
4025 {
4026 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4027 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
4028 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4029 {
4030 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
4031 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
4032 },
4033 ],
4034 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
4035 },
4036 ],
4037 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
4038}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4039</div>
4040
4041<div class="method">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4042 <code class="details" id="setDiskAutoDelete">setDiskAutoDelete(project, zone, instance, autoDelete, deviceName, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]4043 <pre>Sets the auto-delete flag for a disk attached to an instance.
4044
4045Args:
4046 project: string, Project ID for this request. (required)
4047 zone: string, The name of the zone for this request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4048 instance: string, The instance name for this request. (required)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]4049 autoDelete: boolean, Whether to auto-delete the disk when the instance is deleted. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4050 deviceName: string, The device name of the disk to modify. Make a get() request on the instance to view currently attached disks and device names. (required)
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4051 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
4052
4053For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
4054
4055The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]4056
4057Returns:
4058 An object of the form:
4059
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4060 { # Represents an Operation resource.
4061 #
4062 # Google Compute Engine has three Operation resources:
4063 #
4064 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
4065 #
4066 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
4067 #
4068 # Operations can be global, regional or zonal.
4069 # - For global operations, use the `globalOperations` resource.
4070 # - For regional operations, use the `regionOperations` resource.
4071 # - For zonal operations, use the `zonalOperations` resource.
4072 #
4073 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4074 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
4075 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
4076 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
4077 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
4078 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
4079 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4080 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4081 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
4082 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
4083 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4084 },
4085 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4086 },
4087 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
4088 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
4089 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
4090 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
4091 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
4092 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]4093 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4094 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
4095 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
4096 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
4097 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
4098 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
4099 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
4100 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
4101 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
4102 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
4103 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
4104 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
4105 {
4106 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4107 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
4108 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4109 {
4110 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
4111 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
4112 },
4113 ],
4114 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
4115 },
4116 ],
4117 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
4118}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]4119</div>
4120
4121<div class="method">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4122 <code class="details" id="setIamPolicy">setIamPolicy(project, zone, resource, body=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4123 <pre>Sets the access control policy on the specified resource. Replaces any existing policy.
4124
4125Args:
4126 project: string, Project ID for this request. (required)
4127 zone: string, The name of the zone for this request. (required)
4128 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]4129 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4130 The object takes the form of:
4131
4132{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4133 &quot;bindings&quot;: [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use &#x27;policy&#x27; to specify bindings.
4134 { # Associates `members` with a `role`.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4135 &quot;bindingId&quot;: &quot;A String&quot;,
4136 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. # The condition that is associated with this binding.
4137 #
4138 # If the condition evaluates to `true`, then this binding applies to the current request.
4139 #
4140 # If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.
4141 #
4142 # To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
4143 #
4144 # Example (Comparison):
4145 #
4146 # title: &quot;Summary size limit&quot; description: &quot;Determines if a summary is less than 100 chars&quot; expression: &quot;document.summary.size() &lt; 100&quot;
4147 #
4148 # Example (Equality):
4149 #
4150 # title: &quot;Requestor is owner&quot; description: &quot;Determines if requestor is the document owner&quot; expression: &quot;document.owner == request.auth.claims.email&quot;
4151 #
4152 # Example (Logic):
4153 #
4154 # title: &quot;Public documents&quot; description: &quot;Determine whether the document should be publicly visible&quot; expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
4155 #
4156 # Example (Data Manipulation):
4157 #
4158 # title: &quot;Notification string&quot; description: &quot;Create a notification string with a timestamp.&quot; expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
4159 #
4160 # The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4161 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
4162 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
4163 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
4164 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
4165 },
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4166 &quot;members&quot;: [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
4167 #
4168 # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
4169 #
4170 # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
4171 #
4172 # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .
4173 #
4174 #
4175 #
4176 # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
4177 #
4178 # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
4179 #
4180 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding.
4181 #
4182 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding.
4183 #
4184 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.
4185 #
4186 #
4187 #
4188 # * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4189 &quot;A String&quot;,
4190 ],
4191 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4192 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4193 ],
4194 &quot;etag&quot;: &quot;A String&quot;, # Flatten Policy to create a backward compatible wire-format. Deprecated. Use &#x27;policy&#x27; to specify the etag.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4195 &quot;policy&quot;: { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. # REQUIRED: The complete policy to be applied to the &#x27;resource&#x27;. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them.
4196 #
4197 #
4198 #
4199 # A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role.
4200 #
4201 # For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
4202 #
4203 # **JSON example:**
4204 #
4205 # { &quot;bindings&quot;: [ { &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;, &quot;members&quot;: [ &quot;user:mike@example.com&quot;, &quot;group:admins@example.com&quot;, &quot;domain:google.com&quot;, &quot;serviceAccount:my-project-id@appspot.gserviceaccount.com&quot; ] }, { &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;, &quot;members&quot;: [ &quot;user:eve@example.com&quot; ], &quot;condition&quot;: { &quot;title&quot;: &quot;expirable access&quot;, &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;, &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;, } } ], &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;, &quot;version&quot;: 3 }
4206 #
4207 # **YAML example:**
4208 #
4209 # bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;) - etag: BwWWja0YfJA= - version: 3
4210 #
4211 # For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4212 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4213 { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.
4214 #
4215 # If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.
4216 #
4217 # Example Policy with multiple AuditConfigs:
4218 #
4219 # { &quot;audit_configs&quot;: [ { &quot;service&quot;: &quot;allServices&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:jose@example.com&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; }, { &quot;log_type&quot;: &quot;ADMIN_READ&quot; } ] }, { &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot; }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot;, &quot;exempted_members&quot;: [ &quot;user:aliya@example.com&quot; ] } ] } ] }
4220 #
4221 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4222 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4223 { # Provides the configuration for logging a type of permissions. Example:
4224 #
4225 # { &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:jose@example.com&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; } ] }
4226 #
4227 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting jose@example.com from DATA_READ logging.
4228 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4229 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4230 ],
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4231 &quot;ignoreChildExemptions&quot;: True or False,
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4232 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4233 },
4234 ],
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4235 &quot;exemptedMembers&quot;: [
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4236 &quot;A String&quot;,
4237 ],
4238 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4239 },
4240 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4241 &quot;bindings&quot;: [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4242 { # Associates `members` with a `role`.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4243 &quot;bindingId&quot;: &quot;A String&quot;,
4244 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. # The condition that is associated with this binding.
4245 #
4246 # If the condition evaluates to `true`, then this binding applies to the current request.
4247 #
4248 # If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.
4249 #
4250 # To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
4251 #
4252 # Example (Comparison):
4253 #
4254 # title: &quot;Summary size limit&quot; description: &quot;Determines if a summary is less than 100 chars&quot; expression: &quot;document.summary.size() &lt; 100&quot;
4255 #
4256 # Example (Equality):
4257 #
4258 # title: &quot;Requestor is owner&quot; description: &quot;Determines if requestor is the document owner&quot; expression: &quot;document.owner == request.auth.claims.email&quot;
4259 #
4260 # Example (Logic):
4261 #
4262 # title: &quot;Public documents&quot; description: &quot;Determine whether the document should be publicly visible&quot; expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
4263 #
4264 # Example (Data Manipulation):
4265 #
4266 # title: &quot;Notification string&quot; description: &quot;Create a notification string with a timestamp.&quot; expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
4267 #
4268 # The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4269 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
4270 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
4271 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
4272 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
4273 },
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4274 &quot;members&quot;: [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
4275 #
4276 # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
4277 #
4278 # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
4279 #
4280 # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .
4281 #
4282 #
4283 #
4284 # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
4285 #
4286 # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
4287 #
4288 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding.
4289 #
4290 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding.
4291 #
4292 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.
4293 #
4294 #
4295 #
4296 # * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4297 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4298 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4299 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4300 },
4301 ],
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4302 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
4303 #
4304 # **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
4305 &quot;iamOwned&quot;: True or False,
4306 &quot;rules&quot;: [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
4307 { # A rule to be applied in a Policy.
4308 &quot;action&quot;: &quot;A String&quot;, # Required
4309 &quot;conditions&quot;: [ # Additional restrictions that must be met. All conditions must pass for the rule to match.
4310 { # A condition to be met.
4311 &quot;iam&quot;: &quot;A String&quot;, # Trusted attributes supplied by the IAM system.
4312 &quot;op&quot;: &quot;A String&quot;, # An operator to apply the subject with.
4313 &quot;svc&quot;: &quot;A String&quot;, # Trusted attributes discharged by the service.
4314 &quot;sys&quot;: &quot;A String&quot;, # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
4315 &quot;values&quot;: [ # The objects of the condition.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4316 &quot;A String&quot;,
4317 ],
4318 },
4319 ],
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4320 &quot;description&quot;: &quot;A String&quot;, # Human-readable description of the rule.
4321 &quot;ins&quot;: [ # If one or more &#x27;in&#x27; clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4322 &quot;A String&quot;,
4323 ],
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4324 &quot;logConfigs&quot;: [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
4325 { # Specifies what kind of log the caller must write
4326 &quot;cloudAudit&quot;: { # Write a Cloud Audit log # Cloud audit options.
4327 &quot;authorizationLoggingOptions&quot;: { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.
4328 &quot;permissionType&quot;: &quot;A String&quot;, # The type of the permission that was checked.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4329 },
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4330 &quot;logName&quot;: &quot;A String&quot;, # The log_name to populate in the Cloud Audit Record.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4331 },
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4332 &quot;counter&quot;: { # Increment a streamz counter with the specified metric and field names. # Counter options.
4333 #
4334 # Metric names should start with a &#x27;/&#x27;, generally be lowercase-only, and end in &quot;_count&quot;. Field names should not contain an initial slash. The actual exported metric names will have &quot;/iam/policy&quot; prepended.
4335 #
4336 # Field names correspond to IAM request parameters and field values are their respective values.
4337 #
4338 # Supported field names: - &quot;authority&quot;, which is &quot;[token]&quot; if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - &quot;iam_principal&quot;, a representation of IAMContext.principal even if a token or authority selector is present; or - &quot;&quot; (empty string), resulting in a counter with no fields.
4339 #
4340 # Examples: counter { metric: &quot;/debug_access_count&quot; field: &quot;iam_principal&quot; } ==&gt; increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}
4341 &quot;customFields&quot;: [ # Custom fields.
4342 { # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.
4343 &quot;name&quot;: &quot;A String&quot;, # Name is the field name.
4344 &quot;value&quot;: &quot;A String&quot;, # Value is the field value. It is important that in contrast to the CounterOptions.field, the value here is a constant that is not derived from the IAMContext.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4345 },
4346 ],
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4347 &quot;field&quot;: &quot;A String&quot;, # The field value to attribute.
4348 &quot;metric&quot;: &quot;A String&quot;, # The metric to update.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4349 },
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4350 &quot;dataAccess&quot;: { # Write a Data Access (Gin) log # Data access options.
4351 &quot;logMode&quot;: &quot;A String&quot;,
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4352 },
4353 },
4354 ],
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4355 &quot;notIns&quot;: [ # If one or more &#x27;not_in&#x27; clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4356 &quot;A String&quot;,
4357 ],
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4358 &quot;permissions&quot;: [ # A permission is a string of form &#x27;..&#x27; (e.g., &#x27;storage.buckets.list&#x27;). A value of &#x27;*&#x27; matches all permissions, and a verb part of &#x27;*&#x27; (e.g., &#x27;storage.buckets.*&#x27;) matches all verbs.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4359 &quot;A String&quot;,
4360 ],
4361 },
4362 ],
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4363 &quot;version&quot;: 42, # Specifies the format of the policy.
4364 #
4365 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.
4366 #
4367 # Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:
4368 #
4369 # * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions
4370 #
4371 # **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
4372 #
4373 # If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.
4374 #
4375 # To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4376 },
4377}
4378
4379
4380Returns:
4381 An object of the form:
4382
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4383 { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.
4384 #
4385 #
4386 #
4387 # A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role.
4388 #
4389 # For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
4390 #
4391 # **JSON example:**
4392 #
4393 # { &quot;bindings&quot;: [ { &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;, &quot;members&quot;: [ &quot;user:mike@example.com&quot;, &quot;group:admins@example.com&quot;, &quot;domain:google.com&quot;, &quot;serviceAccount:my-project-id@appspot.gserviceaccount.com&quot; ] }, { &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;, &quot;members&quot;: [ &quot;user:eve@example.com&quot; ], &quot;condition&quot;: { &quot;title&quot;: &quot;expirable access&quot;, &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;, &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;, } } ], &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;, &quot;version&quot;: 3 }
4394 #
4395 # **YAML example:**
4396 #
4397 # bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;) - etag: BwWWja0YfJA= - version: 3
4398 #
4399 # For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4400 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4401 { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.
4402 #
4403 # If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.
4404 #
4405 # Example Policy with multiple AuditConfigs:
4406 #
4407 # { &quot;audit_configs&quot;: [ { &quot;service&quot;: &quot;allServices&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:jose@example.com&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; }, { &quot;log_type&quot;: &quot;ADMIN_READ&quot; } ] }, { &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot; }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot;, &quot;exempted_members&quot;: [ &quot;user:aliya@example.com&quot; ] } ] } ] }
4408 #
4409 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4410 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4411 { # Provides the configuration for logging a type of permissions. Example:
4412 #
4413 # { &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:jose@example.com&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; } ] }
4414 #
4415 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting jose@example.com from DATA_READ logging.
4416 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4417 &quot;A String&quot;,
4418 ],
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4419 &quot;ignoreChildExemptions&quot;: True or False,
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4420 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
4421 },
4422 ],
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4423 &quot;exemptedMembers&quot;: [
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4424 &quot;A String&quot;,
4425 ],
4426 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
4427 },
4428 ],
4429 &quot;bindings&quot;: [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.
4430 { # Associates `members` with a `role`.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4431 &quot;bindingId&quot;: &quot;A String&quot;,
4432 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. # The condition that is associated with this binding.
4433 #
4434 # If the condition evaluates to `true`, then this binding applies to the current request.
4435 #
4436 # If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.
4437 #
4438 # To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
4439 #
4440 # Example (Comparison):
4441 #
4442 # title: &quot;Summary size limit&quot; description: &quot;Determines if a summary is less than 100 chars&quot; expression: &quot;document.summary.size() &lt; 100&quot;
4443 #
4444 # Example (Equality):
4445 #
4446 # title: &quot;Requestor is owner&quot; description: &quot;Determines if requestor is the document owner&quot; expression: &quot;document.owner == request.auth.claims.email&quot;
4447 #
4448 # Example (Logic):
4449 #
4450 # title: &quot;Public documents&quot; description: &quot;Determine whether the document should be publicly visible&quot; expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
4451 #
4452 # Example (Data Manipulation):
4453 #
4454 # title: &quot;Notification string&quot; description: &quot;Create a notification string with a timestamp.&quot; expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
4455 #
4456 # The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4457 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
4458 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
4459 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
4460 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
4461 },
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4462 &quot;members&quot;: [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
4463 #
4464 # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
4465 #
4466 # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
4467 #
4468 # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .
4469 #
4470 #
4471 #
4472 # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
4473 #
4474 # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
4475 #
4476 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding.
4477 #
4478 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding.
4479 #
4480 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.
4481 #
4482 #
4483 #
4484 # * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4485 &quot;A String&quot;,
4486 ],
4487 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
4488 },
4489 ],
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4490 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
4491 #
4492 # **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
4493 &quot;iamOwned&quot;: True or False,
4494 &quot;rules&quot;: [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
4495 { # A rule to be applied in a Policy.
4496 &quot;action&quot;: &quot;A String&quot;, # Required
4497 &quot;conditions&quot;: [ # Additional restrictions that must be met. All conditions must pass for the rule to match.
4498 { # A condition to be met.
4499 &quot;iam&quot;: &quot;A String&quot;, # Trusted attributes supplied by the IAM system.
4500 &quot;op&quot;: &quot;A String&quot;, # An operator to apply the subject with.
4501 &quot;svc&quot;: &quot;A String&quot;, # Trusted attributes discharged by the service.
4502 &quot;sys&quot;: &quot;A String&quot;, # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
4503 &quot;values&quot;: [ # The objects of the condition.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4504 &quot;A String&quot;,
4505 ],
4506 },
4507 ],
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4508 &quot;description&quot;: &quot;A String&quot;, # Human-readable description of the rule.
4509 &quot;ins&quot;: [ # If one or more &#x27;in&#x27; clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4510 &quot;A String&quot;,
4511 ],
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4512 &quot;logConfigs&quot;: [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
4513 { # Specifies what kind of log the caller must write
4514 &quot;cloudAudit&quot;: { # Write a Cloud Audit log # Cloud audit options.
4515 &quot;authorizationLoggingOptions&quot;: { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.
4516 &quot;permissionType&quot;: &quot;A String&quot;, # The type of the permission that was checked.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4517 },
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4518 &quot;logName&quot;: &quot;A String&quot;, # The log_name to populate in the Cloud Audit Record.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4519 },
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4520 &quot;counter&quot;: { # Increment a streamz counter with the specified metric and field names. # Counter options.
4521 #
4522 # Metric names should start with a &#x27;/&#x27;, generally be lowercase-only, and end in &quot;_count&quot;. Field names should not contain an initial slash. The actual exported metric names will have &quot;/iam/policy&quot; prepended.
4523 #
4524 # Field names correspond to IAM request parameters and field values are their respective values.
4525 #
4526 # Supported field names: - &quot;authority&quot;, which is &quot;[token]&quot; if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - &quot;iam_principal&quot;, a representation of IAMContext.principal even if a token or authority selector is present; or - &quot;&quot; (empty string), resulting in a counter with no fields.
4527 #
4528 # Examples: counter { metric: &quot;/debug_access_count&quot; field: &quot;iam_principal&quot; } ==&gt; increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}
4529 &quot;customFields&quot;: [ # Custom fields.
4530 { # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.
4531 &quot;name&quot;: &quot;A String&quot;, # Name is the field name.
4532 &quot;value&quot;: &quot;A String&quot;, # Value is the field value. It is important that in contrast to the CounterOptions.field, the value here is a constant that is not derived from the IAMContext.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4533 },
4534 ],
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4535 &quot;field&quot;: &quot;A String&quot;, # The field value to attribute.
4536 &quot;metric&quot;: &quot;A String&quot;, # The metric to update.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4537 },
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4538 &quot;dataAccess&quot;: { # Write a Data Access (Gin) log # Data access options.
4539 &quot;logMode&quot;: &quot;A String&quot;,
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4540 },
4541 },
4542 ],
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4543 &quot;notIns&quot;: [ # If one or more &#x27;not_in&#x27; clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4544 &quot;A String&quot;,
4545 ],
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4546 &quot;permissions&quot;: [ # A permission is a string of form &#x27;..&#x27; (e.g., &#x27;storage.buckets.list&#x27;). A value of &#x27;*&#x27; matches all permissions, and a verb part of &#x27;*&#x27; (e.g., &#x27;storage.buckets.*&#x27;) matches all verbs.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4547 &quot;A String&quot;,
4548 ],
4549 },
4550 ],
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4551 &quot;version&quot;: 42, # Specifies the format of the policy.
4552 #
4553 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.
4554 #
4555 # Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:
4556 #
4557 # * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions
4558 #
4559 # **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
4560 #
4561 # If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.
4562 #
4563 # To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4564}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4565</div>
4566
4567<div class="method">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4568 <code class="details" id="setLabels">setLabels(project, zone, instance, body=None, requestId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4569 <pre>Sets labels on an instance. To learn more about labels, read the Labeling Resources documentation.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]4570
4571Args:
4572 project: string, Project ID for this request. (required)
4573 zone: string, The name of the zone for this request. (required)
4574 instance: string, Name of the instance scoping this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]4575 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]4576 The object takes the form of:
4577
4578{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4579 &quot;labelFingerprint&quot;: &quot;A String&quot;, # Fingerprint of the previous set of labels for this resource, used to prevent conflicts. Provide the latest fingerprint value when making a request to add or change labels.
4580 &quot;labels&quot;: {
4581 &quot;a_key&quot;: &quot;A String&quot;,
4582 },
4583}
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]4584
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4585 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
4586
4587For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
4588
4589The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]4590
4591Returns:
4592 An object of the form:
4593
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4594 { # Represents an Operation resource.
4595 #
4596 # Google Compute Engine has three Operation resources:
4597 #
4598 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
4599 #
4600 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
4601 #
4602 # Operations can be global, regional or zonal.
4603 # - For global operations, use the `globalOperations` resource.
4604 # - For regional operations, use the `regionOperations` resource.
4605 # - For zonal operations, use the `zonalOperations` resource.
4606 #
4607 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4608 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
4609 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
4610 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
4611 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
4612 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
4613 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4614 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4615 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
4616 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
4617 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4618 },
4619 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4620 },
4621 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
4622 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
4623 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
4624 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
4625 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
4626 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]4627 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4628 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
4629 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
4630 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
4631 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
4632 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
4633 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
4634 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
4635 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
4636 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
4637 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
4638 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
4639 {
4640 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4641 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
4642 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4643 {
4644 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
4645 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
4646 },
4647 ],
4648 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
4649 },
4650 ],
4651 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
4652}</pre>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]4653</div>
4654
4655<div class="method">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4656 <code class="details" id="setMachineResources">setMachineResources(project, zone, instance, body=None, requestId=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]4657 <pre>Changes the number and/or type of accelerator for a stopped instance to the values specified in the request.
4658
4659Args:
4660 project: string, Project ID for this request. (required)
4661 zone: string, The name of the zone for this request. (required)
4662 instance: string, Name of the instance scoping this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]4663 body: object, The request body.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]4664 The object takes the form of:
4665
4666{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4667 &quot;guestAccelerators&quot;: [ # A list of the type and count of accelerator cards attached to the instance.
4668 { # A specification of the type and number of accelerator cards attached to the instance.
4669 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
4670 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.
4671 },
4672 ],
4673}
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]4674
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4675 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
4676
4677For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
4678
4679The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]4680
4681Returns:
4682 An object of the form:
4683
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4684 { # Represents an Operation resource.
4685 #
4686 # Google Compute Engine has three Operation resources:
4687 #
4688 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
4689 #
4690 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
4691 #
4692 # Operations can be global, regional or zonal.
4693 # - For global operations, use the `globalOperations` resource.
4694 # - For regional operations, use the `regionOperations` resource.
4695 # - For zonal operations, use the `zonalOperations` resource.
4696 #
4697 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4698 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
4699 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
4700 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
4701 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
4702 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
4703 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4704 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4705 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
4706 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
4707 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4708 },
4709 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4710 },
4711 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
4712 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
4713 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
4714 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
4715 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
4716 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]4717 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4718 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
4719 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
4720 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
4721 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
4722 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
4723 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
4724 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
4725 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
4726 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
4727 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
4728 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
4729 {
4730 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4731 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
4732 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4733 {
4734 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
4735 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
4736 },
4737 ],
4738 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
4739 },
4740 ],
4741 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
4742}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]4743</div>
4744
4745<div class="method">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4746 <code class="details" id="setMachineType">setMachineType(project, zone, instance, body=None, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]4747 <pre>Changes the machine type for a stopped instance to the machine type specified in the request.
4748
4749Args:
4750 project: string, Project ID for this request. (required)
4751 zone: string, The name of the zone for this request. (required)
4752 instance: string, Name of the instance scoping this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]4753 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]4754 The object takes the form of:
4755
4756{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4757 &quot;machineType&quot;: &quot;A String&quot;, # Full or partial URL of the machine type resource. See Machine Types for a full list of machine types. For example: zones/us-central1-f/machineTypes/n1-standard-1
4758}
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]4759
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4760 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
4761
4762For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
4763
4764The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]4765
4766Returns:
4767 An object of the form:
4768
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4769 { # Represents an Operation resource.
4770 #
4771 # Google Compute Engine has three Operation resources:
4772 #
4773 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
4774 #
4775 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
4776 #
4777 # Operations can be global, regional or zonal.
4778 # - For global operations, use the `globalOperations` resource.
4779 # - For regional operations, use the `regionOperations` resource.
4780 # - For zonal operations, use the `zonalOperations` resource.
4781 #
4782 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4783 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
4784 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
4785 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
4786 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
4787 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
4788 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4789 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4790 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
4791 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
4792 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4793 },
4794 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4795 },
4796 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
4797 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
4798 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
4799 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
4800 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
4801 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]4802 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4803 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
4804 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
4805 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
4806 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
4807 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
4808 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
4809 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
4810 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
4811 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
4812 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
4813 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
4814 {
4815 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4816 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
4817 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4818 {
4819 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
4820 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
4821 },
4822 ],
4823 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
4824 },
4825 ],
4826 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
4827}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]4828</div>
4829
4830<div class="method">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4831 <code class="details" id="setMetadata">setMetadata(project, zone, instance, body=None, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]4832 <pre>Sets metadata for the specified instance to the data included in the request.
4833
4834Args:
4835 project: string, Project ID for this request. (required)
4836 zone: string, The name of the zone for this request. (required)
4837 instance: string, Name of the instance scoping this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]4838 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]4839 The object takes the form of:
4840
4841{ # A metadata key/value entry.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4842 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of the metadata&#x27;s contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet.
4843 #
4844 # To see the latest fingerprint, make a get() request to retrieve the resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4845 &quot;items&quot;: [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4846 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4847 &quot;key&quot;: &quot;A String&quot;, # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
4848 &quot;value&quot;: &quot;A String&quot;, # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB).
4849 },
4850 ],
4851 &quot;kind&quot;: &quot;compute#metadata&quot;, # [Output Only] Type of the resource. Always compute#metadata for metadata.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]4852}
4853
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4854 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
4855
4856For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
4857
4858The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]4859
4860Returns:
4861 An object of the form:
4862
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4863 { # Represents an Operation resource.
4864 #
4865 # Google Compute Engine has three Operation resources:
4866 #
4867 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
4868 #
4869 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
4870 #
4871 # Operations can be global, regional or zonal.
4872 # - For global operations, use the `globalOperations` resource.
4873 # - For regional operations, use the `regionOperations` resource.
4874 # - For zonal operations, use the `zonalOperations` resource.
4875 #
4876 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4877 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
4878 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
4879 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
4880 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
4881 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
4882 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4883 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4884 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
4885 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
4886 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4887 },
4888 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4889 },
4890 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
4891 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
4892 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
4893 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
4894 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
4895 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]4896 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4897 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
4898 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
4899 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
4900 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
4901 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
4902 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
4903 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
4904 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
4905 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
4906 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
4907 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
4908 {
4909 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4910 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
4911 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4912 {
4913 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
4914 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
4915 },
4916 ],
4917 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
4918 },
4919 ],
4920 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
4921}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]4922</div>
4923
4924<div class="method">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4925 <code class="details" id="setMinCpuPlatform">setMinCpuPlatform(project, zone, instance, body=None, requestId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4926 <pre>Changes the minimum CPU platform that this instance should use. This method can only be called on a stopped instance. For more information, read Specifying a Minimum CPU Platform.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]4927
4928Args:
4929 project: string, Project ID for this request. (required)
4930 zone: string, The name of the zone for this request. (required)
4931 instance: string, Name of the instance scoping this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]4932 body: object, The request body.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]4933 The object takes the form of:
4934
4935{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4936 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Minimum cpu/platform this instance should be started at.
4937}
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]4938
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4939 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
4940
4941For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
4942
4943The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]4944
4945Returns:
4946 An object of the form:
4947
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4948 { # Represents an Operation resource.
4949 #
4950 # Google Compute Engine has three Operation resources:
4951 #
4952 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
4953 #
4954 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
4955 #
4956 # Operations can be global, regional or zonal.
4957 # - For global operations, use the `globalOperations` resource.
4958 # - For regional operations, use the `regionOperations` resource.
4959 # - For zonal operations, use the `zonalOperations` resource.
4960 #
4961 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4962 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
4963 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
4964 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
4965 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
4966 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
4967 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4968 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4969 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
4970 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
4971 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4972 },
4973 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4974 },
4975 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
4976 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
4977 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
4978 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
4979 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
4980 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]4981 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4982 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
4983 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
4984 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
4985 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
4986 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
4987 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
4988 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
4989 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
4990 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
4991 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
4992 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
4993 {
4994 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]4995 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
4996 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4997 {
4998 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
4999 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
5000 },
5001 ],
5002 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
5003 },
5004 ],
5005 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
5006}</pre>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]5007</div>
5008
5009<div class="method">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]5010 <code class="details" id="setName">setName(project, zone, instance, body=None, requestId=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]5011 <pre>Sets name of an instance.
5012
5013Args:
5014 project: string, Project ID for this request. (required)
5015 zone: string, The name of the zone for this request. (required)
5016 instance: string, The instance name for this request. (required)
5017 body: object, The request body.
5018 The object takes the form of:
5019
5020{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5021 &quot;currentName&quot;: &quot;A String&quot;, # The current name of this resource, used to prevent conflicts. Provide the latest name when making a request to change name.
5022 &quot;name&quot;: &quot;A String&quot;, # The name to be applied to the instance. Needs to be RFC 1035 compliant.
5023}
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]5024
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]5025 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
5026
5027For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
5028
5029The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]5030
5031Returns:
5032 An object of the form:
5033
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]5034 { # Represents an Operation resource.
5035 #
5036 # Google Compute Engine has three Operation resources:
5037 #
5038 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
5039 #
5040 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
5041 #
5042 # Operations can be global, regional or zonal.
5043 # - For global operations, use the `globalOperations` resource.
5044 # - For regional operations, use the `regionOperations` resource.
5045 # - For zonal operations, use the `zonalOperations` resource.
5046 #
5047 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5048 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
5049 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
5050 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
5051 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
5052 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
5053 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]5054 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5055 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
5056 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
5057 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]5058 },
5059 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5060 },
5061 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
5062 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
5063 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
5064 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
5065 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
5066 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]5067 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5068 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
5069 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
5070 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
5071 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
5072 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
5073 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
5074 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
5075 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
5076 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
5077 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
5078 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
5079 {
5080 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]5081 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
5082 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5083 {
5084 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
5085 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
5086 },
5087 ],
5088 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
5089 },
5090 ],
5091 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
5092}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]5093</div>
5094
5095<div class="method">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]5096 <code class="details" id="setScheduling">setScheduling(project, zone, instance, body=None, requestId=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]5097 <pre>Sets an instance&#x27;s scheduling options. You can only call this method on a stopped instance, that is, a VM instance that is in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]5098
5099Args:
5100 project: string, Project ID for this request. (required)
5101 zone: string, The name of the zone for this request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5102 instance: string, Instance name for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]5103 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]5104 The object takes the form of:
5105
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700[diff] [blame]5106{ # Sets the scheduling options for an Instance. NextID: 21
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]5107 &quot;automaticRestart&quot;: True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
5108 #
5109 # By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.
yoshi-code-bot73a0aa32021-05-25 00:30:03 -0700[diff] [blame]5110 &quot;hostErrorTimeoutSeconds&quot;: 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]5111 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API.
yoshi-code-bot9e2cde22021-04-29 03:48:05 -0700[diff] [blame]5112 &quot;maintenanceFreezeDurationHours&quot;: 42, # Specifies the number of hours after VM instance creation where the VM won&#x27;t be scheduled for maintenance.
5113 &quot;maintenanceInterval&quot;: &quot;A String&quot;, # For more information about maintenance intervals, see Setting maintenance intervals.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5114 &quot;minNodeCpus&quot;: 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.
5115 &quot;nodeAffinities&quot;: [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5116 { # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5117 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of Node resource.
5118 &quot;operator&quot;: &quot;A String&quot;, # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.
5119 &quot;values&quot;: [ # Corresponds to the label values of Node resource.
5120 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5121 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5122 },
5123 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5124 &quot;onHostMaintenance&quot;: &quot;A String&quot;, # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]5125 &quot;preemptible&quot;: True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]5126}
5127
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]5128 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
5129
5130For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
5131
5132The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]5133
5134Returns:
5135 An object of the form:
5136
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]5137 { # Represents an Operation resource.
5138 #
5139 # Google Compute Engine has three Operation resources:
5140 #
5141 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
5142 #
5143 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
5144 #
5145 # Operations can be global, regional or zonal.
5146 # - For global operations, use the `globalOperations` resource.
5147 # - For regional operations, use the `regionOperations` resource.
5148 # - For zonal operations, use the `zonalOperations` resource.
5149 #
5150 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5151 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
5152 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
5153 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
5154 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
5155 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
5156 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5157 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5158 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
5159 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
5160 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5161 },
5162 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5163 },
5164 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
5165 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
5166 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
5167 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
5168 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
5169 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]5170 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5171 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
5172 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
5173 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
5174 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
5175 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
5176 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
5177 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
5178 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
5179 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
5180 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
5181 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
5182 {
5183 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]5184 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
5185 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5186 {
5187 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
5188 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
5189 },
5190 ],
5191 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
5192 },
5193 ],
5194 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
5195}</pre>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]5196</div>
5197
5198<div class="method">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]5199 <code class="details" id="setServiceAccount">setServiceAccount(project, zone, instance, body=None, requestId=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]5200 <pre>Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]5201
5202Args:
5203 project: string, Project ID for this request. (required)
5204 zone: string, The name of the zone for this request. (required)
5205 instance: string, Name of the instance resource to start. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]5206 body: object, The request body.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]5207 The object takes the form of:
5208
5209{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5210 &quot;email&quot;: &quot;A String&quot;, # Email address of the service account.
5211 &quot;scopes&quot;: [ # The list of scopes to be made available for this service account.
5212 &quot;A String&quot;,
5213 ],
5214}
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]5215
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]5216 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
5217
5218For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
5219
5220The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]5221
5222Returns:
5223 An object of the form:
5224
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]5225 { # Represents an Operation resource.
5226 #
5227 # Google Compute Engine has three Operation resources:
5228 #
5229 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
5230 #
5231 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
5232 #
5233 # Operations can be global, regional or zonal.
5234 # - For global operations, use the `globalOperations` resource.
5235 # - For regional operations, use the `regionOperations` resource.
5236 # - For zonal operations, use the `zonalOperations` resource.
5237 #
5238 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5239 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
5240 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
5241 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
5242 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
5243 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
5244 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5245 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5246 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
5247 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
5248 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5249 },
5250 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5251 },
5252 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
5253 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
5254 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
5255 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
5256 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
5257 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]5258 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5259 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
5260 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
5261 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
5262 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
5263 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
5264 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
5265 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
5266 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
5267 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
5268 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
5269 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
5270 {
5271 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]5272 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
5273 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5274 {
5275 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
5276 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
5277 },
5278 ],
5279 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
5280 },
5281 ],
5282 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
5283}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]5284</div>
5285
5286<div class="method">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]5287 <code class="details" id="setShieldedInstanceIntegrityPolicy">setShieldedInstanceIntegrityPolicy(project, zone, instance, body=None, requestId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5288 <pre>Sets the Shielded Instance integrity policy for an instance. You can only use this method on a running instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
5289
5290Args:
5291 project: string, Project ID for this request. (required)
5292 zone: string, The name of the zone for this request. (required)
5293 instance: string, Name or id of the instance scoping this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]5294 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5295 The object takes the form of:
5296
5297{ # The policy describes the baseline against which Instance boot integrity is measured.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5298 &quot;updateAutoLearnPolicy&quot;: True or False, # Updates the integrity policy baseline using the measurements from the VM instance&#x27;s most recent boot.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]5299}
5300
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]5301 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
5302
5303For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
5304
5305The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]5306
5307Returns:
5308 An object of the form:
5309
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]5310 { # Represents an Operation resource.
5311 #
5312 # Google Compute Engine has three Operation resources:
5313 #
5314 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
5315 #
5316 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
5317 #
5318 # Operations can be global, regional or zonal.
5319 # - For global operations, use the `globalOperations` resource.
5320 # - For regional operations, use the `regionOperations` resource.
5321 # - For zonal operations, use the `zonalOperations` resource.
5322 #
5323 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5324 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
5325 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
5326 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
5327 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
5328 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
5329 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5330 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5331 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
5332 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
5333 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5334 },
5335 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5336 },
5337 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
5338 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
5339 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
5340 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
5341 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
5342 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]5343 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5344 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
5345 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
5346 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
5347 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
5348 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
5349 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
5350 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
5351 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
5352 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
5353 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
5354 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
5355 {
5356 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]5357 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
5358 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5359 {
5360 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
5361 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
5362 },
5363 ],
5364 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
5365 },
5366 ],
5367 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
5368}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5369</div>
5370
5371<div class="method">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]5372 <code class="details" id="setShieldedVmIntegrityPolicy">setShieldedVmIntegrityPolicy(project, zone, instance, body=None, requestId=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5373 <pre>Sets the Shielded VM integrity policy for a VM instance. You can only use this method on a running VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
5374
5375Args:
5376 project: string, Project ID for this request. (required)
5377 zone: string, The name of the zone for this request. (required)
5378 instance: string, Name of the instance scoping this request. (required)
5379 body: object, The request body.
5380 The object takes the form of:
5381
5382{ # The policy describes the baseline against which VM instance boot integrity is measured.
5383 &quot;updateAutoLearnPolicy&quot;: True or False, # Updates the integrity policy baseline using the measurements from the VM instance&#x27;s most recent boot.
5384}
5385
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]5386 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
5387
5388For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
5389
5390The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5391
5392Returns:
5393 An object of the form:
5394
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]5395 { # Represents an Operation resource.
5396 #
5397 # Google Compute Engine has three Operation resources:
5398 #
5399 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
5400 #
5401 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
5402 #
5403 # Operations can be global, regional or zonal.
5404 # - For global operations, use the `globalOperations` resource.
5405 # - For regional operations, use the `regionOperations` resource.
5406 # - For zonal operations, use the `zonalOperations` resource.
5407 #
5408 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5409 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
5410 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
5411 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
5412 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
5413 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
5414 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5415 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5416 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
5417 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
5418 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5419 },
5420 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5421 },
5422 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
5423 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
5424 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
5425 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
5426 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
5427 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]5428 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5429 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
5430 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
5431 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
5432 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
5433 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
5434 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
5435 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
5436 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
5437 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
5438 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
5439 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
5440 {
5441 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]5442 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
5443 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5444 {
5445 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
5446 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
5447 },
5448 ],
5449 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
5450 },
5451 ],
5452 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
5453}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5454</div>
5455
5456<div class="method">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]5457 <code class="details" id="setTags">setTags(project, zone, instance, body=None, requestId=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5458 <pre>Sets network tags for the specified instance to the data included in the request.
5459
5460Args:
5461 project: string, Project ID for this request. (required)
5462 zone: string, The name of the zone for this request. (required)
5463 instance: string, Name of the instance scoping this request. (required)
5464 body: object, The request body.
5465 The object takes the form of:
5466
5467{ # A set of instance tags.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]5468 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of the tags&#x27; contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update tags. You must always provide an up-to-date fingerprint hash in order to update or change tags.
5469 #
5470 # To see the latest fingerprint, make get() request to the instance.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5471 &quot;items&quot;: [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
5472 &quot;A String&quot;,
5473 ],
5474}
5475
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]5476 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
5477
5478For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
5479
5480The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5481
5482Returns:
5483 An object of the form:
5484
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]5485 { # Represents an Operation resource.
5486 #
5487 # Google Compute Engine has three Operation resources:
5488 #
5489 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
5490 #
5491 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
5492 #
5493 # Operations can be global, regional or zonal.
5494 # - For global operations, use the `globalOperations` resource.
5495 # - For regional operations, use the `regionOperations` resource.
5496 # - For zonal operations, use the `zonalOperations` resource.
5497 #
5498 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5499 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
5500 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
5501 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
5502 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
5503 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
5504 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5505 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5506 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
5507 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
5508 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5509 },
5510 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5511 },
5512 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
5513 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
5514 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
5515 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
5516 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
5517 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]5518 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5519 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
5520 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
5521 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
5522 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
5523 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
5524 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
5525 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
5526 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
5527 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
5528 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
5529 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
5530 {
5531 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]5532 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
5533 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5534 {
5535 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
5536 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
5537 },
5538 ],
5539 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
5540 },
5541 ],
5542 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
5543}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]5544</div>
5545
5546<div class="method">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]5547 <code class="details" id="simulateMaintenanceEvent">simulateMaintenanceEvent(project, zone, instance)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5548 <pre>Simulates a maintenance event on the instance.
5549
5550Args:
5551 project: string, Project ID for this request. (required)
5552 zone: string, The name of the zone for this request. (required)
5553 instance: string, Name of the instance scoping this request. (required)
5554
5555Returns:
5556 An object of the form:
5557
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]5558 { # Represents an Operation resource.
5559 #
5560 # Google Compute Engine has three Operation resources:
5561 #
5562 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
5563 #
5564 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
5565 #
5566 # Operations can be global, regional or zonal.
5567 # - For global operations, use the `globalOperations` resource.
5568 # - For regional operations, use the `regionOperations` resource.
5569 # - For zonal operations, use the `zonalOperations` resource.
5570 #
5571 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5572 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
5573 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
5574 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
5575 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
5576 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
5577 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5578 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5579 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
5580 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
5581 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5582 },
5583 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5584 },
5585 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
5586 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
5587 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
5588 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
5589 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
5590 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]5591 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5592 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
5593 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
5594 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
5595 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
5596 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
5597 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
5598 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
5599 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
5600 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
5601 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
5602 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
5603 {
5604 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]5605 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
5606 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5607 {
5608 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
5609 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
5610 },
5611 ],
5612 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
5613 },
5614 ],
5615 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
5616}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5617</div>
5618
5619<div class="method">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]5620 <code class="details" id="start">start(project, zone, instance, requestId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5621 <pre>Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]5622
5623Args:
5624 project: string, Project ID for this request. (required)
5625 zone: string, The name of the zone for this request. (required)
5626 instance: string, Name of the instance resource to start. (required)
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]5627 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
5628
5629For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
5630
5631The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]5632
5633Returns:
5634 An object of the form:
5635
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]5636 { # Represents an Operation resource.
5637 #
5638 # Google Compute Engine has three Operation resources:
5639 #
5640 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
5641 #
5642 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
5643 #
5644 # Operations can be global, regional or zonal.
5645 # - For global operations, use the `globalOperations` resource.
5646 # - For regional operations, use the `regionOperations` resource.
5647 # - For zonal operations, use the `zonalOperations` resource.
5648 #
5649 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5650 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
5651 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
5652 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
5653 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
5654 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
5655 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5656 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5657 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
5658 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
5659 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5660 },
5661 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5662 },
5663 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
5664 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
5665 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
5666 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
5667 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
5668 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]5669 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5670 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
5671 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
5672 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
5673 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
5674 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
5675 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
5676 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
5677 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
5678 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
5679 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
5680 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
5681 {
5682 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]5683 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
5684 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5685 {
5686 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
5687 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
5688 },
5689 ],
5690 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
5691 },
5692 ],
5693 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
5694}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]5695</div>
5696
5697<div class="method">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]5698 <code class="details" id="startWithEncryptionKey">startWithEncryptionKey(project, zone, instance, body=None, requestId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5699 <pre>Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]5700
5701Args:
5702 project: string, Project ID for this request. (required)
5703 zone: string, The name of the zone for this request. (required)
5704 instance: string, Name of the instance resource to start. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]5705 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]5706 The object takes the form of:
5707
5708{
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]5709 &quot;disks&quot;: [ # Array of disks associated with this instance that are protected with a customer-supplied encryption key.
5710 #
5711 # In order to start the instance, the disk url and its corresponding key must be provided.
5712 #
5713 # If the disk is not protected with a customer-supplied encryption key it should not be specified.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5714 {
5715 &quot;diskEncryptionKey&quot;: { # Decrypts data associated with the disk with a customer-supplied encryption key.
5716 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
5717 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
5718 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]5719 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
5720 #
5721 # The key must meet the following requirements before you can provide it to Compute Engine:
5722 # - The key is wrapped using a RSA public key certificate provided by Google.
5723 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:
5724 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5725 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]5726 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5727 &quot;source&quot;: &quot;A String&quot;, # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks.
5728 },
5729 ],
5730}
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]5731
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]5732 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
5733
5734For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
5735
5736The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]5737
5738Returns:
5739 An object of the form:
5740
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]5741 { # Represents an Operation resource.
5742 #
5743 # Google Compute Engine has three Operation resources:
5744 #
5745 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
5746 #
5747 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
5748 #
5749 # Operations can be global, regional or zonal.
5750 # - For global operations, use the `globalOperations` resource.
5751 # - For regional operations, use the `regionOperations` resource.
5752 # - For zonal operations, use the `zonalOperations` resource.
5753 #
5754 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5755 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
5756 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
5757 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
5758 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
5759 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
5760 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5761 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5762 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
5763 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
5764 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5765 },
5766 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5767 },
5768 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
5769 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
5770 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
5771 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
5772 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
5773 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]5774 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5775 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
5776 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
5777 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
5778 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
5779 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
5780 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
5781 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
5782 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
5783 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
5784 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
5785 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
5786 {
5787 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]5788 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
5789 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5790 {
5791 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
5792 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
5793 },
5794 ],
5795 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
5796 },
5797 ],
5798 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
5799}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]5800</div>
5801
5802<div class="method">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]5803 <code class="details" id="stop">stop(project, zone, instance, requestId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5804 <pre>Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur VM usage charges while they are stopped. However, resources that the VM is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]5805
5806Args:
5807 project: string, Project ID for this request. (required)
5808 zone: string, The name of the zone for this request. (required)
5809 instance: string, Name of the instance resource to stop. (required)
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]5810 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
5811
5812For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
5813
5814The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]5815
5816Returns:
5817 An object of the form:
5818
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]5819 { # Represents an Operation resource.
5820 #
5821 # Google Compute Engine has three Operation resources:
5822 #
5823 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
5824 #
5825 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
5826 #
5827 # Operations can be global, regional or zonal.
5828 # - For global operations, use the `globalOperations` resource.
5829 # - For regional operations, use the `regionOperations` resource.
5830 # - For zonal operations, use the `zonalOperations` resource.
5831 #
5832 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5833 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
5834 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
5835 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
5836 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
5837 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
5838 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5839 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5840 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
5841 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
5842 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5843 },
5844 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5845 },
5846 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
5847 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
5848 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
5849 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
5850 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
5851 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]5852 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5853 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
5854 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
5855 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
5856 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
5857 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
5858 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
5859 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
5860 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
5861 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
5862 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
5863 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
5864 {
5865 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]5866 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
5867 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5868 {
5869 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
5870 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
5871 },
5872 ],
5873 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
5874 },
5875 ],
5876 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
5877}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5878</div>
5879
5880<div class="method">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]5881 <code class="details" id="suspend">suspend(project, zone, instance, discardLocalSsd=None, requestId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5882 <pre>This method suspends a running instance, saving its state to persistent storage, and allows you to resume the instance at a later time. Suspended instances incur reduced per-minute, virtual machine usage charges while they are suspended. Any resources the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted.
5883
5884Args:
5885 project: string, Project ID for this request. (required)
5886 zone: string, The name of the zone for this request. (required)
5887 instance: string, Name of the instance resource to suspend. (required)
5888 discardLocalSsd: boolean, If true, discard the contents of any attached localSSD partitions. Default value is false (== preserve localSSD data).
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]5889 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
5890
5891For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
5892
5893The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5894
5895Returns:
5896 An object of the form:
5897
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]5898 { # Represents an Operation resource.
5899 #
5900 # Google Compute Engine has three Operation resources:
5901 #
5902 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
5903 #
5904 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
5905 #
5906 # Operations can be global, regional or zonal.
5907 # - For global operations, use the `globalOperations` resource.
5908 # - For regional operations, use the `regionOperations` resource.
5909 # - For zonal operations, use the `zonalOperations` resource.
5910 #
5911 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5912 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
5913 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
5914 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
5915 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
5916 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
5917 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5918 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5919 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
5920 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
5921 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5922 },
5923 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5924 },
5925 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
5926 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
5927 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
5928 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
5929 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
5930 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]5931 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5932 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
5933 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
5934 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
5935 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
5936 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
5937 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
5938 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
5939 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
5940 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
5941 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
5942 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
5943 {
5944 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]5945 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
5946 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5947 {
5948 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
5949 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
5950 },
5951 ],
5952 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
5953 },
5954 ],
5955 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
5956}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]5957</div>
5958
5959<div class="method">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]5960 <code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]5961 <pre>Returns permissions that a caller has on the specified resource.
5962
5963Args:
5964 project: string, Project ID for this request. (required)
5965 zone: string, The name of the zone for this request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5966 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]5967 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]5968 The object takes the form of:
5969
5970{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5971 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
5972 &quot;A String&quot;,
5973 ],
5974}
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]5975
5976
5977Returns:
5978 An object of the form:
5979
5980 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5981 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
5982 &quot;A String&quot;,
5983 ],
5984}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]5985</div>
5986
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5987<div class="method">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]5988 <code class="details" id="update">update(project, zone, instance, body=None, minimalAction=None, mostDisruptiveAllowedAction=None, requestId=None)</code>
5989 <pre>Updates an instance only if the necessary resources are available. This method can update only a specific set of instance properties. See Updating a running instance for a list of updatable instance properties.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]5990
5991Args:
5992 project: string, Project ID for this request. (required)
5993 zone: string, The name of the zone for this request. (required)
5994 instance: string, Name of the instance resource to update. (required)
5995 body: object, The request body.
5996 The object takes the form of:
5997
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]5998{ # Represents an Instance resource.
5999 #
6000 # An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. (== resource_for {$api_version}.instances ==)
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]6001 &quot;advancedMachineFeatures&quot;: { # Specifies options for controlling advanced machine features. Options that would traditionally be configured in a BIOS belong here. Features that require operating system support may have corresponding entries in the GuestOsFeatures of an Image (e.g., whether or not the OS in the Image supports nested virtualization being enabled or disabled). # Controls for advanced machine-related behavior features.
6002 &quot;enableNestedVirtualization&quot;: True or False, # Whether to enable nested virtualization or not (default is false).
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame]6003 &quot;threadsPerCore&quot;: 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]6004 },
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6005 &quot;canIpForward&quot;: True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]6006 &quot;confidentialInstanceConfig&quot;: { # A set of Confidential Instance options.
6007 &quot;enableConfidentialCompute&quot;: True or False, # Defines whether the instance should have confidential compute enabled.
6008 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6009 &quot;cpuPlatform&quot;: &quot;A String&quot;, # [Output Only] The CPU platform used by this instance.
6010 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
6011 &quot;deletionProtection&quot;: True or False, # Whether the resource should be protected against deletion.
6012 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
6013 &quot;disks&quot;: [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]6014 { # An instance-attached disk resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6015 &quot;autoDelete&quot;: True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
6016 &quot;boot&quot;: True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6017 &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 running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
6018 #
6019 # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
6020 &quot;diskEncryptionKey&quot;: { # Encrypts or decrypts a disk using a customer-supplied encryption key.
6021 #
6022 # If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
6023 #
6024 # If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
6025 #
6026 # If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
6027 #
6028 # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6029 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
6030 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
6031 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6032 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
6033 #
6034 # The key must meet the following requirements before you can provide it to Compute Engine:
6035 # - The key is wrapped using a RSA public key certificate provided by Google.
6036 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:
6037 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6038 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]6039 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6040 &quot;diskSizeGb&quot;: &quot;A String&quot;, # The size of the disk in GB.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6041 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6042 { # Guest OS features.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6043 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6044 },
6045 ],
6046 &quot;index&quot;: 42, # [Output Only] A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6047 &quot;initializeParams&quot;: { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
6048 #
6049 # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
6050 #
6051 # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6052 &quot;description&quot;: &quot;A String&quot;, # An optional description. Provide this property when creating the disk.
6053 &quot;diskName&quot;: &quot;A String&quot;, # Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created.
6054 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6055 &quot;diskType&quot;: &quot;A String&quot;, # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
6056 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
6057 #
6058 #
6059 # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
6060 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
6061 # - projects/project/zones/zone/diskTypes/diskType
6062 # - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.
6063 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.
6064 #
6065 # Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]6066 { # Guest OS features.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6067 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]6068 },
6069 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6070 &quot;labels&quot;: { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.
6071 &quot;a_key&quot;: &quot;A String&quot;,
6072 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]6073 &quot;multiWriter&quot;: True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6074 &quot;onUpdateAction&quot;: &quot;A String&quot;, # Specifies which action to take on instance update with this disk. Default is to use the existing disk.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]6075 &quot;provisionedIops&quot;: &quot;A String&quot;, # Indicates how many IOPS must be provisioned for the disk.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6076 &quot;resourcePolicies&quot;: [ # Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name.
6077 &quot;A String&quot;,
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]6078 ],
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6079 &quot;sourceImage&quot;: &quot;A String&quot;, # The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD.
6080 #
6081 # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image:
6082 # projects/debian-cloud/global/images/family/debian-9
6083 #
6084 #
6085 # Alternatively, use a specific version of a public operating system image:
6086 # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
6087 #
6088 #
6089 # To create a disk with a custom image that you created, specify the image name in the following format:
6090 # global/images/my-custom-image
6091 #
6092 #
6093 # You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
6094 # global/images/family/my-image-family
6095 #
6096 #
6097 # If the source image is deleted later, this field will not be set.
6098 &quot;sourceImageEncryptionKey&quot;: { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
6099 #
6100 # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6101 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
6102 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
6103 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6104 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
6105 #
6106 # The key must meet the following requirements before you can provide it to Compute Engine:
6107 # - The key is wrapped using a RSA public key certificate provided by Google.
6108 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:
6109 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6110 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
6111 },
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6112 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD.
6113 #
6114 # To create a disk with a snapshot that you created, specify the snapshot name in the following format:
6115 # global/snapshots/my-backup
6116 #
6117 #
6118 # If the source snapshot is deleted later, this field will not be set.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]6119 &quot;sourceSnapshotEncryptionKey&quot;: { # The customer-supplied encryption key of the source snapshot.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6120 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
6121 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
6122 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6123 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
6124 #
6125 # The key must meet the following requirements before you can provide it to Compute Engine:
6126 # - The key is wrapped using a RSA public key certificate provided by Google.
6127 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:
6128 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6129 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]6130 },
6131 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6132 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
6133 &quot;kind&quot;: &quot;compute#attachedDisk&quot;, # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
6134 &quot;licenses&quot;: [ # [Output Only] Any valid publicly visible licenses.
6135 &quot;A String&quot;,
6136 ],
6137 &quot;mode&quot;: &quot;A String&quot;, # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
6138 &quot;shieldedInstanceInitialState&quot;: { # Initial State for shielded instance, these are public keys which are safe to store in public # [Output Only] shielded vm initial state stored on disk
6139 &quot;dbs&quot;: [ # The Key Database (db).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]6140 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6141 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
6142 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]6143 },
6144 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6145 &quot;dbxs&quot;: [ # The forbidden key database (dbx).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]6146 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6147 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
6148 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]6149 },
6150 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6151 &quot;keks&quot;: [ # The Key Exchange Key (KEK).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]6152 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6153 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
6154 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]6155 },
6156 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6157 &quot;pk&quot;: { # The Platform Key (PK).
6158 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
6159 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]6160 },
6161 },
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6162 &quot;source&quot;: &quot;A String&quot;, # Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD.
6163 #
6164 # If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.
6165 #
6166 # Note that for InstanceTemplate, specify the disk name, not the URL for the disk.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6167 &quot;type&quot;: &quot;A String&quot;, # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]6168 },
6169 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6170 &quot;displayDevice&quot;: { # A set of Display Device options # Enables display device for the instance.
6171 &quot;enableDisplay&quot;: True or False, # Defines whether the instance has Display enabled.
6172 },
6173 &quot;eraseWindowsVssSignature&quot;: True or False, # Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6174 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this resource, which is essentially a hash of the instance&#x27;s contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update the instance. You must always provide an up-to-date fingerprint hash in order to update the instance.
6175 #
6176 # To see the latest fingerprint, make get() request to the instance.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6177 &quot;guestAccelerators&quot;: [ # A list of the type and count of accelerator cards attached to the instance.
6178 { # A specification of the type and number of accelerator cards attached to the instance.
6179 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
6180 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.
6181 },
6182 ],
6183 &quot;hostname&quot;: &quot;A String&quot;, # Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.
6184 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
6185 &quot;kind&quot;: &quot;compute#instance&quot;, # [Output Only] Type of the resource. Always compute#instance for instances.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6186 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for this request, which is essentially a hash of the label&#x27;s contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
6187 #
6188 # To see the latest fingerprint, make get() request to the instance.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6189 &quot;labels&quot;: { # Labels to apply to this instance. These can be later modified by the setLabels method.
6190 &quot;a_key&quot;: &quot;A String&quot;,
6191 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]6192 &quot;lastStartTimestamp&quot;: &quot;A String&quot;, # [Output Only] Last start timestamp in RFC3339 text format.
6193 &quot;lastStopTimestamp&quot;: &quot;A String&quot;, # [Output Only] Last stop timestamp in RFC3339 text format.
6194 &quot;lastSuspendedTimestamp&quot;: &quot;A String&quot;, # [Output Only] Last suspended timestamp in RFC3339 text format.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6195 &quot;machineType&quot;: &quot;A String&quot;, # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:
6196 # zones/us-central1-f/machineTypes/n1-standard-1
6197 #
6198 #
6199 # To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):
6200 # zones/zone/machineTypes/custom-CPUS-MEMORY
6201 #
6202 #
6203 # For example: zones/us-central1-f/machineTypes/custom-4-5120
6204 #
6205 # For a full list of restrictions, read the Specifications for custom machine types.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6206 &quot;metadata&quot;: { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6207 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of the metadata&#x27;s contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet.
6208 #
6209 # To see the latest fingerprint, make a get() request to retrieve the resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6210 &quot;items&quot;: [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6211 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6212 &quot;key&quot;: &quot;A String&quot;, # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
6213 &quot;value&quot;: &quot;A String&quot;, # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB).
6214 },
6215 ],
6216 &quot;kind&quot;: &quot;compute#metadata&quot;, # [Output Only] Type of the resource. Always compute#metadata for metadata.
6217 },
6218 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: &quot;Intel Haswell&quot; or minCpuPlatform: &quot;Intel Sandy Bridge&quot;.
6219 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
6220 &quot;networkInterfaces&quot;: [ # An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance.
6221 { # A network interface resource attached to an instance.
6222 &quot;accessConfigs&quot;: [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.
6223 { # An access configuration attached to an instance&#x27;s network interface. Only one access config per instance is supported.
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700[diff] [blame]6224 &quot;externalIpv6&quot;: &quot;A String&quot;, # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.
6225 &quot;externalIpv6PrefixLength&quot;: 42, # [Output Only] The prefix length of the external IPv6 range.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6226 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
6227 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access.
6228 &quot;natIP&quot;: &quot;A String&quot;, # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6229 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.
6230 #
6231 # If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.
6232 #
6233 # If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6234 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.
6235 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the external IP address of the instance to a DNS domain name.
6236 &quot;type&quot;: &quot;ONE_TO_ONE_NAT&quot;, # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
6237 },
6238 ],
6239 &quot;aliasIpRanges&quot;: [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.
6240 { # An alias IP range attached to an instance&#x27;s network interface.
6241 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (such as 10.2.3.4), a netmask (such as /24) or a CIDR-formatted string (such as 10.1.2.0/24).
6242 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used.
6243 },
6244 ],
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]6245 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700[diff] [blame]6246 &quot;ipv6AccessConfigs&quot;: [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access.
6247 { # An access configuration attached to an instance&#x27;s network interface. Only one access config per instance is supported.
6248 &quot;externalIpv6&quot;: &quot;A String&quot;, # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.
6249 &quot;externalIpv6PrefixLength&quot;: 42, # [Output Only] The prefix length of the external IPv6 range.
6250 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
6251 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access.
6252 &quot;natIP&quot;: &quot;A String&quot;, # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6253 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.
6254 #
6255 # If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.
6256 #
6257 # If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700[diff] [blame]6258 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.
6259 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the external IP address of the instance to a DNS domain name.
6260 &quot;type&quot;: &quot;ONE_TO_ONE_NAT&quot;, # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
6261 },
6262 ],
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6263 &quot;ipv6AccessType&quot;: &quot;A String&quot;, # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork.
6264 #
6265 # Valid only if stackType is IPV4_IPV6.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6266 &quot;ipv6Address&quot;: &quot;A String&quot;, # [Output Only] An IPv6 internal network address for this network interface.
6267 &quot;kind&quot;: &quot;compute#networkInterface&quot;, # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.
6268 &quot;name&quot;: &quot;A String&quot;, # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6269 &quot;network&quot;: &quot;A String&quot;, # URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred.
6270 #
6271 # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
6272 # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
6273 # - projects/project/global/networks/network
6274 # - global/networks/default
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6275 &quot;networkIP&quot;: &quot;A String&quot;, # An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]6276 &quot;nicType&quot;: &quot;A String&quot;, # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6277 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for this network interface to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used.
6278 #
6279 # This field can be both set at instance creation and update network interface operations.
6280 &quot;subnetwork&quot;: &quot;A String&quot;, # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
6281 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
6282 # - regions/region/subnetworks/subnetwork
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6283 },
6284 ],
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]6285 &quot;networkPerformanceConfig&quot;: {
6286 &quot;totalEgressBandwidthTier&quot;: &quot;A String&quot;,
6287 },
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]6288 &quot;postKeyRevocationActionType&quot;: &quot;A String&quot;, # PostKeyRevocationActionType of the instance.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6289 &quot;privateIpv6GoogleAccess&quot;: &quot;A String&quot;, # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6290 &quot;reservationAffinity&quot;: { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6291 &quot;consumeReservationType&quot;: &quot;A String&quot;, # Specifies the type of reservation from which this instance can consume resources: ANY_RESERVATION (default), SPECIFIC_RESERVATION, or NO_RESERVATION. See Consuming reserved instances for examples.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6292 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify googleapis.com/reservation-name as the key and specify the name of your reservation as its value.
yoshi-code-bot73a0aa32021-05-25 00:30:03 -0700[diff] [blame]6293 &quot;values&quot;: [ # Corresponds to the label values of a reservation resource. This can be either a name to a reservation in the same project or &quot;projects/different-project/reservations/some-reservation-name&quot; to target a shared reservation in the same zone but in a different project.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6294 &quot;A String&quot;,
6295 ],
6296 },
6297 &quot;resourcePolicies&quot;: [ # Resource policies applied to this instance.
6298 &quot;A String&quot;,
6299 ],
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]6300 &quot;satisfiesPzs&quot;: True or False, # [Output Only] Reserved for future use.
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700[diff] [blame]6301 &quot;scheduling&quot;: { # Sets the scheduling options for an Instance. NextID: 21 # Sets the scheduling options for this instance.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6302 &quot;automaticRestart&quot;: True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
6303 #
6304 # By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.
yoshi-code-bot73a0aa32021-05-25 00:30:03 -0700[diff] [blame]6305 &quot;hostErrorTimeoutSeconds&quot;: 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]6306 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API.
yoshi-code-bot9e2cde22021-04-29 03:48:05 -0700[diff] [blame]6307 &quot;maintenanceFreezeDurationHours&quot;: 42, # Specifies the number of hours after VM instance creation where the VM won&#x27;t be scheduled for maintenance.
6308 &quot;maintenanceInterval&quot;: &quot;A String&quot;, # For more information about maintenance intervals, see Setting maintenance intervals.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6309 &quot;minNodeCpus&quot;: 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.
6310 &quot;nodeAffinities&quot;: [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.
6311 { # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.
6312 &quot;key&quot;: &quot;A String&quot;, # Corresponds to the label key of Node resource.
6313 &quot;operator&quot;: &quot;A String&quot;, # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.
6314 &quot;values&quot;: [ # Corresponds to the label values of Node resource.
6315 &quot;A String&quot;,
6316 ],
6317 },
6318 ],
6319 &quot;onHostMaintenance&quot;: &quot;A String&quot;, # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]6320 &quot;preemptible&quot;: True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6321 },
6322 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6323 &quot;serviceAccounts&quot;: [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.
6324 #
6325 # Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6326 { # A service account.
6327 &quot;email&quot;: &quot;A String&quot;, # Email address of the service account.
6328 &quot;scopes&quot;: [ # The list of scopes to be made available for this service account.
6329 &quot;A String&quot;,
6330 ],
6331 },
6332 ],
6333 &quot;shieldedInstanceConfig&quot;: { # A set of Shielded Instance options.
6334 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.
6335 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.
6336 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.
6337 },
6338 &quot;shieldedInstanceIntegrityPolicy&quot;: { # The policy describes the baseline against which Instance boot integrity is measured.
6339 &quot;updateAutoLearnPolicy&quot;: True or False, # Updates the integrity policy baseline using the measurements from the VM instance&#x27;s most recent boot.
6340 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]6341 &quot;shieldedVmConfig&quot;: { # A set of Shielded VM options. # Deprecating, please use shielded_instance_config.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6342 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.
6343 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.
6344 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.
6345 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]6346 &quot;shieldedVmIntegrityPolicy&quot;: { # The policy describes the baseline against which VM instance boot integrity is measured. # Deprecating, please use shielded_instance_integrity_policy.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6347 &quot;updateAutoLearnPolicy&quot;: True or False, # Updates the integrity policy baseline using the measurements from the VM instance&#x27;s most recent boot.
6348 },
6349 &quot;sourceMachineImage&quot;: &quot;A String&quot;, # Source machine image
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]6350 &quot;sourceMachineImageEncryptionKey&quot;: { # Source machine image encryption key when creating an instance from a machine image.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6351 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
6352 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
6353 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6354 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
6355 #
6356 # The key must meet the following requirements before you can provide it to Compute Engine:
6357 # - The key is wrapped using a RSA public key certificate provided by Google.
6358 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:
6359 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6360 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
6361 },
6362 &quot;startRestricted&quot;: True or False, # [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6363 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6364 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable explanation of the status.
6365 &quot;tags&quot;: { # A set of instance tags. # Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. Multiple tags can be specified via the &#x27;tags.items&#x27; field.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6366 &quot;fingerprint&quot;: &quot;A String&quot;, # Specifies a fingerprint for this request, which is essentially a hash of the tags&#x27; contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update tags. You must always provide an up-to-date fingerprint hash in order to update or change tags.
6367 #
6368 # To see the latest fingerprint, make get() request to the instance.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6369 &quot;items&quot;: [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
6370 &quot;A String&quot;,
6371 ],
6372 },
6373 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]6374}
6375
6376 minimalAction: string, Specifies the action to take when updating an instance even if the updated properties do not require it. If not specified, then Compute Engine acts based on the minimum action that the updated properties require.
6377 Allowed values
6378 INVALID -
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6379 NO_EFFECT -
6380 REFRESH -
6381 RESTART -
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6382 mostDisruptiveAllowedAction: string, Specifies the most disruptive action that can be taken on the instance as part of the update. Compute Engine returns an error if the instance properties require a more disruptive action as part of the instance update. Valid options from lowest to highest are NO_EFFECT, REFRESH, and RESTART.
6383 Allowed values
6384 INVALID -
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6385 NO_EFFECT -
6386 REFRESH -
6387 RESTART -
6388 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
6389
6390For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
6391
6392The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]6393
6394Returns:
6395 An object of the form:
6396
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6397 { # Represents an Operation resource.
6398 #
6399 # Google Compute Engine has three Operation resources:
6400 #
6401 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
6402 #
6403 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
6404 #
6405 # Operations can be global, regional or zonal.
6406 # - For global operations, use the `globalOperations` resource.
6407 # - For regional operations, use the `regionOperations` resource.
6408 # - For zonal operations, use the `zonalOperations` resource.
6409 #
6410 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]6411 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
6412 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
6413 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
6414 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
6415 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
6416 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6417 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]6418 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
6419 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
6420 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6421 },
6422 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]6423 },
6424 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
6425 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
6426 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
6427 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
6428 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
6429 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]6430 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]6431 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
6432 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
6433 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
6434 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
6435 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
6436 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
6437 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
6438 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
6439 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
6440 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
6441 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
6442 {
6443 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6444 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
6445 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]6446 {
6447 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
6448 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
6449 },
6450 ],
6451 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
6452 },
6453 ],
6454 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
6455}</pre>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]6456</div>
6457
6458<div class="method">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6459 <code class="details" id="updateAccessConfig">updateAccessConfig(project, zone, instance, networkInterface, body=None, requestId=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6460 <pre>Updates the specified access config from an instance&#x27;s network interface with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6461
6462Args:
6463 project: string, Project ID for this request. (required)
6464 zone: string, The name of the zone for this request. (required)
6465 instance: string, The instance name for this request. (required)
6466 networkInterface: string, The name of the network interface where the access config is attached. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]6467 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6468 The object takes the form of:
6469
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6470{ # An access configuration attached to an instance&#x27;s network interface. Only one access config per instance is supported.
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700[diff] [blame]6471 &quot;externalIpv6&quot;: &quot;A String&quot;, # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.
6472 &quot;externalIpv6PrefixLength&quot;: 42, # [Output Only] The prefix length of the external IPv6 range.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6473 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
6474 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access.
6475 &quot;natIP&quot;: &quot;A String&quot;, # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6476 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.
6477 #
6478 # If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.
6479 #
6480 # If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6481 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.
6482 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the external IP address of the instance to a DNS domain name.
6483 &quot;type&quot;: &quot;ONE_TO_ONE_NAT&quot;, # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6484}
6485
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6486 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
6487
6488For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
6489
6490The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6491
6492Returns:
6493 An object of the form:
6494
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6495 { # Represents an Operation resource.
6496 #
6497 # Google Compute Engine has three Operation resources:
6498 #
6499 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
6500 #
6501 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
6502 #
6503 # Operations can be global, regional or zonal.
6504 # - For global operations, use the `globalOperations` resource.
6505 # - For regional operations, use the `regionOperations` resource.
6506 # - For zonal operations, use the `zonalOperations` resource.
6507 #
6508 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]6509 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
6510 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
6511 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
6512 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
6513 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
6514 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6515 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]6516 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
6517 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
6518 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6519 },
6520 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]6521 },
6522 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
6523 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
6524 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
6525 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
6526 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
6527 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]6528 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]6529 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
6530 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
6531 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
6532 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
6533 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
6534 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
6535 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
6536 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
6537 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
6538 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
6539 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
6540 {
6541 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6542 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
6543 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]6544 {
6545 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
6546 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
6547 },
6548 ],
6549 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
6550 },
6551 ],
6552 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
6553}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6554</div>
6555
6556<div class="method">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6557 <code class="details" id="updateDisplayDevice">updateDisplayDevice(project, zone, instance, body=None, requestId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6558 <pre>Updates the Display config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
6559
6560Args:
6561 project: string, Project ID for this request. (required)
6562 zone: string, The name of the zone for this request. (required)
6563 instance: string, Name of the instance scoping this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]6564 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6565 The object takes the form of:
6566
6567{ # A set of Display Device options
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6568 &quot;enableDisplay&quot;: True or False, # Defines whether the instance has Display enabled.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6569}
6570
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6571 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
6572
6573For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
6574
6575The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6576
6577Returns:
6578 An object of the form:
6579
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6580 { # Represents an Operation resource.
6581 #
6582 # Google Compute Engine has three Operation resources:
6583 #
6584 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
6585 #
6586 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
6587 #
6588 # Operations can be global, regional or zonal.
6589 # - For global operations, use the `globalOperations` resource.
6590 # - For regional operations, use the `regionOperations` resource.
6591 # - For zonal operations, use the `zonalOperations` resource.
6592 #
6593 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]6594 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
6595 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
6596 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
6597 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
6598 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
6599 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6600 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]6601 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
6602 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
6603 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6604 },
6605 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]6606 },
6607 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
6608 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
6609 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
6610 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
6611 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
6612 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]6613 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]6614 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
6615 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
6616 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
6617 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
6618 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
6619 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
6620 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
6621 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
6622 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
6623 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
6624 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
6625 {
6626 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6627 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
6628 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]6629 {
6630 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
6631 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
6632 },
6633 ],
6634 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
6635 },
6636 ],
6637 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
6638}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6639</div>
6640
6641<div class="method">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6642 <code class="details" id="updateNetworkInterface">updateNetworkInterface(project, zone, instance, networkInterface, body=None, requestId=None)</code>
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]6643 <pre>Updates an instance&#x27;s network interface. This method can only update an interface&#x27;s alias IP range and attached network. See Modifying alias IP ranges for an existing instance for instructions on changing alias IP ranges. See Migrating a VM between networks for instructions on migrating an interface. This method follows PATCH semantics.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6644
6645Args:
6646 project: string, Project ID for this request. (required)
6647 zone: string, The name of the zone for this request. (required)
6648 instance: string, The instance name for this request. (required)
6649 networkInterface: string, The name of the network interface to update. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]6650 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6651 The object takes the form of:
6652
6653{ # A network interface resource attached to an instance.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6654 &quot;accessConfigs&quot;: [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.
6655 { # An access configuration attached to an instance&#x27;s network interface. Only one access config per instance is supported.
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700[diff] [blame]6656 &quot;externalIpv6&quot;: &quot;A String&quot;, # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.
6657 &quot;externalIpv6PrefixLength&quot;: 42, # [Output Only] The prefix length of the external IPv6 range.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6658 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
6659 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access.
6660 &quot;natIP&quot;: &quot;A String&quot;, # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6661 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.
6662 #
6663 # If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.
6664 #
6665 # If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6666 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.
6667 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the external IP address of the instance to a DNS domain name.
6668 &quot;type&quot;: &quot;ONE_TO_ONE_NAT&quot;, # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6669 },
6670 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6671 &quot;aliasIpRanges&quot;: [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.
6672 { # An alias IP range attached to an instance&#x27;s network interface.
6673 &quot;ipCidrRange&quot;: &quot;A String&quot;, # The IP alias ranges to allocate for this interface. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (such as 10.2.3.4), a netmask (such as /24) or a CIDR-formatted string (such as 10.1.2.0/24).
6674 &quot;subnetworkRangeName&quot;: &quot;A String&quot;, # The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used.
6675 },
6676 ],
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]6677 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700[diff] [blame]6678 &quot;ipv6AccessConfigs&quot;: [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access.
6679 { # An access configuration attached to an instance&#x27;s network interface. Only one access config per instance is supported.
6680 &quot;externalIpv6&quot;: &quot;A String&quot;, # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.
6681 &quot;externalIpv6PrefixLength&quot;: 42, # [Output Only] The prefix length of the external IPv6 range.
6682 &quot;kind&quot;: &quot;compute#accessConfig&quot;, # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
6683 &quot;name&quot;: &quot;A String&quot;, # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access.
6684 &quot;natIP&quot;: &quot;A String&quot;, # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6685 &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.
6686 #
6687 # If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.
6688 #
6689 # If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700[diff] [blame]6690 &quot;publicPtrDomainName&quot;: &quot;A String&quot;, # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.
6691 &quot;setPublicPtr&quot;: True or False, # Specifies whether a public DNS &#x27;PTR&#x27; record should be created to map the external IP address of the instance to a DNS domain name.
6692 &quot;type&quot;: &quot;ONE_TO_ONE_NAT&quot;, # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
6693 },
6694 ],
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6695 &quot;ipv6AccessType&quot;: &quot;A String&quot;, # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork.
6696 #
6697 # Valid only if stackType is IPV4_IPV6.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6698 &quot;ipv6Address&quot;: &quot;A String&quot;, # [Output Only] An IPv6 internal network address for this network interface.
6699 &quot;kind&quot;: &quot;compute#networkInterface&quot;, # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.
6700 &quot;name&quot;: &quot;A String&quot;, # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6701 &quot;network&quot;: &quot;A String&quot;, # URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred.
6702 #
6703 # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
6704 # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
6705 # - projects/project/global/networks/network
6706 # - global/networks/default
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6707 &quot;networkIP&quot;: &quot;A String&quot;, # An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]6708 &quot;nicType&quot;: &quot;A String&quot;, # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6709 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for this network interface to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used.
6710 #
6711 # This field can be both set at instance creation and update network interface operations.
6712 &quot;subnetwork&quot;: &quot;A String&quot;, # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
6713 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
6714 # - regions/region/subnetworks/subnetwork
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6715}
6716
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6717 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
6718
6719For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
6720
6721The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6722
6723Returns:
6724 An object of the form:
6725
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6726 { # Represents an Operation resource.
6727 #
6728 # Google Compute Engine has three Operation resources:
6729 #
6730 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
6731 #
6732 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
6733 #
6734 # Operations can be global, regional or zonal.
6735 # - For global operations, use the `globalOperations` resource.
6736 # - For regional operations, use the `regionOperations` resource.
6737 # - For zonal operations, use the `zonalOperations` resource.
6738 #
6739 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]6740 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
6741 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
6742 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
6743 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
6744 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
6745 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6746 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]6747 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
6748 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
6749 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6750 },
6751 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]6752 },
6753 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
6754 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
6755 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
6756 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
6757 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
6758 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]6759 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]6760 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
6761 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
6762 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
6763 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
6764 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
6765 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
6766 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
6767 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
6768 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
6769 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
6770 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
6771 {
6772 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6773 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
6774 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]6775 {
6776 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
6777 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
6778 },
6779 ],
6780 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
6781 },
6782 ],
6783 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
6784}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6785</div>
6786
6787<div class="method">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6788 <code class="details" id="updateShieldedInstanceConfig">updateShieldedInstanceConfig(project, zone, instance, body=None, requestId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6789 <pre>Updates the Shielded Instance config for an instance. You can only use this method on a stopped instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
6790
6791Args:
6792 project: string, Project ID for this request. (required)
6793 zone: string, The name of the zone for this request. (required)
6794 instance: string, Name or id of the instance scoping this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]6795 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6796 The object takes the form of:
6797
6798{ # A set of Shielded Instance options.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6799 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.
6800 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.
6801 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6802}
6803
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6804 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
6805
6806For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
6807
6808The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6809
6810Returns:
6811 An object of the form:
6812
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6813 { # Represents an Operation resource.
6814 #
6815 # Google Compute Engine has three Operation resources:
6816 #
6817 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
6818 #
6819 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
6820 #
6821 # Operations can be global, regional or zonal.
6822 # - For global operations, use the `globalOperations` resource.
6823 # - For regional operations, use the `regionOperations` resource.
6824 # - For zonal operations, use the `zonalOperations` resource.
6825 #
6826 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]6827 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
6828 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
6829 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
6830 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
6831 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
6832 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6833 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]6834 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
6835 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
6836 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6837 },
6838 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]6839 },
6840 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
6841 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
6842 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
6843 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
6844 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
6845 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]6846 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]6847 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
6848 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
6849 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
6850 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
6851 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
6852 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
6853 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
6854 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
6855 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
6856 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
6857 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
6858 {
6859 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6860 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
6861 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]6862 {
6863 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
6864 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
6865 },
6866 ],
6867 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
6868 },
6869 ],
6870 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
6871}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6872</div>
6873
6874<div class="method">
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6875 <code class="details" id="updateShieldedVmConfig">updateShieldedVmConfig(project, zone, instance, body=None, requestId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6876 <pre>Updates the Shielded VM config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
6877
6878Args:
6879 project: string, Project ID for this request. (required)
6880 zone: string, The name of the zone for this request. (required)
6881 instance: string, Name of the instance scoping this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]6882 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6883 The object takes the form of:
6884
6885{ # A set of Shielded VM options.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6886 &quot;enableIntegrityMonitoring&quot;: True or False, # Defines whether the instance has integrity monitoring enabled.
6887 &quot;enableSecureBoot&quot;: True or False, # Defines whether the instance has Secure Boot enabled.
6888 &quot;enableVtpm&quot;: True or False, # Defines whether the instance has the vTPM enabled.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6889}
6890
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6891 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
6892
6893For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
6894
6895The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6896
6897Returns:
6898 An object of the form:
6899
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6900 { # Represents an Operation resource.
6901 #
6902 # Google Compute Engine has three Operation resources:
6903 #
6904 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
6905 #
6906 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
6907 #
6908 # Operations can be global, regional or zonal.
6909 # - For global operations, use the `globalOperations` resource.
6910 # - For regional operations, use the `regionOperations` resource.
6911 # - For zonal operations, use the `zonalOperations` resource.
6912 #
6913 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]6914 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
6915 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
6916 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
6917 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
6918 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
6919 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6920 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]6921 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
6922 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
6923 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]6924 },
6925 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]6926 },
6927 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
6928 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
6929 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
6930 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
6931 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
6932 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]6933 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]6934 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
6935 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
6936 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
6937 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
6938 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
6939 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
6940 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
6941 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
6942 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
6943 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
6944 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
6945 {
6946 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-botc3f86752021-06-12 00:20:02 -0700[diff] [blame^]6947 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
6948 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]6949 {
6950 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
6951 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
6952 },
6953 ],
6954 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
6955 },
6956 ],
6957 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
6958}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6959</div>
6960
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]6961</body></html>