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"> 78 <code><a href="#addAccessConfig">addAccessConfig(project, zone, instance, networkInterface, body=None, requestId=None, x__xgafv=None)</a></code></p> 79<p class="firstline">Adds an access config to an instance's network interface.</p> 80<p class="toc_element"> 81 <code><a href="#addResourcePolicies">addResourcePolicies(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p> 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"> 84 <code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Retrieves an aggregated list of all of the instances in your project across all regions and zones. The performance of this method degrades when a filter is specified on a project that has a very large number of instances.</p> 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"> 90 <code><a href="#attachDisk">attachDisk(project, zone, instance, body=None, forceAttach=None, requestId=None, x__xgafv=None)</a></code></p> 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> 92<p class="toc_element"> 93 <code><a href="#bulkInsert">bulkInsert(project, zone, body=None, requestId=None, x__xgafv=None)</a></code></p> 94<p class="firstline">Creates multiple instances. Count specifies the number of instances to create.</p> 95<p class="toc_element"> 96 <code><a href="#close">close()</a></code></p> 97<p class="firstline">Close httplib2 connections.</p> 98<p class="toc_element"> 99 <code><a href="#delete">delete(project, zone, instance, requestId=None, x__xgafv=None)</a></code></p> 100<p class="firstline">Deletes the specified Instance resource. For more information, see Deleting an instance.</p> 101<p class="toc_element"> 102 <code><a href="#deleteAccessConfig">deleteAccessConfig(project, zone, instance, accessConfig, networkInterface, requestId=None, x__xgafv=None)</a></code></p> 103<p class="firstline">Deletes an access config from an instance's network interface.</p> 104<p class="toc_element"> 105 <code><a href="#detachDisk">detachDisk(project, zone, instance, deviceName, requestId=None, x__xgafv=None)</a></code></p> 106<p class="firstline">Detaches a disk from an instance.</p> 107<p class="toc_element"> 108 <code><a href="#get">get(project, zone, instance, x__xgafv=None)</a></code></p> 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"> 111 <code><a href="#getEffectiveFirewalls">getEffectiveFirewalls(project, zone, instance, networkInterface, x__xgafv=None)</a></code></p> 112<p class="firstline">Returns effective firewalls applied to an interface of the instance.</p> 113<p class="toc_element"> 114 <code><a href="#getGuestAttributes">getGuestAttributes(project, zone, instance, queryPath=None, variableKey=None, x__xgafv=None)</a></code></p> 115<p class="firstline">Returns the specified guest attributes entry.</p> 116<p class="toc_element"> 117 <code><a href="#getIamPolicy">getIamPolicy(project, zone, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</a></code></p> 118<p class="firstline">Gets the access control policy for a resource. May be empty if no such policy or resource exists.</p> 119<p class="toc_element"> 120 <code><a href="#getScreenshot">getScreenshot(project, zone, instance, x__xgafv=None)</a></code></p> 121<p class="firstline">Returns the screenshot from the specified instance.</p> 122<p class="toc_element"> 123 <code><a href="#getSerialPortOutput">getSerialPortOutput(project, zone, instance, port=None, start=None, x__xgafv=None)</a></code></p> 124<p class="firstline">Returns the last 1 MB of serial port output from the specified instance.</p> 125<p class="toc_element"> 126 <code><a href="#getShieldedInstanceIdentity">getShieldedInstanceIdentity(project, zone, instance, x__xgafv=None)</a></code></p> 127<p class="firstline">Returns the Shielded Instance Identity of an instance</p> 128<p class="toc_element"> 129 <code><a href="#getShieldedVmIdentity">getShieldedVmIdentity(project, zone, instance, x__xgafv=None)</a></code></p> 130<p class="firstline">Returns the Shielded VM Identity of an instance</p> 131<p class="toc_element"> 132 <code><a href="#insert">insert(project, zone, body=None, requestId=None, sourceInstanceTemplate=None, sourceMachineImage=None, x__xgafv=None)</a></code></p> 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"> 135 <code><a href="#list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> 136<p class="firstline">Retrieves the list of instances contained within the specified zone.</p> 137<p class="toc_element"> 138 <code><a href="#listReferrers">listReferrers(project, zone, instance, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> 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> 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"> 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"> 147 <code><a href="#removeResourcePolicies">removeResourcePolicies(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p> 148<p class="firstline">Removes resource policies from an instance.</p> 149<p class="toc_element"> 150 <code><a href="#reset">reset(project, zone, instance, requestId=None, x__xgafv=None)</a></code></p> 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> 152<p class="toc_element"> 153 <code><a href="#resume">resume(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p> 154<p class="firstline">Resumes an instance that was suspended using the instances().suspend method.</p> 155<p class="toc_element"> 156 <code><a href="#sendDiagnosticInterrupt">sendDiagnosticInterrupt(project, zone, instance, x__xgafv=None)</a></code></p> 157<p class="firstline">Sends diagnostic interrupt to the instance.</p> 158<p class="toc_element"> 159 <code><a href="#setDeletionProtection">setDeletionProtection(project, zone, resource, deletionProtection=None, requestId=None, x__xgafv=None)</a></code></p> 160<p class="firstline">Sets deletion protection on the instance.</p> 161<p class="toc_element"> 162 <code><a href="#setDiskAutoDelete">setDiskAutoDelete(project, zone, instance, autoDelete, deviceName, requestId=None, x__xgafv=None)</a></code></p> 163<p class="firstline">Sets the auto-delete flag for a disk attached to an instance.</p> 164<p class="toc_element"> 165 <code><a href="#setIamPolicy">setIamPolicy(project, zone, resource, body=None, x__xgafv=None)</a></code></p> 166<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p> 167<p class="toc_element"> 168 <code><a href="#setLabels">setLabels(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p> 169<p class="firstline">Sets labels on an instance. To learn more about labels, read the Labeling Resources documentation.</p> 170<p class="toc_element"> 171 <code><a href="#setMachineResources">setMachineResources(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p> 172<p class="firstline">Changes the number and/or type of accelerator for a stopped instance to the values specified in the request.</p> 173<p class="toc_element"> 174 <code><a href="#setMachineType">setMachineType(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p> 175<p class="firstline">Changes the machine type for a stopped instance to the machine type specified in the request.</p> 176<p class="toc_element"> 177 <code><a href="#setMetadata">setMetadata(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p> 178<p class="firstline">Sets metadata for the specified instance to the data included in the request.</p> 179<p class="toc_element"> 180 <code><a href="#setMinCpuPlatform">setMinCpuPlatform(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p> 181<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> 182<p class="toc_element"> 183 <code><a href="#setName">setName(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p> 184<p class="firstline">Sets name of an instance.</p> 185<p class="toc_element"> 186 <code><a href="#setScheduling">setScheduling(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p> 187<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> 188<p class="toc_element"> 189 <code><a href="#setServiceAccount">setServiceAccount(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p> 190<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> 191<p class="toc_element"> 192 <code><a href="#setShieldedInstanceIntegrityPolicy">setShieldedInstanceIntegrityPolicy(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p> 193<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> 194<p class="toc_element"> 195 <code><a href="#setShieldedVmIntegrityPolicy">setShieldedVmIntegrityPolicy(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p> 196<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> 197<p class="toc_element"> 198 <code><a href="#setTags">setTags(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p> 199<p class="firstline">Sets network tags for the specified instance to the data included in the request.</p> 200<p class="toc_element"> 201 <code><a href="#simulateMaintenanceEvent">simulateMaintenanceEvent(project, zone, instance, x__xgafv=None)</a></code></p> 202<p class="firstline">Simulates a maintenance event on the instance.</p> 203<p class="toc_element"> 204 <code><a href="#start">start(project, zone, instance, requestId=None, x__xgafv=None)</a></code></p> 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"> 207 <code><a href="#startWithEncryptionKey">startWithEncryptionKey(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p> 208<p class="firstline">Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance.</p> 209<p class="toc_element"> 210 <code><a href="#stop">stop(project, zone, instance, requestId=None, x__xgafv=None)</a></code></p> 211<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> 212<p class="toc_element"> 213 <code><a href="#suspend">suspend(project, zone, instance, discardLocalSsd=None, requestId=None, x__xgafv=None)</a></code></p> 214<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. For more information, see Suspending and resuming an instance.</p> 215<p class="toc_element"> 216 <code><a href="#testIamPermissions">testIamPermissions(project, zone, resource, body=None, x__xgafv=None)</a></code></p> 217<p class="firstline">Returns permissions that a caller has on the specified resource.</p> 218<p class="toc_element"> 219 <code><a href="#update">update(project, zone, instance, body=None, minimalAction=None, mostDisruptiveAllowedAction=None, requestId=None, x__xgafv=None)</a></code></p> 220<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> 221<p class="toc_element"> 222 <code><a href="#updateAccessConfig">updateAccessConfig(project, zone, instance, networkInterface, body=None, requestId=None, x__xgafv=None)</a></code></p> 223<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> 224<p class="toc_element"> 225 <code><a href="#updateDisplayDevice">updateDisplayDevice(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p> 226<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> 227<p class="toc_element"> 228 <code><a href="#updateNetworkInterface">updateNetworkInterface(project, zone, instance, networkInterface, body=None, requestId=None, x__xgafv=None)</a></code></p> 229<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> 230<p class="toc_element"> 231 <code><a href="#updateShieldedInstanceConfig">updateShieldedInstanceConfig(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p> 232<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> 233<p class="toc_element"> 234 <code><a href="#updateShieldedVmConfig">updateShieldedVmConfig(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p> 235<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> 236<h3>Method Details</h3> 237<div class="method"> 238 <code class="details" id="addAccessConfig">addAccessConfig(project, zone, instance, networkInterface, body=None, requestId=None, x__xgafv=None)</code> 239 <pre>Adds an access config to an instance's network interface. 240 241Args: 242 project: string, Project ID for this request. (required) 243 zone: string, The name of the zone for this request. (required) 244 instance: string, The instance name for this request. (required) 245 networkInterface: string, The name of the network interface to add to this instance. (required) 246 body: object, The request body. 247 The object takes the form of: 248 249{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported. 250 "externalIpv6": "A String", # 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. 251 "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. 252 "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. 253 "name": "A String", # 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. 254 "natIP": "A String", # 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. 255 "networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. 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. 256 "publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled in accessConfig. If this field is unspecified in ipv6AccessConfig, a default PTR record will be createc for first IP in associated external IPv6 range. 257 "setPublicPtr": True or False, # Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. This field is not used in ipv6AccessConfig. A default PTR record will be created if the VM has external IPv6 range associated. 258 "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT. 259} 260 261 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 262 x__xgafv: string, V1 error format. 263 Allowed values 264 1 - v1 error format 265 2 - v2 error format 266 267Returns: 268 An object of the form: 269 270 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 271 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 272 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 273 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 274 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 275 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 276 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 277 { 278 "code": "A String", # [Output Only] The error type identifier for this error. 279 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 280 "message": "A String", # [Output Only] An optional, human-readable error message. 281 }, 282 ], 283 }, 284 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 285 "httpErrorStatusCode": 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. 286 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 287 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 288 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 289 "name": "A String", # [Output Only] Name of the operation. 290 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 291 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 292 "progress": 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. 293 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 294 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 295 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 296 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 297 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 298 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 299 "targetLink": "A String", # [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. 300 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 301 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 302 { 303 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 304 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 305 { 306 "key": "A String", # [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). 307 "value": "A String", # [Output Only] A warning data value corresponding to the key. 308 }, 309 ], 310 "message": "A String", # [Output Only] A human-readable description of the warning code. 311 }, 312 ], 313 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 314}</pre> 315</div> 316 317<div class="method"> 318 <code class="details" id="addResourcePolicies">addResourcePolicies(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code> 319 <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. 320 321Args: 322 project: string, Project ID for this request. (required) 323 zone: string, The name of the zone for this request. (required) 324 instance: string, The instance name for this request. (required) 325 body: object, The request body. 326 The object takes the form of: 327 328{ 329 "resourcePolicies": [ # Resource policies to be added to this instance. 330 "A String", 331 ], 332} 333 334 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 335 x__xgafv: string, V1 error format. 336 Allowed values 337 1 - v1 error format 338 2 - v2 error format 339 340Returns: 341 An object of the form: 342 343 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 344 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 345 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 346 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 347 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 348 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 349 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 350 { 351 "code": "A String", # [Output Only] The error type identifier for this error. 352 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 353 "message": "A String", # [Output Only] An optional, human-readable error message. 354 }, 355 ], 356 }, 357 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 358 "httpErrorStatusCode": 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. 359 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 360 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 361 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 362 "name": "A String", # [Output Only] Name of the operation. 363 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 364 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 365 "progress": 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. 366 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 367 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 368 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 369 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 370 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 371 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 372 "targetLink": "A String", # [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. 373 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 374 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 375 { 376 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 377 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 378 { 379 "key": "A String", # [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). 380 "value": "A String", # [Output Only] A warning data value corresponding to the key. 381 }, 382 ], 383 "message": "A String", # [Output Only] A human-readable description of the warning code. 384 }, 385 ], 386 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 387}</pre> 388</div> 389 390<div class="method"> 391 <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 392 <pre>Retrieves an aggregated list of all of the instances in your project across all regions and zones. The performance of this method degrades when a filter is specified on a project that has a very large number of instances. 393 394Args: 395 project: string, Project ID for this request. (required) 396 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You 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. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` 397 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. 398 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`) 399 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. 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. Currently, only sorting by `name` or `creationTimestamp desc` is supported. 400 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. 401 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 402 x__xgafv: string, V1 error format. 403 Allowed values 404 1 - v1 error format 405 2 - v2 error format 406 407Returns: 408 An object of the form: 409 410 { 411 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 412 "items": { # An object that contains a list of instances scoped by zone. 413 "a_key": { # [Output Only] Name of the scope containing this set of instances. 414 "instances": [ # [Output Only] A list of instances contained in this scope. 415 { # Represents an Instance resource. An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. 416 "advancedMachineFeatures": { # 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. 417 "enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false). 418 "threadsPerCore": 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. 419 }, 420 "canIpForward": 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 . 421 "confidentialInstanceConfig": { # A set of Confidential Instance options. 422 "enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled. 423 }, 424 "cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance. 425 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 426 "deletionProtection": True or False, # Whether the resource should be protected against deletion. 427 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 428 "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them. 429 { # An instance-attached disk resource. 430 "autoDelete": 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). 431 "boot": 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. 432 "deviceName": "A String", # 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. 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. 433 "diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key. 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. 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. 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. Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group. 434 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key 435 "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ 436 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" 437 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 438 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 439 }, 440 "diskSizeGb": "A String", # The size of the disk in GB. 441 "guestOsFeatures": [ # 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. 442 { # Guest OS features. 443 "type": "A String", # The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - SECURE_BOOT - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE For more information, see Enabling guest operating system features. 444 }, 445 ], 446 "index": 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. 447 "initializeParams": { # [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. This property is mutually exclusive with the source property; you can only define one or the other, but not both. # [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. This property is mutually exclusive with the source property; you can only define one or the other, but not both. 448 "description": "A String", # An optional description. Provide this property when creating the disk. 449 "diskName": "A String", # 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. 450 "diskSizeGb": "A String", # 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. 451 "diskType": "A String", # 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: https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you define this field, you can provide either the full or partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL. 452 "guestOsFeatures": [ # 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. Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures 453 { # Guest OS features. 454 "type": "A String", # The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - SECURE_BOOT - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE For more information, see Enabling guest operating system features. 455 }, 456 ], 457 "labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. 458 "a_key": "A String", 459 }, 460 "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. 461 "A String", 462 ], 463 "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance. 464 "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk. 465 "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation. 466 "resourcePolicies": [ # 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. 467 "A String", 468 ], 469 "sourceImage": "A String", # 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. 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: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image 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: global/images/family/my-image-family If the source image is deleted later, this field will not be set. 470 "sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. 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. 471 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key 472 "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ 473 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" 474 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 475 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 476 }, 477 "sourceSnapshot": "A String", # 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. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set. 478 "sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot. 479 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key 480 "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ 481 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" 482 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 483 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 484 }, 485 }, 486 "interface": "A String", # 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. 487 "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks. 488 "licenses": [ # [Output Only] Any valid publicly visible licenses. 489 "A String", 490 ], 491 "locked": True or False, # [Output Only] Whether to indicate the attached disk is locked. The locked disk is not allowed to be detached from the instance, or to be used as the source of the snapshot creation, and the image creation. The instance with at least one locked attached disk is not allow to be used as source of machine image creation, instant snapshot creation, and not allowed to be deleted with --keep-disk parameter set to true for locked disks. 492 "mode": "A String", # 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. 493 "shieldedInstanceInitialState": { # 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 494 "dbs": [ # The Key Database (db). 495 { 496 "content": "A String", # The raw content in the secure keys file. 497 "fileType": "A String", # The file type of source file. 498 }, 499 ], 500 "dbxs": [ # The forbidden key database (dbx). 501 { 502 "content": "A String", # The raw content in the secure keys file. 503 "fileType": "A String", # The file type of source file. 504 }, 505 ], 506 "keks": [ # The Key Exchange Key (KEK). 507 { 508 "content": "A String", # The raw content in the secure keys file. 509 "fileType": "A String", # The file type of source file. 510 }, 511 ], 512 "pk": { # The Platform Key (PK). 513 "content": "A String", # The raw content in the secure keys file. 514 "fileType": "A String", # The file type of source file. 515 }, 516 }, 517 "source": "A String", # 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. If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. Note that for InstanceTemplate, specify the disk name for zonal disk, and the URL for regional disk. 518 "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. 519 "userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of URLs to the license resource. Unlike regular licenses, user provided licenses can be modified after the disk is created. 520 "A String", 521 ], 522 }, 523 ], 524 "displayDevice": { # A set of Display Device options # Enables display device for the instance. 525 "enableDisplay": True or False, # Defines whether the instance has Display enabled. 526 }, 527 "eraseWindowsVssSignature": True or False, # Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature. 528 "fingerprint": "A String", # Specifies a fingerprint for this resource, which is essentially a hash of the instance'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. To see the latest fingerprint, make get() request to the instance. 529 "guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance. 530 { # A specification of the type and number of accelerator cards attached to the instance. 531 "acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance. 532 "acceleratorType": "A String", # 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. 533 }, 534 ], 535 "hostname": "A String", # 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. 536 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 537 "kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances. 538 "labelFingerprint": "A String", # A fingerprint for this request, which is essentially a hash of the label'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. To see the latest fingerprint, make get() request to the instance. 539 "labels": { # Labels to apply to this instance. These can be later modified by the setLabels method. 540 "a_key": "A String", 541 }, 542 "lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format. 543 "lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format. 544 "lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format. 545 "machineType": "A String", # 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: zones/us-central1-f/machineTypes/n1-standard-1 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): zones/zone/machineTypes/custom-CPUS-MEMORY For example: zones/us-central1-f/machineTypes/custom-4-5120 For a full list of restrictions, read the Specifications for custom machine types. 546 "metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys. 547 "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata'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. To see the latest fingerprint, make a get() request to retrieve the resource. 548 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB. 549 { # Metadata 550 "key": "A String", # 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. 551 "value": "A String", # 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). 552 }, 553 ], 554 "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata. 555 }, 556 "minCpuPlatform": "A String", # Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge". 557 "name": "A String", # 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. 558 "networkInterfaces": [ # 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. 559 { # A network interface resource attached to an instance. 560 "accessConfigs": [ # 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. 561 { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. 562 "externalIpv6": "A String", # 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. 563 "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. 564 "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. 565 "name": "A String", # 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. 566 "natIP": "A String", # 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. 567 "networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. 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. 568 "publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled in accessConfig. If this field is unspecified in ipv6AccessConfig, a default PTR record will be createc for first IP in associated external IPv6 range. 569 "setPublicPtr": True or False, # Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. This field is not used in ipv6AccessConfig. A default PTR record will be created if the VM has external IPv6 range associated. 570 "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT. 571 }, 572 ], 573 "aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks. 574 { # An alias IP range attached to an instance's network interface. 575 "ipCidrRange": "A String", # 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). 576 "subnetworkRangeName": "A String", # 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. 577 }, 578 ], 579 "fingerprint": "A String", # 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. 580 "ipv6AccessConfigs": [ # 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. 581 { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. 582 "externalIpv6": "A String", # 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. 583 "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. 584 "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. 585 "name": "A String", # 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. 586 "natIP": "A String", # 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. 587 "networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. 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. 588 "publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled in accessConfig. If this field is unspecified in ipv6AccessConfig, a default PTR record will be createc for first IP in associated external IPv6 range. 589 "setPublicPtr": True or False, # Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. This field is not used in ipv6AccessConfig. A default PTR record will be created if the VM has external IPv6 range associated. 590 "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT. 591 }, 592 ], 593 "ipv6AccessType": "A String", # [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. Valid only if stackType is IPV4_IPV6. 594 "ipv6Address": "A String", # An IPv6 internal network address for this network interface. 595 "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. 596 "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. 597 "network": "A String", # URL of the VPC 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 selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default 598 "networkIP": "A String", # 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. 599 "nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. 600 "queueCount": 42, # The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users. 601 "stackType": "A String", # 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. This field can be both set at instance creation and update network interface operations. 602 "subnetwork": "A String", # 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: - https://www.googleapis.com/compute/v1/projects/project/regions/region /subnetworks/subnetwork - regions/region/subnetworks/subnetwork 603 }, 604 ], 605 "networkPerformanceConfig": { 606 "totalEgressBandwidthTier": "A String", 607 }, 608 "params": { # Additional instance params. # Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. 609 "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty. 610 "a_key": "A String", 611 }, 612 }, 613 "postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance. 614 "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default. 615 "reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from. 616 "consumeReservationType": "A String", # 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. 617 "key": "A String", # 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. 618 "values": [ # Corresponds to the label values of a reservation resource. This can be either a name to a reservation in the same project or "projects/different-project/reservations/some-reservation-name" to target a shared reservation in the same zone but in a different project. 619 "A String", 620 ], 621 }, 622 "resourcePolicies": [ # Resource policies applied to this instance. 623 "A String", 624 ], 625 "satisfiesPzs": True or False, # [Output Only] Reserved for future use. 626 "scheduling": { # Sets the scheduling options for an Instance. NextID: 21 # Sets the scheduling options for this instance. 627 "automaticRestart": 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. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. 628 "hostErrorTimeoutSeconds": 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. 629 "instanceTerminationAction": "A String", # Specifies the termination action for the instance. 630 "locationHint": "A String", # 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. 631 "maintenanceFreezeDurationHours": 42, # Specifies the number of hours after VM instance creation where the VM won't be scheduled for maintenance. 632 "maintenanceInterval": "A String", # For more information about maintenance intervals, see Setting maintenance intervals. 633 "minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. 634 "nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity. 635 { # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled. 636 "key": "A String", # Corresponds to the label key of Node resource. 637 "operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity. 638 "values": [ # Corresponds to the label values of Node resource. 639 "A String", 640 ], 641 }, 642 ], 643 "onHostMaintenance": "A String", # 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. 644 "preemptible": 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. 645 "provisioningModel": "A String", # Specifies the provisioning model of the instance. 646 }, 647 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 648 "serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. 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. 649 { # A service account. 650 "email": "A String", # Email address of the service account. 651 "scopes": [ # The list of scopes to be made available for this service account. 652 "A String", 653 ], 654 }, 655 ], 656 "shieldedInstanceConfig": { # A set of Shielded Instance options. 657 "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default. 658 "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default. 659 "enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default. 660 }, 661 "shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured. 662 "updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot. 663 }, 664 "shieldedVmConfig": { # A set of Shielded VM options. # Deprecating, please use shielded_instance_config. 665 "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. 666 "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. 667 "enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. 668 }, 669 "shieldedVmIntegrityPolicy": { # The policy describes the baseline against which VM instance boot integrity is measured. # Deprecating, please use shielded_instance_integrity_policy. 670 "updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot. 671 }, 672 "sourceMachineImage": "A String", # Source machine image 673 "sourceMachineImageEncryptionKey": { # Source machine image encryption key when creating an instance from a machine image. 674 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key 675 "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ 676 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" 677 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 678 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 679 }, 680 "startRestricted": True or False, # [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity. 681 "status": "A String", # [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. 682 "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status. 683 "tags": { # 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 'tags.items' field. 684 "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the tags' 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. To see the latest fingerprint, make get() request to the instance. 685 "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. 686 "A String", 687 ], 688 }, 689 "zone": "A String", # [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. 690 }, 691 ], 692 "warning": { # [Output Only] Informational warning which replaces the list of instances when the list is empty. 693 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 694 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 695 { 696 "key": "A String", # [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). 697 "value": "A String", # [Output Only] A warning data value corresponding to the key. 698 }, 699 ], 700 "message": "A String", # [Output Only] A human-readable description of the warning code. 701 }, 702 }, 703 }, 704 "kind": "compute#instanceAggregatedList", # [Output Only] Type of resource. Always compute#instanceAggregatedList for aggregated lists of Instance resources. 705 "nextPageToken": "A String", # [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. 706 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 707 "unreachables": [ # [Output Only] Unreachable resources. 708 "A String", 709 ], 710 "warning": { # [Output Only] Informational warning message. 711 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 712 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 713 { 714 "key": "A String", # [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). 715 "value": "A String", # [Output Only] A warning data value corresponding to the key. 716 }, 717 ], 718 "message": "A String", # [Output Only] A human-readable description of the warning code. 719 }, 720}</pre> 721</div> 722 723<div class="method"> 724 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code> 725 <pre>Retrieves the next page of results. 726 727Args: 728 previous_request: The request for the previous page. (required) 729 previous_response: The response from the request for the previous page. (required) 730 731Returns: 732 A request object that you can call 'execute()' on to request the next 733 page. Returns None if there are no more items in the collection. 734 </pre> 735</div> 736 737<div class="method"> 738 <code class="details" id="attachDisk">attachDisk(project, zone, instance, body=None, forceAttach=None, requestId=None, x__xgafv=None)</code> 739 <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. 740 741Args: 742 project: string, Project ID for this request. (required) 743 zone: string, The name of the zone for this request. (required) 744 instance: string, The instance name for this request. (required) 745 body: object, The request body. 746 The object takes the form of: 747 748{ # An instance-attached disk resource. 749 "autoDelete": 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). 750 "boot": 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. 751 "deviceName": "A String", # 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. 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. 752 "diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key. 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. 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. 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. Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group. 753 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key 754 "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ 755 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" 756 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 757 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 758 }, 759 "diskSizeGb": "A String", # The size of the disk in GB. 760 "guestOsFeatures": [ # 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. 761 { # Guest OS features. 762 "type": "A String", # The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - SECURE_BOOT - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE For more information, see Enabling guest operating system features. 763 }, 764 ], 765 "index": 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. 766 "initializeParams": { # [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. This property is mutually exclusive with the source property; you can only define one or the other, but not both. # [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. This property is mutually exclusive with the source property; you can only define one or the other, but not both. 767 "description": "A String", # An optional description. Provide this property when creating the disk. 768 "diskName": "A String", # 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. 769 "diskSizeGb": "A String", # 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. 770 "diskType": "A String", # 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: https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you define this field, you can provide either the full or partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL. 771 "guestOsFeatures": [ # 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. Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures 772 { # Guest OS features. 773 "type": "A String", # The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - SECURE_BOOT - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE For more information, see Enabling guest operating system features. 774 }, 775 ], 776 "labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. 777 "a_key": "A String", 778 }, 779 "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. 780 "A String", 781 ], 782 "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance. 783 "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk. 784 "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation. 785 "resourcePolicies": [ # 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. 786 "A String", 787 ], 788 "sourceImage": "A String", # 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. 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: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image 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: global/images/family/my-image-family If the source image is deleted later, this field will not be set. 789 "sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. 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. 790 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key 791 "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ 792 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" 793 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 794 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 795 }, 796 "sourceSnapshot": "A String", # 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. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set. 797 "sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot. 798 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key 799 "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ 800 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" 801 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 802 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 803 }, 804 }, 805 "interface": "A String", # 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. 806 "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks. 807 "licenses": [ # [Output Only] Any valid publicly visible licenses. 808 "A String", 809 ], 810 "locked": True or False, # [Output Only] Whether to indicate the attached disk is locked. The locked disk is not allowed to be detached from the instance, or to be used as the source of the snapshot creation, and the image creation. The instance with at least one locked attached disk is not allow to be used as source of machine image creation, instant snapshot creation, and not allowed to be deleted with --keep-disk parameter set to true for locked disks. 811 "mode": "A String", # 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. 812 "shieldedInstanceInitialState": { # 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 813 "dbs": [ # The Key Database (db). 814 { 815 "content": "A String", # The raw content in the secure keys file. 816 "fileType": "A String", # The file type of source file. 817 }, 818 ], 819 "dbxs": [ # The forbidden key database (dbx). 820 { 821 "content": "A String", # The raw content in the secure keys file. 822 "fileType": "A String", # The file type of source file. 823 }, 824 ], 825 "keks": [ # The Key Exchange Key (KEK). 826 { 827 "content": "A String", # The raw content in the secure keys file. 828 "fileType": "A String", # The file type of source file. 829 }, 830 ], 831 "pk": { # The Platform Key (PK). 832 "content": "A String", # The raw content in the secure keys file. 833 "fileType": "A String", # The file type of source file. 834 }, 835 }, 836 "source": "A String", # 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. If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. Note that for InstanceTemplate, specify the disk name for zonal disk, and the URL for regional disk. 837 "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. 838 "userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of URLs to the license resource. Unlike regular licenses, user provided licenses can be modified after the disk is created. 839 "A String", 840 ], 841} 842 843 forceAttach: boolean, Whether to force attach the regional disk even if it's currently attached to another instance. If you try to force attach a zonal disk to an instance, you will receive an error. 844 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 845 x__xgafv: string, V1 error format. 846 Allowed values 847 1 - v1 error format 848 2 - v2 error format 849 850Returns: 851 An object of the form: 852 853 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 854 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 855 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 856 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 857 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 858 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 859 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 860 { 861 "code": "A String", # [Output Only] The error type identifier for this error. 862 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 863 "message": "A String", # [Output Only] An optional, human-readable error message. 864 }, 865 ], 866 }, 867 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 868 "httpErrorStatusCode": 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. 869 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 870 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 871 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 872 "name": "A String", # [Output Only] Name of the operation. 873 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 874 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 875 "progress": 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. 876 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 877 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 878 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 879 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 880 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 881 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 882 "targetLink": "A String", # [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. 883 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 884 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 885 { 886 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 887 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 888 { 889 "key": "A String", # [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). 890 "value": "A String", # [Output Only] A warning data value corresponding to the key. 891 }, 892 ], 893 "message": "A String", # [Output Only] A human-readable description of the warning code. 894 }, 895 ], 896 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 897}</pre> 898</div> 899 900<div class="method"> 901 <code class="details" id="bulkInsert">bulkInsert(project, zone, body=None, requestId=None, x__xgafv=None)</code> 902 <pre>Creates multiple instances. Count specifies the number of instances to create. 903 904Args: 905 project: string, Project ID for this request. (required) 906 zone: string, The name of the zone for this request. (required) 907 body: object, The request body. 908 The object takes the form of: 909 910{ # A transient resource used in compute.instances.bulkInsert and compute.regionInstances.bulkInsert . This resource is not persisted anywhere, it is used only for processing the requests. 911 "count": "A String", # The maximum number of instances to create. 912 "instanceProperties": { # The instance properties defining the VM instances to be created. Required if sourceInstanceTemplate is not provided. 913 "advancedMachineFeatures": { # 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. Note that for MachineImage, this is not supported yet. 914 "enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false). 915 "threadsPerCore": 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. 916 }, 917 "canIpForward": 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. 918 "confidentialInstanceConfig": { # A set of Confidential Instance options. # Specifies the Confidential Instance options. Note that for MachineImage, this is not supported yet. 919 "enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled. 920 }, 921 "description": "A String", # An optional text description for the instances that are created from these properties. 922 "disks": [ # An array of disks that are associated with the instances that are created from these properties. 923 { # An instance-attached disk resource. 924 "autoDelete": 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). 925 "boot": 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. 926 "deviceName": "A String", # 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. 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. 927 "diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key. 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. 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. 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. Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group. 928 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key 929 "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ 930 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" 931 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 932 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 933 }, 934 "diskSizeGb": "A String", # The size of the disk in GB. 935 "guestOsFeatures": [ # 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 { # Guest OS features. 937 "type": "A String", # The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - SECURE_BOOT - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE For more information, see Enabling guest operating system features. 938 }, 939 ], 940 "index": 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. 941 "initializeParams": { # [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. This property is mutually exclusive with the source property; you can only define one or the other, but not both. # [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. This property is mutually exclusive with the source property; you can only define one or the other, but not both. 942 "description": "A String", # An optional description. Provide this property when creating the disk. 943 "diskName": "A String", # 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. 944 "diskSizeGb": "A String", # 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. 945 "diskType": "A String", # 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: https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you define this field, you can provide either the full or partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL. 946 "guestOsFeatures": [ # 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. Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures 947 { # Guest OS features. 948 "type": "A String", # The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - SECURE_BOOT - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE For more information, see Enabling guest operating system features. 949 }, 950 ], 951 "labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. 952 "a_key": "A String", 953 }, 954 "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. 955 "A String", 956 ], 957 "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance. 958 "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk. 959 "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation. 960 "resourcePolicies": [ # 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. 961 "A String", 962 ], 963 "sourceImage": "A String", # 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. 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: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image 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: global/images/family/my-image-family If the source image is deleted later, this field will not be set. 964 "sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. 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. 965 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key 966 "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ 967 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" 968 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 969 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 970 }, 971 "sourceSnapshot": "A String", # 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. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set. 972 "sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot. 973 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key 974 "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ 975 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" 976 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 977 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 978 }, 979 }, 980 "interface": "A String", # 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. 981 "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks. 982 "licenses": [ # [Output Only] Any valid publicly visible licenses. 983 "A String", 984 ], 985 "locked": True or False, # [Output Only] Whether to indicate the attached disk is locked. The locked disk is not allowed to be detached from the instance, or to be used as the source of the snapshot creation, and the image creation. The instance with at least one locked attached disk is not allow to be used as source of machine image creation, instant snapshot creation, and not allowed to be deleted with --keep-disk parameter set to true for locked disks. 986 "mode": "A String", # 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. 987 "shieldedInstanceInitialState": { # 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 988 "dbs": [ # The Key Database (db). 989 { 990 "content": "A String", # The raw content in the secure keys file. 991 "fileType": "A String", # The file type of source file. 992 }, 993 ], 994 "dbxs": [ # The forbidden key database (dbx). 995 { 996 "content": "A String", # The raw content in the secure keys file. 997 "fileType": "A String", # The file type of source file. 998 }, 999 ], 1000 "keks": [ # The Key Exchange Key (KEK). 1001 { 1002 "content": "A String", # The raw content in the secure keys file. 1003 "fileType": "A String", # The file type of source file. 1004 }, 1005 ], 1006 "pk": { # The Platform Key (PK). 1007 "content": "A String", # The raw content in the secure keys file. 1008 "fileType": "A String", # The file type of source file. 1009 }, 1010 }, 1011 "source": "A String", # 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. If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. Note that for InstanceTemplate, specify the disk name for zonal disk, and the URL for regional disk. 1012 "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. 1013 "userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of URLs to the license resource. Unlike regular licenses, user provided licenses can be modified after the disk is created. 1014 "A String", 1015 ], 1016 }, 1017 ], 1018 "displayDevice": { # A set of Display Device options # Display Device properties to enable support for remote display products like: Teradici, VNC and TeamViewer Note that for MachineImage, this is not supported yet. 1019 "enableDisplay": True or False, # Defines whether the instance has Display enabled. 1020 }, 1021 "guestAccelerators": [ # A list of guest accelerator cards' type and count to use for instances created from these properties. 1022 { # A specification of the type and number of accelerator cards attached to the instance. 1023 "acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance. 1024 "acceleratorType": "A String", # 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. 1025 }, 1026 ], 1027 "labels": { # Labels to apply to instances that are created from these properties. 1028 "a_key": "A String", 1029 }, 1030 "machineType": "A String", # The machine type to use for instances that are created from these properties. 1031 "metadata": { # 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. 1032 "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata'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. To see the latest fingerprint, make a get() request to retrieve the resource. 1033 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB. 1034 { # Metadata 1035 "key": "A String", # 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. 1036 "value": "A String", # 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). 1037 }, 1038 ], 1039 "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata. 1040 }, 1041 "minCpuPlatform": "A String", # 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: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge". For more information, read Specifying a Minimum CPU Platform. 1042 "networkInterfaces": [ # An array of network access configurations for this interface. 1043 { # A network interface resource attached to an instance. 1044 "accessConfigs": [ # 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. 1045 { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. 1046 "externalIpv6": "A String", # 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. 1047 "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. 1048 "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. 1049 "name": "A String", # 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. 1050 "natIP": "A String", # 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. 1051 "networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. 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. 1052 "publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled in accessConfig. If this field is unspecified in ipv6AccessConfig, a default PTR record will be createc for first IP in associated external IPv6 range. 1053 "setPublicPtr": True or False, # Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. This field is not used in ipv6AccessConfig. A default PTR record will be created if the VM has external IPv6 range associated. 1054 "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT. 1055 }, 1056 ], 1057 "aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks. 1058 { # An alias IP range attached to an instance's network interface. 1059 "ipCidrRange": "A String", # 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). 1060 "subnetworkRangeName": "A String", # 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. 1061 }, 1062 ], 1063 "fingerprint": "A String", # 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. 1064 "ipv6AccessConfigs": [ # 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. 1065 { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. 1066 "externalIpv6": "A String", # 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. 1067 "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. 1068 "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. 1069 "name": "A String", # 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. 1070 "natIP": "A String", # 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. 1071 "networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. 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. 1072 "publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled in accessConfig. If this field is unspecified in ipv6AccessConfig, a default PTR record will be createc for first IP in associated external IPv6 range. 1073 "setPublicPtr": True or False, # Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. This field is not used in ipv6AccessConfig. A default PTR record will be created if the VM has external IPv6 range associated. 1074 "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT. 1075 }, 1076 ], 1077 "ipv6AccessType": "A String", # [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. Valid only if stackType is IPV4_IPV6. 1078 "ipv6Address": "A String", # An IPv6 internal network address for this network interface. 1079 "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. 1080 "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. 1081 "network": "A String", # URL of the VPC 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 selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default 1082 "networkIP": "A String", # 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. 1083 "nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. 1084 "queueCount": 42, # The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users. 1085 "stackType": "A String", # 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. This field can be both set at instance creation and update network interface operations. 1086 "subnetwork": "A String", # 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: - https://www.googleapis.com/compute/v1/projects/project/regions/region /subnetworks/subnetwork - regions/region/subnetworks/subnetwork 1087 }, 1088 ], 1089 "networkPerformanceConfig": { # Note that for MachineImage, this is not supported yet. 1090 "totalEgressBandwidthTier": "A String", 1091 }, 1092 "postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance. 1093 "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for VMs. If not specified, use INHERIT_FROM_SUBNETWORK as default. Note that for MachineImage, this is not supported yet. 1094 "reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that instances can consume from. Note that for MachineImage, this is not supported yet. 1095 "consumeReservationType": "A String", # 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. 1096 "key": "A String", # 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. 1097 "values": [ # Corresponds to the label values of a reservation resource. This can be either a name to a reservation in the same project or "projects/different-project/reservations/some-reservation-name" to target a shared reservation in the same zone but in a different project. 1098 "A String", 1099 ], 1100 }, 1101 "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty. 1102 "a_key": "A String", 1103 }, 1104 "resourcePolicies": [ # Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. 1105 "A String", 1106 ], 1107 "scheduling": { # Sets the scheduling options for an Instance. NextID: 21 # Specifies the scheduling options for the instances that are created from these properties. 1108 "automaticRestart": 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. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. 1109 "hostErrorTimeoutSeconds": 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. 1110 "instanceTerminationAction": "A String", # Specifies the termination action for the instance. 1111 "locationHint": "A String", # 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. 1112 "maintenanceFreezeDurationHours": 42, # Specifies the number of hours after VM instance creation where the VM won't be scheduled for maintenance. 1113 "maintenanceInterval": "A String", # For more information about maintenance intervals, see Setting maintenance intervals. 1114 "minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. 1115 "nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity. 1116 { # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled. 1117 "key": "A String", # Corresponds to the label key of Node resource. 1118 "operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity. 1119 "values": [ # Corresponds to the label values of Node resource. 1120 "A String", 1121 ], 1122 }, 1123 ], 1124 "onHostMaintenance": "A String", # 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. 1125 "preemptible": 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. 1126 "provisioningModel": "A String", # Specifies the provisioning model of the instance. 1127 }, 1128 "serviceAccounts": [ # 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. 1129 { # A service account. 1130 "email": "A String", # Email address of the service account. 1131 "scopes": [ # The list of scopes to be made available for this service account. 1132 "A String", 1133 ], 1134 }, 1135 ], 1136 "shieldedInstanceConfig": { # A set of Shielded Instance options. # Note that for MachineImage, this is not supported yet. 1137 "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default. 1138 "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default. 1139 "enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default. 1140 }, 1141 "shieldedVmConfig": { # A set of Shielded VM options. # Specifies the Shielded VM options for the instances that are created from these properties. 1142 "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. 1143 "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. 1144 "enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. 1145 }, 1146 "tags": { # 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. 1147 "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the tags' 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. To see the latest fingerprint, make get() request to the instance. 1148 "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. 1149 "A String", 1150 ], 1151 }, 1152 }, 1153 "locationPolicy": { # 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. 1154 "locations": { # 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. 1155 "a_key": { 1156 "preference": "A String", # Preference for a given location: ALLOW or DENY. 1157 }, 1158 }, 1159 "targetShape": "A String", # Strategy for distributing VMs across zones in a region. 1160 }, 1161 "minCount": "A String", # 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. 1162 "namePattern": "A String", # The string pattern used for the names of the VMs. Either name_pattern or per_instance_properties must be set. The pattern must contain one continuous sequence of placeholder hash characters (#) with each character corresponding to one digit of the generated instance name. Example: a name_pattern of inst-#### generates instance names such as inst-0001 and inst-0002. If existing instances in the same project and zone have names that match the name pattern then the generated instance numbers 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-#### begin with inst-0051. The name pattern placeholder #...# can contain up to 18 characters. 1163 "perInstanceProperties": { # 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. 1164 "a_key": { # Per-instance properties to be set on individual instances. To be extended in the future. 1165 "name": "A String", # This field is only temporary. It will be removed. Do not use it. 1166 }, 1167 }, 1168 "sourceInstanceTemplate": "A String", # 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. It can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate This field is optional. 1169} 1170 1171 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 1172 x__xgafv: string, V1 error format. 1173 Allowed values 1174 1 - v1 error format 1175 2 - v2 error format 1176 1177Returns: 1178 An object of the form: 1179 1180 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 1181 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1182 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1183 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1184 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1185 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1186 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1187 { 1188 "code": "A String", # [Output Only] The error type identifier for this error. 1189 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1190 "message": "A String", # [Output Only] An optional, human-readable error message. 1191 }, 1192 ], 1193 }, 1194 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 1195 "httpErrorStatusCode": 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. 1196 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 1197 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1198 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 1199 "name": "A String", # [Output Only] Name of the operation. 1200 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 1201 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 1202 "progress": 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. 1203 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 1204 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1205 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1206 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 1207 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1208 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1209 "targetLink": "A String", # [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. 1210 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 1211 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1212 { 1213 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 1214 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1215 { 1216 "key": "A String", # [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). 1217 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1218 }, 1219 ], 1220 "message": "A String", # [Output Only] A human-readable description of the warning code. 1221 }, 1222 ], 1223 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 1224}</pre> 1225</div> 1226 1227<div class="method"> 1228 <code class="details" id="close">close()</code> 1229 <pre>Close httplib2 connections.</pre> 1230</div> 1231 1232<div class="method"> 1233 <code class="details" id="delete">delete(project, zone, instance, requestId=None, x__xgafv=None)</code> 1234 <pre>Deletes the specified Instance resource. For more information, see Deleting an instance. 1235 1236Args: 1237 project: string, Project ID for this request. (required) 1238 zone: string, The name of the zone for this request. (required) 1239 instance: string, Name of the instance resource to delete. (required) 1240 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 1241 x__xgafv: string, V1 error format. 1242 Allowed values 1243 1 - v1 error format 1244 2 - v2 error format 1245 1246Returns: 1247 An object of the form: 1248 1249 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 1250 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1251 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1252 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1253 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1254 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1255 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1256 { 1257 "code": "A String", # [Output Only] The error type identifier for this error. 1258 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1259 "message": "A String", # [Output Only] An optional, human-readable error message. 1260 }, 1261 ], 1262 }, 1263 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 1264 "httpErrorStatusCode": 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. 1265 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 1266 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1267 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 1268 "name": "A String", # [Output Only] Name of the operation. 1269 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 1270 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 1271 "progress": 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. 1272 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 1273 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1274 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1275 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 1276 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1277 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1278 "targetLink": "A String", # [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. 1279 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 1280 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1281 { 1282 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 1283 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1284 { 1285 "key": "A String", # [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). 1286 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1287 }, 1288 ], 1289 "message": "A String", # [Output Only] A human-readable description of the warning code. 1290 }, 1291 ], 1292 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 1293}</pre> 1294</div> 1295 1296<div class="method"> 1297 <code class="details" id="deleteAccessConfig">deleteAccessConfig(project, zone, instance, accessConfig, networkInterface, requestId=None, x__xgafv=None)</code> 1298 <pre>Deletes an access config from an instance's network interface. 1299 1300Args: 1301 project: string, Project ID for this request. (required) 1302 zone: string, The name of the zone for this request. (required) 1303 instance: string, The instance name for this request. (required) 1304 accessConfig: string, The name of the access config to delete. (required) 1305 networkInterface: string, The name of the network interface. (required) 1306 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 1307 x__xgafv: string, V1 error format. 1308 Allowed values 1309 1 - v1 error format 1310 2 - v2 error format 1311 1312Returns: 1313 An object of the form: 1314 1315 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 1316 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1317 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1318 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1319 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1320 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1321 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1322 { 1323 "code": "A String", # [Output Only] The error type identifier for this error. 1324 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1325 "message": "A String", # [Output Only] An optional, human-readable error message. 1326 }, 1327 ], 1328 }, 1329 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 1330 "httpErrorStatusCode": 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. 1331 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 1332 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1333 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 1334 "name": "A String", # [Output Only] Name of the operation. 1335 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 1336 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 1337 "progress": 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. 1338 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 1339 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1340 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1341 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 1342 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1343 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1344 "targetLink": "A String", # [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. 1345 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 1346 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1347 { 1348 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 1349 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1350 { 1351 "key": "A String", # [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). 1352 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1353 }, 1354 ], 1355 "message": "A String", # [Output Only] A human-readable description of the warning code. 1356 }, 1357 ], 1358 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 1359}</pre> 1360</div> 1361 1362<div class="method"> 1363 <code class="details" id="detachDisk">detachDisk(project, zone, instance, deviceName, requestId=None, x__xgafv=None)</code> 1364 <pre>Detaches a disk from an instance. 1365 1366Args: 1367 project: string, Project ID for this request. (required) 1368 zone: string, The name of the zone for this request. (required) 1369 instance: string, Instance name for this request. (required) 1370 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) 1371 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 1372 x__xgafv: string, V1 error format. 1373 Allowed values 1374 1 - v1 error format 1375 2 - v2 error format 1376 1377Returns: 1378 An object of the form: 1379 1380 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 1381 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1382 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1383 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1384 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1385 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1386 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1387 { 1388 "code": "A String", # [Output Only] The error type identifier for this error. 1389 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1390 "message": "A String", # [Output Only] An optional, human-readable error message. 1391 }, 1392 ], 1393 }, 1394 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 1395 "httpErrorStatusCode": 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. 1396 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 1397 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1398 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 1399 "name": "A String", # [Output Only] Name of the operation. 1400 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 1401 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 1402 "progress": 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. 1403 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 1404 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1405 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1406 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 1407 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1408 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1409 "targetLink": "A String", # [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. 1410 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 1411 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1412 { 1413 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 1414 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1415 { 1416 "key": "A String", # [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). 1417 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1418 }, 1419 ], 1420 "message": "A String", # [Output Only] A human-readable description of the warning code. 1421 }, 1422 ], 1423 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 1424}</pre> 1425</div> 1426 1427<div class="method"> 1428 <code class="details" id="get">get(project, zone, instance, x__xgafv=None)</code> 1429 <pre>Returns the specified Instance resource. Gets a list of available instances by making a list() request. 1430 1431Args: 1432 project: string, Project ID for this request. (required) 1433 zone: string, The name of the zone for this request. (required) 1434 instance: string, Name of the instance resource to return. (required) 1435 x__xgafv: string, V1 error format. 1436 Allowed values 1437 1 - v1 error format 1438 2 - v2 error format 1439 1440Returns: 1441 An object of the form: 1442 1443 { # Represents an Instance resource. An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. 1444 "advancedMachineFeatures": { # 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. 1445 "enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false). 1446 "threadsPerCore": 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. 1447 }, 1448 "canIpForward": 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 . 1449 "confidentialInstanceConfig": { # A set of Confidential Instance options. 1450 "enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled. 1451 }, 1452 "cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance. 1453 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 1454 "deletionProtection": True or False, # Whether the resource should be protected against deletion. 1455 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 1456 "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them. 1457 { # An instance-attached disk resource. 1458 "autoDelete": 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). 1459 "boot": 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. 1460 "deviceName": "A String", # 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. 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. 1461 "diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key. 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. 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. 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. Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group. 1462 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key 1463 "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ 1464 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" 1465 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 1466 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 1467 }, 1468 "diskSizeGb": "A String", # The size of the disk in GB. 1469 "guestOsFeatures": [ # 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. 1470 { # Guest OS features. 1471 "type": "A String", # The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - SECURE_BOOT - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE For more information, see Enabling guest operating system features. 1472 }, 1473 ], 1474 "index": 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. 1475 "initializeParams": { # [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. This property is mutually exclusive with the source property; you can only define one or the other, but not both. # [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. This property is mutually exclusive with the source property; you can only define one or the other, but not both. 1476 "description": "A String", # An optional description. Provide this property when creating the disk. 1477 "diskName": "A String", # 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. 1478 "diskSizeGb": "A String", # 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. 1479 "diskType": "A String", # 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: https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you define this field, you can provide either the full or partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL. 1480 "guestOsFeatures": [ # 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. Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures 1481 { # Guest OS features. 1482 "type": "A String", # The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - SECURE_BOOT - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE For more information, see Enabling guest operating system features. 1483 }, 1484 ], 1485 "labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. 1486 "a_key": "A String", 1487 }, 1488 "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. 1489 "A String", 1490 ], 1491 "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance. 1492 "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk. 1493 "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation. 1494 "resourcePolicies": [ # 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. 1495 "A String", 1496 ], 1497 "sourceImage": "A String", # 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. 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: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image 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: global/images/family/my-image-family If the source image is deleted later, this field will not be set. 1498 "sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. 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. 1499 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key 1500 "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ 1501 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" 1502 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 1503 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 1504 }, 1505 "sourceSnapshot": "A String", # 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. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set. 1506 "sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot. 1507 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key 1508 "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ 1509 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" 1510 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 1511 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 1512 }, 1513 }, 1514 "interface": "A String", # 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. 1515 "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks. 1516 "licenses": [ # [Output Only] Any valid publicly visible licenses. 1517 "A String", 1518 ], 1519 "locked": True or False, # [Output Only] Whether to indicate the attached disk is locked. The locked disk is not allowed to be detached from the instance, or to be used as the source of the snapshot creation, and the image creation. The instance with at least one locked attached disk is not allow to be used as source of machine image creation, instant snapshot creation, and not allowed to be deleted with --keep-disk parameter set to true for locked disks. 1520 "mode": "A String", # 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. 1521 "shieldedInstanceInitialState": { # 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 1522 "dbs": [ # The Key Database (db). 1523 { 1524 "content": "A String", # The raw content in the secure keys file. 1525 "fileType": "A String", # The file type of source file. 1526 }, 1527 ], 1528 "dbxs": [ # The forbidden key database (dbx). 1529 { 1530 "content": "A String", # The raw content in the secure keys file. 1531 "fileType": "A String", # The file type of source file. 1532 }, 1533 ], 1534 "keks": [ # The Key Exchange Key (KEK). 1535 { 1536 "content": "A String", # The raw content in the secure keys file. 1537 "fileType": "A String", # The file type of source file. 1538 }, 1539 ], 1540 "pk": { # The Platform Key (PK). 1541 "content": "A String", # The raw content in the secure keys file. 1542 "fileType": "A String", # The file type of source file. 1543 }, 1544 }, 1545 "source": "A String", # 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. If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. Note that for InstanceTemplate, specify the disk name for zonal disk, and the URL for regional disk. 1546 "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. 1547 "userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of URLs to the license resource. Unlike regular licenses, user provided licenses can be modified after the disk is created. 1548 "A String", 1549 ], 1550 }, 1551 ], 1552 "displayDevice": { # A set of Display Device options # Enables display device for the instance. 1553 "enableDisplay": True or False, # Defines whether the instance has Display enabled. 1554 }, 1555 "eraseWindowsVssSignature": True or False, # Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature. 1556 "fingerprint": "A String", # Specifies a fingerprint for this resource, which is essentially a hash of the instance'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. To see the latest fingerprint, make get() request to the instance. 1557 "guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance. 1558 { # A specification of the type and number of accelerator cards attached to the instance. 1559 "acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance. 1560 "acceleratorType": "A String", # 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. 1561 }, 1562 ], 1563 "hostname": "A String", # 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. 1564 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 1565 "kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances. 1566 "labelFingerprint": "A String", # A fingerprint for this request, which is essentially a hash of the label'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. To see the latest fingerprint, make get() request to the instance. 1567 "labels": { # Labels to apply to this instance. These can be later modified by the setLabels method. 1568 "a_key": "A String", 1569 }, 1570 "lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format. 1571 "lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format. 1572 "lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format. 1573 "machineType": "A String", # 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: zones/us-central1-f/machineTypes/n1-standard-1 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): zones/zone/machineTypes/custom-CPUS-MEMORY For example: zones/us-central1-f/machineTypes/custom-4-5120 For a full list of restrictions, read the Specifications for custom machine types. 1574 "metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys. 1575 "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata'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. To see the latest fingerprint, make a get() request to retrieve the resource. 1576 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB. 1577 { # Metadata 1578 "key": "A String", # 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. 1579 "value": "A String", # 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). 1580 }, 1581 ], 1582 "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata. 1583 }, 1584 "minCpuPlatform": "A String", # Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge". 1585 "name": "A String", # 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. 1586 "networkInterfaces": [ # 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. 1587 { # A network interface resource attached to an instance. 1588 "accessConfigs": [ # 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. 1589 { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. 1590 "externalIpv6": "A String", # 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. 1591 "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. 1592 "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. 1593 "name": "A String", # 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. 1594 "natIP": "A String", # 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. 1595 "networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. 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. 1596 "publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled in accessConfig. If this field is unspecified in ipv6AccessConfig, a default PTR record will be createc for first IP in associated external IPv6 range. 1597 "setPublicPtr": True or False, # Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. This field is not used in ipv6AccessConfig. A default PTR record will be created if the VM has external IPv6 range associated. 1598 "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT. 1599 }, 1600 ], 1601 "aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks. 1602 { # An alias IP range attached to an instance's network interface. 1603 "ipCidrRange": "A String", # 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). 1604 "subnetworkRangeName": "A String", # 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. 1605 }, 1606 ], 1607 "fingerprint": "A String", # 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. 1608 "ipv6AccessConfigs": [ # 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. 1609 { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. 1610 "externalIpv6": "A String", # 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. 1611 "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. 1612 "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. 1613 "name": "A String", # 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. 1614 "natIP": "A String", # 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. 1615 "networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. 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. 1616 "publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled in accessConfig. If this field is unspecified in ipv6AccessConfig, a default PTR record will be createc for first IP in associated external IPv6 range. 1617 "setPublicPtr": True or False, # Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. This field is not used in ipv6AccessConfig. A default PTR record will be created if the VM has external IPv6 range associated. 1618 "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT. 1619 }, 1620 ], 1621 "ipv6AccessType": "A String", # [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. Valid only if stackType is IPV4_IPV6. 1622 "ipv6Address": "A String", # An IPv6 internal network address for this network interface. 1623 "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. 1624 "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. 1625 "network": "A String", # URL of the VPC 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 selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default 1626 "networkIP": "A String", # 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. 1627 "nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. 1628 "queueCount": 42, # The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users. 1629 "stackType": "A String", # 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. This field can be both set at instance creation and update network interface operations. 1630 "subnetwork": "A String", # 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: - https://www.googleapis.com/compute/v1/projects/project/regions/region /subnetworks/subnetwork - regions/region/subnetworks/subnetwork 1631 }, 1632 ], 1633 "networkPerformanceConfig": { 1634 "totalEgressBandwidthTier": "A String", 1635 }, 1636 "params": { # Additional instance params. # Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. 1637 "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty. 1638 "a_key": "A String", 1639 }, 1640 }, 1641 "postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance. 1642 "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default. 1643 "reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from. 1644 "consumeReservationType": "A String", # 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. 1645 "key": "A String", # 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. 1646 "values": [ # Corresponds to the label values of a reservation resource. This can be either a name to a reservation in the same project or "projects/different-project/reservations/some-reservation-name" to target a shared reservation in the same zone but in a different project. 1647 "A String", 1648 ], 1649 }, 1650 "resourcePolicies": [ # Resource policies applied to this instance. 1651 "A String", 1652 ], 1653 "satisfiesPzs": True or False, # [Output Only] Reserved for future use. 1654 "scheduling": { # Sets the scheduling options for an Instance. NextID: 21 # Sets the scheduling options for this instance. 1655 "automaticRestart": 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. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. 1656 "hostErrorTimeoutSeconds": 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. 1657 "instanceTerminationAction": "A String", # Specifies the termination action for the instance. 1658 "locationHint": "A String", # 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. 1659 "maintenanceFreezeDurationHours": 42, # Specifies the number of hours after VM instance creation where the VM won't be scheduled for maintenance. 1660 "maintenanceInterval": "A String", # For more information about maintenance intervals, see Setting maintenance intervals. 1661 "minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. 1662 "nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity. 1663 { # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled. 1664 "key": "A String", # Corresponds to the label key of Node resource. 1665 "operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity. 1666 "values": [ # Corresponds to the label values of Node resource. 1667 "A String", 1668 ], 1669 }, 1670 ], 1671 "onHostMaintenance": "A String", # 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. 1672 "preemptible": 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. 1673 "provisioningModel": "A String", # Specifies the provisioning model of the instance. 1674 }, 1675 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 1676 "serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. 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. 1677 { # A service account. 1678 "email": "A String", # Email address of the service account. 1679 "scopes": [ # The list of scopes to be made available for this service account. 1680 "A String", 1681 ], 1682 }, 1683 ], 1684 "shieldedInstanceConfig": { # A set of Shielded Instance options. 1685 "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default. 1686 "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default. 1687 "enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default. 1688 }, 1689 "shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured. 1690 "updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot. 1691 }, 1692 "shieldedVmConfig": { # A set of Shielded VM options. # Deprecating, please use shielded_instance_config. 1693 "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. 1694 "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. 1695 "enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. 1696 }, 1697 "shieldedVmIntegrityPolicy": { # The policy describes the baseline against which VM instance boot integrity is measured. # Deprecating, please use shielded_instance_integrity_policy. 1698 "updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot. 1699 }, 1700 "sourceMachineImage": "A String", # Source machine image 1701 "sourceMachineImageEncryptionKey": { # Source machine image encryption key when creating an instance from a machine image. 1702 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key 1703 "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ 1704 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" 1705 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 1706 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 1707 }, 1708 "startRestricted": True or False, # [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity. 1709 "status": "A String", # [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. 1710 "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status. 1711 "tags": { # 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 'tags.items' field. 1712 "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the tags' 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. To see the latest fingerprint, make get() request to the instance. 1713 "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. 1714 "A String", 1715 ], 1716 }, 1717 "zone": "A String", # [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. 1718}</pre> 1719</div> 1720 1721<div class="method"> 1722 <code class="details" id="getEffectiveFirewalls">getEffectiveFirewalls(project, zone, instance, networkInterface, x__xgafv=None)</code> 1723 <pre>Returns effective firewalls applied to an interface of the instance. 1724 1725Args: 1726 project: string, Project ID for this request. (required) 1727 zone: string, The name of the zone for this request. (required) 1728 instance: string, Name of the instance scoping this request. (required) 1729 networkInterface: string, The name of the network interface to get the effective firewalls. (required) 1730 x__xgafv: string, V1 error format. 1731 Allowed values 1732 1 - v1 error format 1733 2 - v2 error format 1734 1735Returns: 1736 An object of the form: 1737 1738 { 1739 "firewallPolicys": [ # Effective firewalls from firewall policies. 1740 { 1741 "displayName": "A String", # [Output Only] Deprecated, please use short name instead. The display name of the firewall policy. 1742 "name": "A String", # [Output Only] The name of the firewall policy. 1743 "rules": [ # The rules that apply to the network. 1744 { # 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). 1745 "action": "A String", # The Action to perform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502. 1746 "description": "A String", # An optional description for this resource. 1747 "direction": "A String", # The direction in which this rule applies. 1748 "disabled": 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. 1749 "enableLogging": 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 "goto_next" rules. 1750 "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules 1751 "match": { # 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 'action' is enforced. 1752 "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. 1753 "A String", 1754 ], 1755 "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. 1756 { 1757 "ipProtocol": "A String", # 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. 1758 "ports": [ # 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. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. 1759 "A String", 1760 ], 1761 }, 1762 ], 1763 "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. 1764 "A String", 1765 ], 1766 }, 1767 "priority": 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. 1768 "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. 1769 "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. 1770 "A String", 1771 ], 1772 "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. 1773 "A String", 1774 ], 1775 }, 1776 ], 1777 "shortName": "A String", # [Output Only] The short name of the firewall policy. 1778 "type": "A String", # [Output Only] The type of the firewall policy. 1779 }, 1780 ], 1781 "firewalls": [ # Effective firewalls on the instance. 1782 { # Represents a Firewall Rule resource. Firewall rules allow or deny ingress traffic to, and egress traffic from your instances. For more information, read Firewall rules. 1783 "allowed": [ # The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection. 1784 { 1785 "IPProtocol": "A String", # 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. 1786 "ports": [ # 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. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. 1787 "A String", 1788 ], 1789 }, 1790 ], 1791 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 1792 "denied": [ # The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection. 1793 { 1794 "IPProtocol": "A String", # 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. 1795 "ports": [ # 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. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. 1796 "A String", 1797 ], 1798 }, 1799 ], 1800 "description": "A String", # An optional description of this resource. Provide this field when you create the resource. 1801 "destinationRanges": [ # 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. Both IPv4 and IPv6 are supported. 1802 "A String", 1803 ], 1804 "direction": "A String", # 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. 1805 "disabled": 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. 1806 "enableLogging": 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. 1807 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 1808 "kind": "compute#firewall", # [Output Only] Type of the resource. Always compute#firewall for firewall rules. 1809 "logConfig": { # 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. 1810 "enable": True or False, # This field denotes whether to enable logging for a particular firewall rule. 1811 "metadata": "A String", # 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. 1812 }, 1813 "name": "A String", # 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. 1814 "network": "A String", # URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: global/networks/default 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: - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network - projects/myproject/global/networks/my-network - global/networks/default 1815 "priority": 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`. 1816 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1817 "sourceRanges": [ # 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. Both IPv4 and IPv6 are supported. 1818 "A String", 1819 ], 1820 "sourceServiceAccounts": [ # 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'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. 1821 "A String", 1822 ], 1823 "sourceTags": [ # 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'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. 1824 "A String", 1825 ], 1826 "targetServiceAccounts": [ # 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. 1827 "A String", 1828 ], 1829 "targetTags": [ # 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. 1830 "A String", 1831 ], 1832 }, 1833 ], 1834 "organizationFirewalls": [ # Effective firewalls from organization policies. 1835 { # A pruned SecurityPolicy containing ID and any applicable firewall rules. 1836 "id": "A String", # The unique identifier for the security policy. This identifier is defined by the server. 1837 "rules": [ # The rules that apply to the network. 1838 { # 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). 1839 "action": "A String", # The Action to perform when the rule is matched. The following are the valid actions: - allow: allow access to target. - deny(): deny access to target, returns the HTTP response code specified (valid values are 403, 404, and 502). - rate_based_ban: limit client traffic to the configured threshold and ban the client if the traffic exceeds the threshold. Configure parameters for this action in RateLimitOptions. Requires rate_limit_options to be set. - redirect: redirect to a different target. This can either be an internal reCAPTCHA redirect, or an external URL-based redirect via a 302 response. Parameters for this action can be configured via redirectOptions. - throttle: limit client traffic to the configured threshold. Configure parameters for this action in rateLimitOptions. Requires rate_limit_options to be set for this. 1840 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 1841 "direction": "A String", # The direction in which this rule applies. This field may only be specified when versioned_expr is set to FIREWALL. 1842 "enableLogging": 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 "goto_next" rules. This field may only be specified when the versioned_expr is set to FIREWALL. 1843 "headerAction": { # Optional, additional actions that are performed on headers. 1844 "requestHeadersToAdds": [ # The list of request headers to add or overwrite if they're already present. 1845 { 1846 "headerName": "A String", # The name of the header to set. 1847 "headerValue": "A String", # The value to set the named header to. 1848 }, 1849 ], 1850 }, 1851 "kind": "compute#securityPolicyRule", # [Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules 1852 "match": { # 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 'action' is enforced. 1853 "config": { # 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. 1854 "destIpRanges": [ # CIDR IP address range. This field may only be specified when versioned_expr is set to FIREWALL. 1855 "A String", 1856 ], 1857 "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. This field may only be specified when versioned_expr is set to FIREWALL. 1858 { 1859 "ipProtocol": "A String", # 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. 1860 "ports": [ # 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. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. This field may only be specified when versioned_expr is set to FIREWALL. 1861 "A String", 1862 ], 1863 }, 1864 ], 1865 "srcIpRanges": [ # CIDR IP address range. Maximum number of src_ip_ranges allowed is 10. 1866 "A String", 1867 ], 1868 }, 1869 "expr": { # 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. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" 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. # 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. 1870 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 1871 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 1872 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 1873 "title": "A String", # 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. 1874 }, 1875 "versionedExpr": "A String", # 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. 1876 }, 1877 "preview": True or False, # If set to true, the specified action is not enforced. 1878 "priority": 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. 1879 "rateLimitOptions": { # Must be specified if the action is "rate_based_ban" or "throttle". Cannot be specified for any other actions. 1880 "banDurationSec": 42, # Can only be specified if the action for the rule is "rate_based_ban". If specified, determines the time (in seconds) the traffic will continue to be banned by the rate limit after the rate falls below the threshold. 1881 "banThreshold": { # Can only be specified if the action for the rule is "rate_based_ban". If specified, the key will be banned for the configured 'ban_duration_sec' when the number of requests that exceed the 'rate_limit_threshold' also exceed this 'ban_threshold'. 1882 "count": 42, # Number of HTTP(S) requests for calculating the threshold. 1883 "intervalSec": 42, # Interval over which the threshold is computed. 1884 }, 1885 "conformAction": "A String", # Action to take for requests that are under the configured rate limit threshold. Valid option is "allow" only. 1886 "enforceOnKey": "A String", # Determines the key to enforce the rate_limit_threshold on. Possible values are: - ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if this field 'enforce_on_key' is not configured. - IP: The source IP address of the request is the key. Each IP has this limit enforced separately. - HTTP_HEADER: The value of the HTTP header whose name is configured under "enforce_on_key_name". The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL. - XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key type defaults to ALL. - HTTP_COOKIE: The value of the HTTP cookie whose name is configured under "enforce_on_key_name". The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL. 1887 "enforceOnKeyName": "A String", # Rate limit key name applicable only for the following key types: HTTP_HEADER -- Name of the HTTP header whose value is taken as the key value. HTTP_COOKIE -- Name of the HTTP cookie whose value is taken as the key value. 1888 "exceedAction": "A String", # Action to take for requests that are above the configured rate limit threshold, to either deny with a specified HTTP response code, or redirect to a different endpoint. Valid options are "deny()" where valid values for status are 403, 404, 429, and 502, and "redirect" where the redirect parameters come from exceed_redirect_options below. 1889 "exceedRedirectOptions": { # Parameters defining the redirect action that is used as the exceed action. Cannot be specified if the exceed action is not redirect. 1890 "target": "A String", # Target for the redirect action. This is required if the type is EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA. 1891 "type": "A String", # Type of the redirect action. 1892 }, 1893 "rateLimitThreshold": { # Threshold at which to begin ratelimiting. 1894 "count": 42, # Number of HTTP(S) requests for calculating the threshold. 1895 "intervalSec": 42, # Interval over which the threshold is computed. 1896 }, 1897 }, 1898 "redirectOptions": { # Parameters defining the redirect action. Cannot be specified for any other actions. 1899 "target": "A String", # Target for the redirect action. This is required if the type is EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA. 1900 "type": "A String", # Type of the redirect action. 1901 }, 1902 "ruleNumber": "A String", # 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. 1903 "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall security policy rule. 1904 "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. This field may only be specified when versioned_expr is set to FIREWALL. 1905 "A String", 1906 ], 1907 "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. 1908 "A String", 1909 ], 1910 }, 1911 ], 1912 }, 1913 ], 1914}</pre> 1915</div> 1916 1917<div class="method"> 1918 <code class="details" id="getGuestAttributes">getGuestAttributes(project, zone, instance, queryPath=None, variableKey=None, x__xgafv=None)</code> 1919 <pre>Returns the specified guest attributes entry. 1920 1921Args: 1922 project: string, Project ID for this request. (required) 1923 zone: string, The name of the zone for this request. (required) 1924 instance: string, Name of the instance scoping this request. (required) 1925 queryPath: string, Specifies the guest attributes path to be queried. 1926 variableKey: string, Specifies the key for the guest attributes entry. 1927 x__xgafv: string, V1 error format. 1928 Allowed values 1929 1 - v1 error format 1930 2 - v2 error format 1931 1932Returns: 1933 An object of the form: 1934 1935 { # A guest attributes entry. 1936 "kind": "compute#guestAttributes", # [Output Only] Type of the resource. Always compute#guestAttributes for guest attributes entry. 1937 "queryPath": "A String", # The path to be queried. This can be the default namespace ('') or a nested namespace ('\/') or a specified key ('\/\'). 1938 "queryValue": { # Array of guest attribute namespace/key/value tuples. # [Output Only] The value of the requested queried path. 1939 "items": [ 1940 { # A guest attributes namespace/key/value entry. 1941 "key": "A String", # Key for the guest attribute entry. 1942 "namespace": "A String", # Namespace for the guest attribute entry. 1943 "value": "A String", # Value for the guest attribute entry. 1944 }, 1945 ], 1946 }, 1947 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 1948 "variableKey": "A String", # The key to search for. 1949 "variableValue": "A String", # [Output Only] The value found for the requested key. 1950}</pre> 1951</div> 1952 1953<div class="method"> 1954 <code class="details" id="getIamPolicy">getIamPolicy(project, zone, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</code> 1955 <pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists. 1956 1957Args: 1958 project: string, Project ID for this request. (required) 1959 zone: string, The name of the zone for this request. (required) 1960 resource: string, Name or id of the resource for this request. (required) 1961 optionsRequestedPolicyVersion: integer, Requested IAM Policy version. 1962 x__xgafv: string, V1 error format. 1963 Allowed values 1964 1 - v1 error format 1965 2 - v2 error format 1966 1967Returns: 1968 An object of the form: 1969 1970 { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals 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. 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). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). 1971 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 1972 { # 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. 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. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:[email protected]" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts [email protected] from DATA_READ logging, and [email protected] from DATA_WRITE logging. 1973 "auditLogConfigs": [ # The configuration for logging of each type of permission. 1974 { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting [email protected] from DATA_READ logging. 1975 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. 1976 "A String", 1977 ], 1978 "ignoreChildExemptions": True or False, # This is deprecated and has no effect. Do not use. 1979 "logType": "A String", # The log type that this config enables. 1980 }, 1981 ], 1982 "exemptedMembers": [ # This is deprecated and has no effect. Do not use. 1983 "A String", 1984 ], 1985 "service": "A String", # 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. 1986 }, 1987 ], 1988 "bindings": [ # Associates a list of `members`, or principals, with 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 principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. 1989 { # Associates `members`, or principals, with a `role`. 1990 "bindingId": "A String", # This is deprecated and has no effect. Do not use. 1991 "condition": { # 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. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" 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. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. 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 principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 1992 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 1993 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 1994 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 1995 "title": "A String", # 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. 1996 }, 1997 "members": [ # Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?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. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 1998 "A String", 1999 ], 2000 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 2001 }, 2002 ], 2003 "etag": "A String", # `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. **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. 2004 "rules": [ # This is deprecated and has no effect. Do not use. 2005 { # This is deprecated and has no effect. Do not use. 2006 "action": "A String", # This is deprecated and has no effect. Do not use. 2007 "conditions": [ # This is deprecated and has no effect. Do not use. 2008 { # This is deprecated and has no effect. Do not use. 2009 "iam": "A String", # This is deprecated and has no effect. Do not use. 2010 "op": "A String", # This is deprecated and has no effect. Do not use. 2011 "svc": "A String", # This is deprecated and has no effect. Do not use. 2012 "sys": "A String", # This is deprecated and has no effect. Do not use. 2013 "values": [ # This is deprecated and has no effect. Do not use. 2014 "A String", 2015 ], 2016 }, 2017 ], 2018 "description": "A String", # This is deprecated and has no effect. Do not use. 2019 "ins": [ # This is deprecated and has no effect. Do not use. 2020 "A String", 2021 ], 2022 "logConfigs": [ # This is deprecated and has no effect. Do not use. 2023 { # This is deprecated and has no effect. Do not use. 2024 "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 2025 "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 2026 "permissionType": "A String", # This is deprecated and has no effect. Do not use. 2027 }, 2028 "logName": "A String", # This is deprecated and has no effect. Do not use. 2029 }, 2030 "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 2031 "customFields": [ # This is deprecated and has no effect. Do not use. 2032 { # This is deprecated and has no effect. Do not use. 2033 "name": "A String", # This is deprecated and has no effect. Do not use. 2034 "value": "A String", # This is deprecated and has no effect. Do not use. 2035 }, 2036 ], 2037 "field": "A String", # This is deprecated and has no effect. Do not use. 2038 "metric": "A String", # This is deprecated and has no effect. Do not use. 2039 }, 2040 "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 2041 "logMode": "A String", # This is deprecated and has no effect. Do not use. 2042 }, 2043 }, 2044 ], 2045 "notIns": [ # This is deprecated and has no effect. Do not use. 2046 "A String", 2047 ], 2048 "permissions": [ # This is deprecated and has no effect. Do not use. 2049 "A String", 2050 ], 2051 }, 2052 ], 2053 "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * 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 **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. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 2054}</pre> 2055</div> 2056 2057<div class="method"> 2058 <code class="details" id="getScreenshot">getScreenshot(project, zone, instance, x__xgafv=None)</code> 2059 <pre>Returns the screenshot from the specified instance. 2060 2061Args: 2062 project: string, Project ID for this request. (required) 2063 zone: string, The name of the zone for this request. (required) 2064 instance: string, Name of the instance scoping this request. (required) 2065 x__xgafv: string, V1 error format. 2066 Allowed values 2067 1 - v1 error format 2068 2 - v2 error format 2069 2070Returns: 2071 An object of the form: 2072 2073 { # An instance's screenshot. 2074 "contents": "A String", # [Output Only] The Base64-encoded screenshot data. 2075 "kind": "compute#screenshot", # [Output Only] Type of the resource. Always compute#screenshot for the screenshots. 2076}</pre> 2077</div> 2078 2079<div class="method"> 2080 <code class="details" id="getSerialPortOutput">getSerialPortOutput(project, zone, instance, port=None, start=None, x__xgafv=None)</code> 2081 <pre>Returns the last 1 MB of serial port output from the specified instance. 2082 2083Args: 2084 project: string, Project ID for this request. (required) 2085 zone: string, The name of the zone for this request. (required) 2086 instance: string, Name of the instance for this request. (required) 2087 port: integer, Specifies which COM or serial port to retrieve data from. 2088 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`. If 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. You 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. 2089 x__xgafv: string, V1 error format. 2090 Allowed values 2091 1 - v1 error format 2092 2 - v2 error format 2093 2094Returns: 2095 An object of the form: 2096 2097 { # An instance serial console output. 2098 "contents": "A String", # [Output Only] The contents of the console output. 2099 "kind": "compute#serialPortOutput", # [Output Only] Type of the resource. Always compute#serialPortOutput for serial port output. 2100 "next": "A String", # [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. 2101 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 2102 "start": "A String", # 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. 2103}</pre> 2104</div> 2105 2106<div class="method"> 2107 <code class="details" id="getShieldedInstanceIdentity">getShieldedInstanceIdentity(project, zone, instance, x__xgafv=None)</code> 2108 <pre>Returns the Shielded Instance Identity of an instance 2109 2110Args: 2111 project: string, Project ID for this request. (required) 2112 zone: string, The name of the zone for this request. (required) 2113 instance: string, Name or id of the instance scoping this request. (required) 2114 x__xgafv: string, V1 error format. 2115 Allowed values 2116 1 - v1 error format 2117 2 - v2 error format 2118 2119Returns: 2120 An object of the form: 2121 2122 { # A Shielded Instance Identity. 2123 "encryptionKey": { # A Shielded Instance Identity Entry. # An Endorsement Key (EK) made by the RSA 2048 algorithm issued to the Shielded Instance's vTPM. 2124 "ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty. 2125 "ekPub": "A String", # A PEM-encoded public key. 2126 }, 2127 "kind": "compute#shieldedInstanceIdentity", # [Output Only] Type of the resource. Always compute#shieldedInstanceIdentity for shielded Instance identity entry. 2128 "signingKey": { # A Shielded Instance Identity Entry. # An Attestation Key (AK) made by the RSA 2048 algorithm issued to the Shielded Instance's vTPM. 2129 "ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty. 2130 "ekPub": "A String", # A PEM-encoded public key. 2131 }, 2132}</pre> 2133</div> 2134 2135<div class="method"> 2136 <code class="details" id="getShieldedVmIdentity">getShieldedVmIdentity(project, zone, instance, x__xgafv=None)</code> 2137 <pre>Returns the Shielded VM Identity of an instance 2138 2139Args: 2140 project: string, Project ID for this request. (required) 2141 zone: string, The name of the zone for this request. (required) 2142 instance: string, Name of the instance scoping this request. (required) 2143 x__xgafv: string, V1 error format. 2144 Allowed values 2145 1 - v1 error format 2146 2 - v2 error format 2147 2148Returns: 2149 An object of the form: 2150 2151 { # A Shielded VM Identity. 2152 "encryptionKey": { # A Shielded Instance Identity Entry. # An Endorsement Key (EK) issued to the Shielded VM's vTPM. 2153 "ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty. 2154 "ekPub": "A String", # A PEM-encoded public key. 2155 }, 2156 "kind": "compute#shieldedVmIdentity", # [Output Only] Type of the resource. Always compute#shieldedVmIdentity for shielded VM identity entry. 2157 "signingKey": { # A Shielded Instance Identity Entry. # An Attestation Key (AK) issued to the Shielded VM's vTPM. 2158 "ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty. 2159 "ekPub": "A String", # A PEM-encoded public key. 2160 }, 2161}</pre> 2162</div> 2163 2164<div class="method"> 2165 <code class="details" id="insert">insert(project, zone, body=None, requestId=None, sourceInstanceTemplate=None, sourceMachineImage=None, x__xgafv=None)</code> 2166 <pre>Creates an instance resource in the specified project using the data included in the request. 2167 2168Args: 2169 project: string, Project ID for this request. (required) 2170 zone: string, The name of the zone for this request. (required) 2171 body: object, The request body. 2172 The object takes the form of: 2173 2174{ # Represents an Instance resource. An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. 2175 "advancedMachineFeatures": { # 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. 2176 "enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false). 2177 "threadsPerCore": 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. 2178 }, 2179 "canIpForward": 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 . 2180 "confidentialInstanceConfig": { # A set of Confidential Instance options. 2181 "enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled. 2182 }, 2183 "cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance. 2184 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 2185 "deletionProtection": True or False, # Whether the resource should be protected against deletion. 2186 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 2187 "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them. 2188 { # An instance-attached disk resource. 2189 "autoDelete": 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). 2190 "boot": 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. 2191 "deviceName": "A String", # 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. 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. 2192 "diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key. 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. 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. 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. Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group. 2193 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key 2194 "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ 2195 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" 2196 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 2197 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 2198 }, 2199 "diskSizeGb": "A String", # The size of the disk in GB. 2200 "guestOsFeatures": [ # 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. 2201 { # Guest OS features. 2202 "type": "A String", # The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - SECURE_BOOT - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE For more information, see Enabling guest operating system features. 2203 }, 2204 ], 2205 "index": 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. 2206 "initializeParams": { # [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. This property is mutually exclusive with the source property; you can only define one or the other, but not both. # [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. This property is mutually exclusive with the source property; you can only define one or the other, but not both. 2207 "description": "A String", # An optional description. Provide this property when creating the disk. 2208 "diskName": "A String", # 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. 2209 "diskSizeGb": "A String", # 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. 2210 "diskType": "A String", # 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: https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you define this field, you can provide either the full or partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL. 2211 "guestOsFeatures": [ # 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. Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures 2212 { # Guest OS features. 2213 "type": "A String", # The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - SECURE_BOOT - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE For more information, see Enabling guest operating system features. 2214 }, 2215 ], 2216 "labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. 2217 "a_key": "A String", 2218 }, 2219 "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. 2220 "A String", 2221 ], 2222 "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance. 2223 "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk. 2224 "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation. 2225 "resourcePolicies": [ # 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. 2226 "A String", 2227 ], 2228 "sourceImage": "A String", # 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. 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: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image 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: global/images/family/my-image-family If the source image is deleted later, this field will not be set. 2229 "sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. 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. 2230 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key 2231 "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ 2232 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" 2233 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 2234 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 2235 }, 2236 "sourceSnapshot": "A String", # 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. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set. 2237 "sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot. 2238 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key 2239 "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ 2240 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" 2241 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 2242 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 2243 }, 2244 }, 2245 "interface": "A String", # 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. 2246 "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks. 2247 "licenses": [ # [Output Only] Any valid publicly visible licenses. 2248 "A String", 2249 ], 2250 "locked": True or False, # [Output Only] Whether to indicate the attached disk is locked. The locked disk is not allowed to be detached from the instance, or to be used as the source of the snapshot creation, and the image creation. The instance with at least one locked attached disk is not allow to be used as source of machine image creation, instant snapshot creation, and not allowed to be deleted with --keep-disk parameter set to true for locked disks. 2251 "mode": "A String", # 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. 2252 "shieldedInstanceInitialState": { # 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 2253 "dbs": [ # The Key Database (db). 2254 { 2255 "content": "A String", # The raw content in the secure keys file. 2256 "fileType": "A String", # The file type of source file. 2257 }, 2258 ], 2259 "dbxs": [ # The forbidden key database (dbx). 2260 { 2261 "content": "A String", # The raw content in the secure keys file. 2262 "fileType": "A String", # The file type of source file. 2263 }, 2264 ], 2265 "keks": [ # The Key Exchange Key (KEK). 2266 { 2267 "content": "A String", # The raw content in the secure keys file. 2268 "fileType": "A String", # The file type of source file. 2269 }, 2270 ], 2271 "pk": { # The Platform Key (PK). 2272 "content": "A String", # The raw content in the secure keys file. 2273 "fileType": "A String", # The file type of source file. 2274 }, 2275 }, 2276 "source": "A String", # 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. If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. Note that for InstanceTemplate, specify the disk name for zonal disk, and the URL for regional disk. 2277 "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. 2278 "userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of URLs to the license resource. Unlike regular licenses, user provided licenses can be modified after the disk is created. 2279 "A String", 2280 ], 2281 }, 2282 ], 2283 "displayDevice": { # A set of Display Device options # Enables display device for the instance. 2284 "enableDisplay": True or False, # Defines whether the instance has Display enabled. 2285 }, 2286 "eraseWindowsVssSignature": True or False, # Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature. 2287 "fingerprint": "A String", # Specifies a fingerprint for this resource, which is essentially a hash of the instance'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. To see the latest fingerprint, make get() request to the instance. 2288 "guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance. 2289 { # A specification of the type and number of accelerator cards attached to the instance. 2290 "acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance. 2291 "acceleratorType": "A String", # 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. 2292 }, 2293 ], 2294 "hostname": "A String", # 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. 2295 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 2296 "kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances. 2297 "labelFingerprint": "A String", # A fingerprint for this request, which is essentially a hash of the label'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. To see the latest fingerprint, make get() request to the instance. 2298 "labels": { # Labels to apply to this instance. These can be later modified by the setLabels method. 2299 "a_key": "A String", 2300 }, 2301 "lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format. 2302 "lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format. 2303 "lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format. 2304 "machineType": "A String", # 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: zones/us-central1-f/machineTypes/n1-standard-1 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): zones/zone/machineTypes/custom-CPUS-MEMORY For example: zones/us-central1-f/machineTypes/custom-4-5120 For a full list of restrictions, read the Specifications for custom machine types. 2305 "metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys. 2306 "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata'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. To see the latest fingerprint, make a get() request to retrieve the resource. 2307 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB. 2308 { # Metadata 2309 "key": "A String", # 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. 2310 "value": "A String", # 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). 2311 }, 2312 ], 2313 "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata. 2314 }, 2315 "minCpuPlatform": "A String", # Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge". 2316 "name": "A String", # 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. 2317 "networkInterfaces": [ # 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. 2318 { # A network interface resource attached to an instance. 2319 "accessConfigs": [ # 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. 2320 { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. 2321 "externalIpv6": "A String", # 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. 2322 "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. 2323 "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. 2324 "name": "A String", # 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. 2325 "natIP": "A String", # 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. 2326 "networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. 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. 2327 "publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled in accessConfig. If this field is unspecified in ipv6AccessConfig, a default PTR record will be createc for first IP in associated external IPv6 range. 2328 "setPublicPtr": True or False, # Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. This field is not used in ipv6AccessConfig. A default PTR record will be created if the VM has external IPv6 range associated. 2329 "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT. 2330 }, 2331 ], 2332 "aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks. 2333 { # An alias IP range attached to an instance's network interface. 2334 "ipCidrRange": "A String", # 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). 2335 "subnetworkRangeName": "A String", # 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. 2336 }, 2337 ], 2338 "fingerprint": "A String", # 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. 2339 "ipv6AccessConfigs": [ # 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. 2340 { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. 2341 "externalIpv6": "A String", # 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. 2342 "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. 2343 "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. 2344 "name": "A String", # 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. 2345 "natIP": "A String", # 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. 2346 "networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. 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. 2347 "publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled in accessConfig. If this field is unspecified in ipv6AccessConfig, a default PTR record will be createc for first IP in associated external IPv6 range. 2348 "setPublicPtr": True or False, # Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. This field is not used in ipv6AccessConfig. A default PTR record will be created if the VM has external IPv6 range associated. 2349 "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT. 2350 }, 2351 ], 2352 "ipv6AccessType": "A String", # [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. Valid only if stackType is IPV4_IPV6. 2353 "ipv6Address": "A String", # An IPv6 internal network address for this network interface. 2354 "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. 2355 "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. 2356 "network": "A String", # URL of the VPC 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 selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default 2357 "networkIP": "A String", # 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. 2358 "nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. 2359 "queueCount": 42, # The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users. 2360 "stackType": "A String", # 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. This field can be both set at instance creation and update network interface operations. 2361 "subnetwork": "A String", # 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: - https://www.googleapis.com/compute/v1/projects/project/regions/region /subnetworks/subnetwork - regions/region/subnetworks/subnetwork 2362 }, 2363 ], 2364 "networkPerformanceConfig": { 2365 "totalEgressBandwidthTier": "A String", 2366 }, 2367 "params": { # Additional instance params. # Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. 2368 "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty. 2369 "a_key": "A String", 2370 }, 2371 }, 2372 "postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance. 2373 "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default. 2374 "reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from. 2375 "consumeReservationType": "A String", # 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. 2376 "key": "A String", # 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. 2377 "values": [ # Corresponds to the label values of a reservation resource. This can be either a name to a reservation in the same project or "projects/different-project/reservations/some-reservation-name" to target a shared reservation in the same zone but in a different project. 2378 "A String", 2379 ], 2380 }, 2381 "resourcePolicies": [ # Resource policies applied to this instance. 2382 "A String", 2383 ], 2384 "satisfiesPzs": True or False, # [Output Only] Reserved for future use. 2385 "scheduling": { # Sets the scheduling options for an Instance. NextID: 21 # Sets the scheduling options for this instance. 2386 "automaticRestart": 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. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. 2387 "hostErrorTimeoutSeconds": 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. 2388 "instanceTerminationAction": "A String", # Specifies the termination action for the instance. 2389 "locationHint": "A String", # 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. 2390 "maintenanceFreezeDurationHours": 42, # Specifies the number of hours after VM instance creation where the VM won't be scheduled for maintenance. 2391 "maintenanceInterval": "A String", # For more information about maintenance intervals, see Setting maintenance intervals. 2392 "minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. 2393 "nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity. 2394 { # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled. 2395 "key": "A String", # Corresponds to the label key of Node resource. 2396 "operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity. 2397 "values": [ # Corresponds to the label values of Node resource. 2398 "A String", 2399 ], 2400 }, 2401 ], 2402 "onHostMaintenance": "A String", # 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. 2403 "preemptible": 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. 2404 "provisioningModel": "A String", # Specifies the provisioning model of the instance. 2405 }, 2406 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 2407 "serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. 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. 2408 { # A service account. 2409 "email": "A String", # Email address of the service account. 2410 "scopes": [ # The list of scopes to be made available for this service account. 2411 "A String", 2412 ], 2413 }, 2414 ], 2415 "shieldedInstanceConfig": { # A set of Shielded Instance options. 2416 "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default. 2417 "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default. 2418 "enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default. 2419 }, 2420 "shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured. 2421 "updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot. 2422 }, 2423 "shieldedVmConfig": { # A set of Shielded VM options. # Deprecating, please use shielded_instance_config. 2424 "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. 2425 "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. 2426 "enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. 2427 }, 2428 "shieldedVmIntegrityPolicy": { # The policy describes the baseline against which VM instance boot integrity is measured. # Deprecating, please use shielded_instance_integrity_policy. 2429 "updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot. 2430 }, 2431 "sourceMachineImage": "A String", # Source machine image 2432 "sourceMachineImageEncryptionKey": { # Source machine image encryption key when creating an instance from a machine image. 2433 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key 2434 "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ 2435 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" 2436 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 2437 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 2438 }, 2439 "startRestricted": True or False, # [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity. 2440 "status": "A String", # [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. 2441 "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status. 2442 "tags": { # 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 'tags.items' field. 2443 "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the tags' 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. To see the latest fingerprint, make get() request to the instance. 2444 "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. 2445 "A String", 2446 ], 2447 }, 2448 "zone": "A String", # [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. 2449} 2450 2451 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 2452 sourceInstanceTemplate: string, Specifies instance template to create the instance. This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate 2453 sourceMachineImage: string, Specifies the machine image to use to create the instance. This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to a machine image: - https://www.googleapis.com/compute/v1/projects/project/global/global /machineImages/machineImage - projects/project/global/global/machineImages/machineImage - global/machineImages/machineImage 2454 x__xgafv: string, V1 error format. 2455 Allowed values 2456 1 - v1 error format 2457 2 - v2 error format 2458 2459Returns: 2460 An object of the form: 2461 2462 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 2463 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 2464 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 2465 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 2466 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 2467 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 2468 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 2469 { 2470 "code": "A String", # [Output Only] The error type identifier for this error. 2471 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 2472 "message": "A String", # [Output Only] An optional, human-readable error message. 2473 }, 2474 ], 2475 }, 2476 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 2477 "httpErrorStatusCode": 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. 2478 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 2479 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 2480 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 2481 "name": "A String", # [Output Only] Name of the operation. 2482 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 2483 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 2484 "progress": 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. 2485 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 2486 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 2487 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 2488 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 2489 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 2490 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 2491 "targetLink": "A String", # [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. 2492 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 2493 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 2494 { 2495 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 2496 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 2497 { 2498 "key": "A String", # [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). 2499 "value": "A String", # [Output Only] A warning data value corresponding to the key. 2500 }, 2501 ], 2502 "message": "A String", # [Output Only] A human-readable description of the warning code. 2503 }, 2504 ], 2505 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 2506}</pre> 2507</div> 2508 2509<div class="method"> 2510 <code class="details" id="list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 2511 <pre>Retrieves the list of instances contained within the specified zone. 2512 2513Args: 2514 project: string, Project ID for this request. (required) 2515 zone: string, The name of the zone for this request. (required) 2516 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You 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. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` 2517 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`) 2518 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. 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. Currently, only sorting by `name` or `creationTimestamp desc` is supported. 2519 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. 2520 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 2521 x__xgafv: string, V1 error format. 2522 Allowed values 2523 1 - v1 error format 2524 2 - v2 error format 2525 2526Returns: 2527 An object of the form: 2528 2529 { # Contains a list of instances. 2530 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 2531 "items": [ # A list of Instance resources. 2532 { # Represents an Instance resource. An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. 2533 "advancedMachineFeatures": { # 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. 2534 "enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false). 2535 "threadsPerCore": 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. 2536 }, 2537 "canIpForward": 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 . 2538 "confidentialInstanceConfig": { # A set of Confidential Instance options. 2539 "enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled. 2540 }, 2541 "cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance. 2542 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 2543 "deletionProtection": True or False, # Whether the resource should be protected against deletion. 2544 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 2545 "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them. 2546 { # An instance-attached disk resource. 2547 "autoDelete": 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). 2548 "boot": 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. 2549 "deviceName": "A String", # 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. 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. 2550 "diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key. 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. 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. 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. Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group. 2551 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key 2552 "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ 2553 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" 2554 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 2555 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 2556 }, 2557 "diskSizeGb": "A String", # The size of the disk in GB. 2558 "guestOsFeatures": [ # 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. 2559 { # Guest OS features. 2560 "type": "A String", # The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - SECURE_BOOT - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE For more information, see Enabling guest operating system features. 2561 }, 2562 ], 2563 "index": 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. 2564 "initializeParams": { # [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. This property is mutually exclusive with the source property; you can only define one or the other, but not both. # [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. This property is mutually exclusive with the source property; you can only define one or the other, but not both. 2565 "description": "A String", # An optional description. Provide this property when creating the disk. 2566 "diskName": "A String", # 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. 2567 "diskSizeGb": "A String", # 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. 2568 "diskType": "A String", # 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: https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you define this field, you can provide either the full or partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL. 2569 "guestOsFeatures": [ # 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. Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures 2570 { # Guest OS features. 2571 "type": "A String", # The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - SECURE_BOOT - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE For more information, see Enabling guest operating system features. 2572 }, 2573 ], 2574 "labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. 2575 "a_key": "A String", 2576 }, 2577 "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. 2578 "A String", 2579 ], 2580 "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance. 2581 "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk. 2582 "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation. 2583 "resourcePolicies": [ # 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. 2584 "A String", 2585 ], 2586 "sourceImage": "A String", # 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. 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: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image 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: global/images/family/my-image-family If the source image is deleted later, this field will not be set. 2587 "sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. 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. 2588 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key 2589 "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ 2590 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" 2591 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 2592 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 2593 }, 2594 "sourceSnapshot": "A String", # 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. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set. 2595 "sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot. 2596 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key 2597 "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ 2598 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" 2599 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 2600 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 2601 }, 2602 }, 2603 "interface": "A String", # 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. 2604 "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks. 2605 "licenses": [ # [Output Only] Any valid publicly visible licenses. 2606 "A String", 2607 ], 2608 "locked": True or False, # [Output Only] Whether to indicate the attached disk is locked. The locked disk is not allowed to be detached from the instance, or to be used as the source of the snapshot creation, and the image creation. The instance with at least one locked attached disk is not allow to be used as source of machine image creation, instant snapshot creation, and not allowed to be deleted with --keep-disk parameter set to true for locked disks. 2609 "mode": "A String", # 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. 2610 "shieldedInstanceInitialState": { # 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 2611 "dbs": [ # The Key Database (db). 2612 { 2613 "content": "A String", # The raw content in the secure keys file. 2614 "fileType": "A String", # The file type of source file. 2615 }, 2616 ], 2617 "dbxs": [ # The forbidden key database (dbx). 2618 { 2619 "content": "A String", # The raw content in the secure keys file. 2620 "fileType": "A String", # The file type of source file. 2621 }, 2622 ], 2623 "keks": [ # The Key Exchange Key (KEK). 2624 { 2625 "content": "A String", # The raw content in the secure keys file. 2626 "fileType": "A String", # The file type of source file. 2627 }, 2628 ], 2629 "pk": { # The Platform Key (PK). 2630 "content": "A String", # The raw content in the secure keys file. 2631 "fileType": "A String", # The file type of source file. 2632 }, 2633 }, 2634 "source": "A String", # 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. If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. Note that for InstanceTemplate, specify the disk name for zonal disk, and the URL for regional disk. 2635 "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. 2636 "userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of URLs to the license resource. Unlike regular licenses, user provided licenses can be modified after the disk is created. 2637 "A String", 2638 ], 2639 }, 2640 ], 2641 "displayDevice": { # A set of Display Device options # Enables display device for the instance. 2642 "enableDisplay": True or False, # Defines whether the instance has Display enabled. 2643 }, 2644 "eraseWindowsVssSignature": True or False, # Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature. 2645 "fingerprint": "A String", # Specifies a fingerprint for this resource, which is essentially a hash of the instance'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. To see the latest fingerprint, make get() request to the instance. 2646 "guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance. 2647 { # A specification of the type and number of accelerator cards attached to the instance. 2648 "acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance. 2649 "acceleratorType": "A String", # 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. 2650 }, 2651 ], 2652 "hostname": "A String", # 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. 2653 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 2654 "kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances. 2655 "labelFingerprint": "A String", # A fingerprint for this request, which is essentially a hash of the label'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. To see the latest fingerprint, make get() request to the instance. 2656 "labels": { # Labels to apply to this instance. These can be later modified by the setLabels method. 2657 "a_key": "A String", 2658 }, 2659 "lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format. 2660 "lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format. 2661 "lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format. 2662 "machineType": "A String", # 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: zones/us-central1-f/machineTypes/n1-standard-1 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): zones/zone/machineTypes/custom-CPUS-MEMORY For example: zones/us-central1-f/machineTypes/custom-4-5120 For a full list of restrictions, read the Specifications for custom machine types. 2663 "metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys. 2664 "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata'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. To see the latest fingerprint, make a get() request to retrieve the resource. 2665 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB. 2666 { # Metadata 2667 "key": "A String", # 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. 2668 "value": "A String", # 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). 2669 }, 2670 ], 2671 "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata. 2672 }, 2673 "minCpuPlatform": "A String", # Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge". 2674 "name": "A String", # 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. 2675 "networkInterfaces": [ # 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. 2676 { # A network interface resource attached to an instance. 2677 "accessConfigs": [ # 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. 2678 { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. 2679 "externalIpv6": "A String", # 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. 2680 "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. 2681 "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. 2682 "name": "A String", # 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. 2683 "natIP": "A String", # 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. 2684 "networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. 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. 2685 "publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled in accessConfig. If this field is unspecified in ipv6AccessConfig, a default PTR record will be createc for first IP in associated external IPv6 range. 2686 "setPublicPtr": True or False, # Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. This field is not used in ipv6AccessConfig. A default PTR record will be created if the VM has external IPv6 range associated. 2687 "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT. 2688 }, 2689 ], 2690 "aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks. 2691 { # An alias IP range attached to an instance's network interface. 2692 "ipCidrRange": "A String", # 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). 2693 "subnetworkRangeName": "A String", # 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. 2694 }, 2695 ], 2696 "fingerprint": "A String", # 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. 2697 "ipv6AccessConfigs": [ # 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. 2698 { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. 2699 "externalIpv6": "A String", # 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. 2700 "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. 2701 "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. 2702 "name": "A String", # 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. 2703 "natIP": "A String", # 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. 2704 "networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. 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. 2705 "publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled in accessConfig. If this field is unspecified in ipv6AccessConfig, a default PTR record will be createc for first IP in associated external IPv6 range. 2706 "setPublicPtr": True or False, # Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. This field is not used in ipv6AccessConfig. A default PTR record will be created if the VM has external IPv6 range associated. 2707 "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT. 2708 }, 2709 ], 2710 "ipv6AccessType": "A String", # [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. Valid only if stackType is IPV4_IPV6. 2711 "ipv6Address": "A String", # An IPv6 internal network address for this network interface. 2712 "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. 2713 "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. 2714 "network": "A String", # URL of the VPC 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 selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default 2715 "networkIP": "A String", # 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. 2716 "nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. 2717 "queueCount": 42, # The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users. 2718 "stackType": "A String", # 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. This field can be both set at instance creation and update network interface operations. 2719 "subnetwork": "A String", # 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: - https://www.googleapis.com/compute/v1/projects/project/regions/region /subnetworks/subnetwork - regions/region/subnetworks/subnetwork 2720 }, 2721 ], 2722 "networkPerformanceConfig": { 2723 "totalEgressBandwidthTier": "A String", 2724 }, 2725 "params": { # Additional instance params. # Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. 2726 "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty. 2727 "a_key": "A String", 2728 }, 2729 }, 2730 "postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance. 2731 "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default. 2732 "reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from. 2733 "consumeReservationType": "A String", # 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. 2734 "key": "A String", # 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. 2735 "values": [ # Corresponds to the label values of a reservation resource. This can be either a name to a reservation in the same project or "projects/different-project/reservations/some-reservation-name" to target a shared reservation in the same zone but in a different project. 2736 "A String", 2737 ], 2738 }, 2739 "resourcePolicies": [ # Resource policies applied to this instance. 2740 "A String", 2741 ], 2742 "satisfiesPzs": True or False, # [Output Only] Reserved for future use. 2743 "scheduling": { # Sets the scheduling options for an Instance. NextID: 21 # Sets the scheduling options for this instance. 2744 "automaticRestart": 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. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. 2745 "hostErrorTimeoutSeconds": 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. 2746 "instanceTerminationAction": "A String", # Specifies the termination action for the instance. 2747 "locationHint": "A String", # 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. 2748 "maintenanceFreezeDurationHours": 42, # Specifies the number of hours after VM instance creation where the VM won't be scheduled for maintenance. 2749 "maintenanceInterval": "A String", # For more information about maintenance intervals, see Setting maintenance intervals. 2750 "minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. 2751 "nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity. 2752 { # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled. 2753 "key": "A String", # Corresponds to the label key of Node resource. 2754 "operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity. 2755 "values": [ # Corresponds to the label values of Node resource. 2756 "A String", 2757 ], 2758 }, 2759 ], 2760 "onHostMaintenance": "A String", # 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. 2761 "preemptible": 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. 2762 "provisioningModel": "A String", # Specifies the provisioning model of the instance. 2763 }, 2764 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 2765 "serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. 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. 2766 { # A service account. 2767 "email": "A String", # Email address of the service account. 2768 "scopes": [ # The list of scopes to be made available for this service account. 2769 "A String", 2770 ], 2771 }, 2772 ], 2773 "shieldedInstanceConfig": { # A set of Shielded Instance options. 2774 "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default. 2775 "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default. 2776 "enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default. 2777 }, 2778 "shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured. 2779 "updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot. 2780 }, 2781 "shieldedVmConfig": { # A set of Shielded VM options. # Deprecating, please use shielded_instance_config. 2782 "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. 2783 "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. 2784 "enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. 2785 }, 2786 "shieldedVmIntegrityPolicy": { # The policy describes the baseline against which VM instance boot integrity is measured. # Deprecating, please use shielded_instance_integrity_policy. 2787 "updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot. 2788 }, 2789 "sourceMachineImage": "A String", # Source machine image 2790 "sourceMachineImageEncryptionKey": { # Source machine image encryption key when creating an instance from a machine image. 2791 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key 2792 "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ 2793 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" 2794 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 2795 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 2796 }, 2797 "startRestricted": True or False, # [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity. 2798 "status": "A String", # [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. 2799 "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status. 2800 "tags": { # 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 'tags.items' field. 2801 "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the tags' 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. To see the latest fingerprint, make get() request to the instance. 2802 "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. 2803 "A String", 2804 ], 2805 }, 2806 "zone": "A String", # [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. 2807 }, 2808 ], 2809 "kind": "compute#instanceList", # [Output Only] Type of resource. Always compute#instanceList for lists of Instance resources. 2810 "nextPageToken": "A String", # [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. 2811 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 2812 "warning": { # [Output Only] Informational warning message. 2813 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 2814 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 2815 { 2816 "key": "A String", # [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). 2817 "value": "A String", # [Output Only] A warning data value corresponding to the key. 2818 }, 2819 ], 2820 "message": "A String", # [Output Only] A human-readable description of the warning code. 2821 }, 2822}</pre> 2823</div> 2824 2825<div class="method"> 2826 <code class="details" id="listReferrers">listReferrers(project, zone, instance, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 2827 <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. 2828 2829Args: 2830 project: string, Project ID for this request. (required) 2831 zone: string, The name of the zone for this request. (required) 2832 instance: string, Name of the target instance scoping this request, or '-' if the request should span over all instances in the container. (required) 2833 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You 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. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` 2834 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`) 2835 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. 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. Currently, only sorting by `name` or `creationTimestamp desc` is supported. 2836 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. 2837 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 2838 x__xgafv: string, V1 error format. 2839 Allowed values 2840 1 - v1 error format 2841 2 - v2 error format 2842 2843Returns: 2844 An object of the form: 2845 2846 { # Contains a list of instance referrers. 2847 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 2848 "items": [ # A list of Reference resources. 2849 { # Represents a reference to a resource. 2850 "kind": "compute#reference", # [Output Only] Type of the resource. Always compute#reference for references. 2851 "referenceType": "A String", # A description of the reference type with no implied semantics. Possible values include: 1. MEMBER_OF 2852 "referrer": "A String", # URL of the resource which refers to the target. 2853 "target": "A String", # URL of the resource to which this reference points. 2854 }, 2855 ], 2856 "kind": "compute#instanceListReferrers", # [Output Only] Type of resource. Always compute#instanceListReferrers for lists of Instance referrers. 2857 "nextPageToken": "A String", # [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. 2858 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 2859 "warning": { # [Output Only] Informational warning message. 2860 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 2861 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 2862 { 2863 "key": "A String", # [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). 2864 "value": "A String", # [Output Only] A warning data value corresponding to the key. 2865 }, 2866 ], 2867 "message": "A String", # [Output Only] A human-readable description of the warning code. 2868 }, 2869}</pre> 2870</div> 2871 2872<div class="method"> 2873 <code class="details" id="listReferrers_next">listReferrers_next(previous_request, previous_response)</code> 2874 <pre>Retrieves the next page of results. 2875 2876Args: 2877 previous_request: The request for the previous page. (required) 2878 previous_response: The response from the request for the previous page. (required) 2879 2880Returns: 2881 A request object that you can call 'execute()' on to request the next 2882 page. Returns None if there are no more items in the collection. 2883 </pre> 2884</div> 2885 2886<div class="method"> 2887 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 2888 <pre>Retrieves the next page of results. 2889 2890Args: 2891 previous_request: The request for the previous page. (required) 2892 previous_response: The response from the request for the previous page. (required) 2893 2894Returns: 2895 A request object that you can call 'execute()' on to request the next 2896 page. Returns None if there are no more items in the collection. 2897 </pre> 2898</div> 2899 2900<div class="method"> 2901 <code class="details" id="removeResourcePolicies">removeResourcePolicies(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code> 2902 <pre>Removes resource policies from an instance. 2903 2904Args: 2905 project: string, Project ID for this request. (required) 2906 zone: string, The name of the zone for this request. (required) 2907 instance: string, The instance name for this request. (required) 2908 body: object, The request body. 2909 The object takes the form of: 2910 2911{ 2912 "resourcePolicies": [ # Resource policies to be removed from this instance. 2913 "A String", 2914 ], 2915} 2916 2917 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 2918 x__xgafv: string, V1 error format. 2919 Allowed values 2920 1 - v1 error format 2921 2 - v2 error format 2922 2923Returns: 2924 An object of the form: 2925 2926 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 2927 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 2928 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 2929 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 2930 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 2931 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 2932 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 2933 { 2934 "code": "A String", # [Output Only] The error type identifier for this error. 2935 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 2936 "message": "A String", # [Output Only] An optional, human-readable error message. 2937 }, 2938 ], 2939 }, 2940 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 2941 "httpErrorStatusCode": 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. 2942 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 2943 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 2944 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 2945 "name": "A String", # [Output Only] Name of the operation. 2946 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 2947 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 2948 "progress": 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. 2949 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 2950 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 2951 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 2952 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 2953 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 2954 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 2955 "targetLink": "A String", # [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. 2956 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 2957 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 2958 { 2959 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 2960 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 2961 { 2962 "key": "A String", # [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). 2963 "value": "A String", # [Output Only] A warning data value corresponding to the key. 2964 }, 2965 ], 2966 "message": "A String", # [Output Only] A human-readable description of the warning code. 2967 }, 2968 ], 2969 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 2970}</pre> 2971</div> 2972 2973<div class="method"> 2974 <code class="details" id="reset">reset(project, zone, instance, requestId=None, x__xgafv=None)</code> 2975 <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. 2976 2977Args: 2978 project: string, Project ID for this request. (required) 2979 zone: string, The name of the zone for this request. (required) 2980 instance: string, Name of the instance scoping this request. (required) 2981 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 2982 x__xgafv: string, V1 error format. 2983 Allowed values 2984 1 - v1 error format 2985 2 - v2 error format 2986 2987Returns: 2988 An object of the form: 2989 2990 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 2991 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 2992 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 2993 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 2994 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 2995 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 2996 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 2997 { 2998 "code": "A String", # [Output Only] The error type identifier for this error. 2999 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 3000 "message": "A String", # [Output Only] An optional, human-readable error message. 3001 }, 3002 ], 3003 }, 3004 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 3005 "httpErrorStatusCode": 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. 3006 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 3007 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 3008 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 3009 "name": "A String", # [Output Only] Name of the operation. 3010 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 3011 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 3012 "progress": 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. 3013 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 3014 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 3015 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 3016 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 3017 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 3018 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 3019 "targetLink": "A String", # [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. 3020 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 3021 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 3022 { 3023 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 3024 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 3025 { 3026 "key": "A String", # [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). 3027 "value": "A String", # [Output Only] A warning data value corresponding to the key. 3028 }, 3029 ], 3030 "message": "A String", # [Output Only] A human-readable description of the warning code. 3031 }, 3032 ], 3033 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 3034}</pre> 3035</div> 3036 3037<div class="method"> 3038 <code class="details" id="resume">resume(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code> 3039 <pre>Resumes an instance that was suspended using the instances().suspend method. 3040 3041Args: 3042 project: string, Project ID for this request. (required) 3043 zone: string, The name of the zone for this request. (required) 3044 instance: string, Name of the instance resource to resume. (required) 3045 body: object, The request body. 3046 The object takes the form of: 3047 3048{ 3049 "disks": [ # Array of disks associated with this instance that are protected with a customer-supplied encryption key. In order to resume the instance, the disk url and its corresponding key must be provided. If the disk is not protected with a customer-supplied encryption key it should not be specified. 3050 { 3051 "diskEncryptionKey": { # Decrypts data associated with the disk with a customer-supplied encryption key. 3052 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key 3053 "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ 3054 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" 3055 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 3056 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 3057 }, 3058 "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. For example: "source": "/compute/v1/projects/project_id/zones/zone/disks/ disk_name 3059 }, 3060 ], 3061 "instanceEncryptionKey": { # Decrypts data associated with an instance that is protected with a customer-supplied encryption key. 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. 3062 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key 3063 "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ 3064 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" 3065 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 3066 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 3067 }, 3068} 3069 3070 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 3071 x__xgafv: string, V1 error format. 3072 Allowed values 3073 1 - v1 error format 3074 2 - v2 error format 3075 3076Returns: 3077 An object of the form: 3078 3079 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 3080 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 3081 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 3082 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 3083 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 3084 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 3085 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 3086 { 3087 "code": "A String", # [Output Only] The error type identifier for this error. 3088 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 3089 "message": "A String", # [Output Only] An optional, human-readable error message. 3090 }, 3091 ], 3092 }, 3093 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 3094 "httpErrorStatusCode": 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. 3095 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 3096 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 3097 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 3098 "name": "A String", # [Output Only] Name of the operation. 3099 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 3100 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 3101 "progress": 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. 3102 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 3103 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 3104 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 3105 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 3106 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 3107 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 3108 "targetLink": "A String", # [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. 3109 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 3110 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 3111 { 3112 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 3113 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 3114 { 3115 "key": "A String", # [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). 3116 "value": "A String", # [Output Only] A warning data value corresponding to the key. 3117 }, 3118 ], 3119 "message": "A String", # [Output Only] A human-readable description of the warning code. 3120 }, 3121 ], 3122 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 3123}</pre> 3124</div> 3125 3126<div class="method"> 3127 <code class="details" id="sendDiagnosticInterrupt">sendDiagnosticInterrupt(project, zone, instance, x__xgafv=None)</code> 3128 <pre>Sends diagnostic interrupt to the instance. 3129 3130Args: 3131 project: string, Project ID for this request. (required) 3132 zone: string, The name of the zone for this request. (required) 3133 instance: string, Name of the instance scoping this request. (required) 3134 x__xgafv: string, V1 error format. 3135 Allowed values 3136 1 - v1 error format 3137 2 - v2 error format 3138</pre> 3139</div> 3140 3141<div class="method"> 3142 <code class="details" id="setDeletionProtection">setDeletionProtection(project, zone, resource, deletionProtection=None, requestId=None, x__xgafv=None)</code> 3143 <pre>Sets deletion protection on the instance. 3144 3145Args: 3146 project: string, Project ID for this request. (required) 3147 zone: string, The name of the zone for this request. (required) 3148 resource: string, Name or id of the resource for this request. (required) 3149 deletionProtection: boolean, Whether the resource should be protected against deletion. 3150 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 3151 x__xgafv: string, V1 error format. 3152 Allowed values 3153 1 - v1 error format 3154 2 - v2 error format 3155 3156Returns: 3157 An object of the form: 3158 3159 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 3160 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 3161 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 3162 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 3163 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 3164 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 3165 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 3166 { 3167 "code": "A String", # [Output Only] The error type identifier for this error. 3168 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 3169 "message": "A String", # [Output Only] An optional, human-readable error message. 3170 }, 3171 ], 3172 }, 3173 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 3174 "httpErrorStatusCode": 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. 3175 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 3176 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 3177 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 3178 "name": "A String", # [Output Only] Name of the operation. 3179 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 3180 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 3181 "progress": 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. 3182 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 3183 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 3184 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 3185 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 3186 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 3187 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 3188 "targetLink": "A String", # [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. 3189 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 3190 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 3191 { 3192 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 3193 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 3194 { 3195 "key": "A String", # [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). 3196 "value": "A String", # [Output Only] A warning data value corresponding to the key. 3197 }, 3198 ], 3199 "message": "A String", # [Output Only] A human-readable description of the warning code. 3200 }, 3201 ], 3202 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 3203}</pre> 3204</div> 3205 3206<div class="method"> 3207 <code class="details" id="setDiskAutoDelete">setDiskAutoDelete(project, zone, instance, autoDelete, deviceName, requestId=None, x__xgafv=None)</code> 3208 <pre>Sets the auto-delete flag for a disk attached to an instance. 3209 3210Args: 3211 project: string, Project ID for this request. (required) 3212 zone: string, The name of the zone for this request. (required) 3213 instance: string, The instance name for this request. (required) 3214 autoDelete: boolean, Whether to auto-delete the disk when the instance is deleted. (required) 3215 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) 3216 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 3217 x__xgafv: string, V1 error format. 3218 Allowed values 3219 1 - v1 error format 3220 2 - v2 error format 3221 3222Returns: 3223 An object of the form: 3224 3225 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 3226 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 3227 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 3228 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 3229 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 3230 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 3231 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 3232 { 3233 "code": "A String", # [Output Only] The error type identifier for this error. 3234 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 3235 "message": "A String", # [Output Only] An optional, human-readable error message. 3236 }, 3237 ], 3238 }, 3239 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 3240 "httpErrorStatusCode": 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. 3241 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 3242 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 3243 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 3244 "name": "A String", # [Output Only] Name of the operation. 3245 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 3246 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 3247 "progress": 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. 3248 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 3249 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 3250 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 3251 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 3252 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 3253 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 3254 "targetLink": "A String", # [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. 3255 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 3256 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 3257 { 3258 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 3259 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 3260 { 3261 "key": "A String", # [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). 3262 "value": "A String", # [Output Only] A warning data value corresponding to the key. 3263 }, 3264 ], 3265 "message": "A String", # [Output Only] A human-readable description of the warning code. 3266 }, 3267 ], 3268 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 3269}</pre> 3270</div> 3271 3272<div class="method"> 3273 <code class="details" id="setIamPolicy">setIamPolicy(project, zone, resource, body=None, x__xgafv=None)</code> 3274 <pre>Sets the access control policy on the specified resource. Replaces any existing policy. 3275 3276Args: 3277 project: string, Project ID for this request. (required) 3278 zone: string, The name of the zone for this request. (required) 3279 resource: string, Name or id of the resource for this request. (required) 3280 body: object, The request body. 3281 The object takes the form of: 3282 3283{ 3284 "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. 3285 { # Associates `members`, or principals, with a `role`. 3286 "bindingId": "A String", # This is deprecated and has no effect. Do not use. 3287 "condition": { # 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. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" 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. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. 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 principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 3288 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 3289 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 3290 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 3291 "title": "A String", # 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. 3292 }, 3293 "members": [ # Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?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. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 3294 "A String", 3295 ], 3296 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 3297 }, 3298 ], 3299 "etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. 3300 "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals 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. 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). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. 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. 3301 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 3302 { # 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. 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. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:[email protected]" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts [email protected] from DATA_READ logging, and [email protected] from DATA_WRITE logging. 3303 "auditLogConfigs": [ # The configuration for logging of each type of permission. 3304 { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting [email protected] from DATA_READ logging. 3305 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. 3306 "A String", 3307 ], 3308 "ignoreChildExemptions": True or False, # This is deprecated and has no effect. Do not use. 3309 "logType": "A String", # The log type that this config enables. 3310 }, 3311 ], 3312 "exemptedMembers": [ # This is deprecated and has no effect. Do not use. 3313 "A String", 3314 ], 3315 "service": "A String", # 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. 3316 }, 3317 ], 3318 "bindings": [ # Associates a list of `members`, or principals, with 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 principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. 3319 { # Associates `members`, or principals, with a `role`. 3320 "bindingId": "A String", # This is deprecated and has no effect. Do not use. 3321 "condition": { # 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. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" 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. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. 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 principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 3322 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 3323 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 3324 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 3325 "title": "A String", # 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. 3326 }, 3327 "members": [ # Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?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. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 3328 "A String", 3329 ], 3330 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 3331 }, 3332 ], 3333 "etag": "A String", # `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. **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. 3334 "rules": [ # This is deprecated and has no effect. Do not use. 3335 { # This is deprecated and has no effect. Do not use. 3336 "action": "A String", # This is deprecated and has no effect. Do not use. 3337 "conditions": [ # This is deprecated and has no effect. Do not use. 3338 { # This is deprecated and has no effect. Do not use. 3339 "iam": "A String", # This is deprecated and has no effect. Do not use. 3340 "op": "A String", # This is deprecated and has no effect. Do not use. 3341 "svc": "A String", # This is deprecated and has no effect. Do not use. 3342 "sys": "A String", # This is deprecated and has no effect. Do not use. 3343 "values": [ # This is deprecated and has no effect. Do not use. 3344 "A String", 3345 ], 3346 }, 3347 ], 3348 "description": "A String", # This is deprecated and has no effect. Do not use. 3349 "ins": [ # This is deprecated and has no effect. Do not use. 3350 "A String", 3351 ], 3352 "logConfigs": [ # This is deprecated and has no effect. Do not use. 3353 { # This is deprecated and has no effect. Do not use. 3354 "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 3355 "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 3356 "permissionType": "A String", # This is deprecated and has no effect. Do not use. 3357 }, 3358 "logName": "A String", # This is deprecated and has no effect. Do not use. 3359 }, 3360 "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 3361 "customFields": [ # This is deprecated and has no effect. Do not use. 3362 { # This is deprecated and has no effect. Do not use. 3363 "name": "A String", # This is deprecated and has no effect. Do not use. 3364 "value": "A String", # This is deprecated and has no effect. Do not use. 3365 }, 3366 ], 3367 "field": "A String", # This is deprecated and has no effect. Do not use. 3368 "metric": "A String", # This is deprecated and has no effect. Do not use. 3369 }, 3370 "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 3371 "logMode": "A String", # This is deprecated and has no effect. Do not use. 3372 }, 3373 }, 3374 ], 3375 "notIns": [ # This is deprecated and has no effect. Do not use. 3376 "A String", 3377 ], 3378 "permissions": [ # This is deprecated and has no effect. Do not use. 3379 "A String", 3380 ], 3381 }, 3382 ], 3383 "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * 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 **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. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 3384 }, 3385} 3386 3387 x__xgafv: string, V1 error format. 3388 Allowed values 3389 1 - v1 error format 3390 2 - v2 error format 3391 3392Returns: 3393 An object of the form: 3394 3395 { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals 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. 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). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). 3396 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 3397 { # 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. 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. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:[email protected]" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts [email protected] from DATA_READ logging, and [email protected] from DATA_WRITE logging. 3398 "auditLogConfigs": [ # The configuration for logging of each type of permission. 3399 { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting [email protected] from DATA_READ logging. 3400 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. 3401 "A String", 3402 ], 3403 "ignoreChildExemptions": True or False, # This is deprecated and has no effect. Do not use. 3404 "logType": "A String", # The log type that this config enables. 3405 }, 3406 ], 3407 "exemptedMembers": [ # This is deprecated and has no effect. Do not use. 3408 "A String", 3409 ], 3410 "service": "A String", # 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. 3411 }, 3412 ], 3413 "bindings": [ # Associates a list of `members`, or principals, with 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 principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. 3414 { # Associates `members`, or principals, with a `role`. 3415 "bindingId": "A String", # This is deprecated and has no effect. Do not use. 3416 "condition": { # 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. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" 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. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. 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 principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 3417 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 3418 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 3419 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 3420 "title": "A String", # 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. 3421 }, 3422 "members": [ # Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?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. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 3423 "A String", 3424 ], 3425 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 3426 }, 3427 ], 3428 "etag": "A String", # `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. **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. 3429 "rules": [ # This is deprecated and has no effect. Do not use. 3430 { # This is deprecated and has no effect. Do not use. 3431 "action": "A String", # This is deprecated and has no effect. Do not use. 3432 "conditions": [ # This is deprecated and has no effect. Do not use. 3433 { # This is deprecated and has no effect. Do not use. 3434 "iam": "A String", # This is deprecated and has no effect. Do not use. 3435 "op": "A String", # This is deprecated and has no effect. Do not use. 3436 "svc": "A String", # This is deprecated and has no effect. Do not use. 3437 "sys": "A String", # This is deprecated and has no effect. Do not use. 3438 "values": [ # This is deprecated and has no effect. Do not use. 3439 "A String", 3440 ], 3441 }, 3442 ], 3443 "description": "A String", # This is deprecated and has no effect. Do not use. 3444 "ins": [ # This is deprecated and has no effect. Do not use. 3445 "A String", 3446 ], 3447 "logConfigs": [ # This is deprecated and has no effect. Do not use. 3448 { # This is deprecated and has no effect. Do not use. 3449 "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 3450 "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 3451 "permissionType": "A String", # This is deprecated and has no effect. Do not use. 3452 }, 3453 "logName": "A String", # This is deprecated and has no effect. Do not use. 3454 }, 3455 "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 3456 "customFields": [ # This is deprecated and has no effect. Do not use. 3457 { # This is deprecated and has no effect. Do not use. 3458 "name": "A String", # This is deprecated and has no effect. Do not use. 3459 "value": "A String", # This is deprecated and has no effect. Do not use. 3460 }, 3461 ], 3462 "field": "A String", # This is deprecated and has no effect. Do not use. 3463 "metric": "A String", # This is deprecated and has no effect. Do not use. 3464 }, 3465 "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 3466 "logMode": "A String", # This is deprecated and has no effect. Do not use. 3467 }, 3468 }, 3469 ], 3470 "notIns": [ # This is deprecated and has no effect. Do not use. 3471 "A String", 3472 ], 3473 "permissions": [ # This is deprecated and has no effect. Do not use. 3474 "A String", 3475 ], 3476 }, 3477 ], 3478 "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * 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 **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. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 3479}</pre> 3480</div> 3481 3482<div class="method"> 3483 <code class="details" id="setLabels">setLabels(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code> 3484 <pre>Sets labels on an instance. To learn more about labels, read the Labeling Resources documentation. 3485 3486Args: 3487 project: string, Project ID for this request. (required) 3488 zone: string, The name of the zone for this request. (required) 3489 instance: string, Name of the instance scoping this request. (required) 3490 body: object, The request body. 3491 The object takes the form of: 3492 3493{ 3494 "labelFingerprint": "A String", # 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. 3495 "labels": { 3496 "a_key": "A String", 3497 }, 3498} 3499 3500 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 3501 x__xgafv: string, V1 error format. 3502 Allowed values 3503 1 - v1 error format 3504 2 - v2 error format 3505 3506Returns: 3507 An object of the form: 3508 3509 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 3510 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 3511 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 3512 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 3513 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 3514 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 3515 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 3516 { 3517 "code": "A String", # [Output Only] The error type identifier for this error. 3518 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 3519 "message": "A String", # [Output Only] An optional, human-readable error message. 3520 }, 3521 ], 3522 }, 3523 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 3524 "httpErrorStatusCode": 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. 3525 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 3526 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 3527 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 3528 "name": "A String", # [Output Only] Name of the operation. 3529 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 3530 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 3531 "progress": 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. 3532 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 3533 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 3534 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 3535 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 3536 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 3537 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 3538 "targetLink": "A String", # [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. 3539 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 3540 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 3541 { 3542 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 3543 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 3544 { 3545 "key": "A String", # [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). 3546 "value": "A String", # [Output Only] A warning data value corresponding to the key. 3547 }, 3548 ], 3549 "message": "A String", # [Output Only] A human-readable description of the warning code. 3550 }, 3551 ], 3552 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 3553}</pre> 3554</div> 3555 3556<div class="method"> 3557 <code class="details" id="setMachineResources">setMachineResources(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code> 3558 <pre>Changes the number and/or type of accelerator for a stopped instance to the values specified in the request. 3559 3560Args: 3561 project: string, Project ID for this request. (required) 3562 zone: string, The name of the zone for this request. (required) 3563 instance: string, Name of the instance scoping this request. (required) 3564 body: object, The request body. 3565 The object takes the form of: 3566 3567{ 3568 "guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance. 3569 { # A specification of the type and number of accelerator cards attached to the instance. 3570 "acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance. 3571 "acceleratorType": "A String", # 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. 3572 }, 3573 ], 3574} 3575 3576 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 3577 x__xgafv: string, V1 error format. 3578 Allowed values 3579 1 - v1 error format 3580 2 - v2 error format 3581 3582Returns: 3583 An object of the form: 3584 3585 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 3586 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 3587 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 3588 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 3589 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 3590 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 3591 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 3592 { 3593 "code": "A String", # [Output Only] The error type identifier for this error. 3594 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 3595 "message": "A String", # [Output Only] An optional, human-readable error message. 3596 }, 3597 ], 3598 }, 3599 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 3600 "httpErrorStatusCode": 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. 3601 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 3602 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 3603 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 3604 "name": "A String", # [Output Only] Name of the operation. 3605 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 3606 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 3607 "progress": 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. 3608 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 3609 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 3610 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 3611 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 3612 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 3613 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 3614 "targetLink": "A String", # [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. 3615 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 3616 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 3617 { 3618 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 3619 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 3620 { 3621 "key": "A String", # [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). 3622 "value": "A String", # [Output Only] A warning data value corresponding to the key. 3623 }, 3624 ], 3625 "message": "A String", # [Output Only] A human-readable description of the warning code. 3626 }, 3627 ], 3628 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 3629}</pre> 3630</div> 3631 3632<div class="method"> 3633 <code class="details" id="setMachineType">setMachineType(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code> 3634 <pre>Changes the machine type for a stopped instance to the machine type specified in the request. 3635 3636Args: 3637 project: string, Project ID for this request. (required) 3638 zone: string, The name of the zone for this request. (required) 3639 instance: string, Name of the instance scoping this request. (required) 3640 body: object, The request body. 3641 The object takes the form of: 3642 3643{ 3644 "machineType": "A String", # 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 3645} 3646 3647 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 3648 x__xgafv: string, V1 error format. 3649 Allowed values 3650 1 - v1 error format 3651 2 - v2 error format 3652 3653Returns: 3654 An object of the form: 3655 3656 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 3657 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 3658 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 3659 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 3660 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 3661 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 3662 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 3663 { 3664 "code": "A String", # [Output Only] The error type identifier for this error. 3665 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 3666 "message": "A String", # [Output Only] An optional, human-readable error message. 3667 }, 3668 ], 3669 }, 3670 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 3671 "httpErrorStatusCode": 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. 3672 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 3673 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 3674 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 3675 "name": "A String", # [Output Only] Name of the operation. 3676 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 3677 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 3678 "progress": 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. 3679 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 3680 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 3681 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 3682 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 3683 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 3684 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 3685 "targetLink": "A String", # [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. 3686 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 3687 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 3688 { 3689 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 3690 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 3691 { 3692 "key": "A String", # [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). 3693 "value": "A String", # [Output Only] A warning data value corresponding to the key. 3694 }, 3695 ], 3696 "message": "A String", # [Output Only] A human-readable description of the warning code. 3697 }, 3698 ], 3699 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 3700}</pre> 3701</div> 3702 3703<div class="method"> 3704 <code class="details" id="setMetadata">setMetadata(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code> 3705 <pre>Sets metadata for the specified instance to the data included in the request. 3706 3707Args: 3708 project: string, Project ID for this request. (required) 3709 zone: string, The name of the zone for this request. (required) 3710 instance: string, Name of the instance scoping this request. (required) 3711 body: object, The request body. 3712 The object takes the form of: 3713 3714{ # A metadata key/value entry. 3715 "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata'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. To see the latest fingerprint, make a get() request to retrieve the resource. 3716 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB. 3717 { # Metadata 3718 "key": "A String", # 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. 3719 "value": "A String", # 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). 3720 }, 3721 ], 3722 "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata. 3723} 3724 3725 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 3726 x__xgafv: string, V1 error format. 3727 Allowed values 3728 1 - v1 error format 3729 2 - v2 error format 3730 3731Returns: 3732 An object of the form: 3733 3734 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 3735 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 3736 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 3737 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 3738 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 3739 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 3740 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 3741 { 3742 "code": "A String", # [Output Only] The error type identifier for this error. 3743 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 3744 "message": "A String", # [Output Only] An optional, human-readable error message. 3745 }, 3746 ], 3747 }, 3748 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 3749 "httpErrorStatusCode": 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. 3750 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 3751 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 3752 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 3753 "name": "A String", # [Output Only] Name of the operation. 3754 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 3755 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 3756 "progress": 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. 3757 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 3758 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 3759 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 3760 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 3761 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 3762 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 3763 "targetLink": "A String", # [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. 3764 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 3765 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 3766 { 3767 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 3768 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 3769 { 3770 "key": "A String", # [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). 3771 "value": "A String", # [Output Only] A warning data value corresponding to the key. 3772 }, 3773 ], 3774 "message": "A String", # [Output Only] A human-readable description of the warning code. 3775 }, 3776 ], 3777 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 3778}</pre> 3779</div> 3780 3781<div class="method"> 3782 <code class="details" id="setMinCpuPlatform">setMinCpuPlatform(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code> 3783 <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. 3784 3785Args: 3786 project: string, Project ID for this request. (required) 3787 zone: string, The name of the zone for this request. (required) 3788 instance: string, Name of the instance scoping this request. (required) 3789 body: object, The request body. 3790 The object takes the form of: 3791 3792{ 3793 "minCpuPlatform": "A String", # Minimum cpu/platform this instance should be started at. 3794} 3795 3796 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 3797 x__xgafv: string, V1 error format. 3798 Allowed values 3799 1 - v1 error format 3800 2 - v2 error format 3801 3802Returns: 3803 An object of the form: 3804 3805 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 3806 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 3807 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 3808 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 3809 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 3810 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 3811 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 3812 { 3813 "code": "A String", # [Output Only] The error type identifier for this error. 3814 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 3815 "message": "A String", # [Output Only] An optional, human-readable error message. 3816 }, 3817 ], 3818 }, 3819 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 3820 "httpErrorStatusCode": 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. 3821 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 3822 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 3823 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 3824 "name": "A String", # [Output Only] Name of the operation. 3825 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 3826 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 3827 "progress": 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. 3828 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 3829 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 3830 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 3831 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 3832 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 3833 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 3834 "targetLink": "A String", # [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. 3835 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 3836 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 3837 { 3838 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 3839 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 3840 { 3841 "key": "A String", # [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). 3842 "value": "A String", # [Output Only] A warning data value corresponding to the key. 3843 }, 3844 ], 3845 "message": "A String", # [Output Only] A human-readable description of the warning code. 3846 }, 3847 ], 3848 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 3849}</pre> 3850</div> 3851 3852<div class="method"> 3853 <code class="details" id="setName">setName(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code> 3854 <pre>Sets name of an instance. 3855 3856Args: 3857 project: string, Project ID for this request. (required) 3858 zone: string, The name of the zone for this request. (required) 3859 instance: string, The instance name for this request. (required) 3860 body: object, The request body. 3861 The object takes the form of: 3862 3863{ 3864 "currentName": "A String", # The current name of this resource, used to prevent conflicts. Provide the latest name when making a request to change name. 3865 "name": "A String", # The name to be applied to the instance. Needs to be RFC 1035 compliant. 3866} 3867 3868 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 3869 x__xgafv: string, V1 error format. 3870 Allowed values 3871 1 - v1 error format 3872 2 - v2 error format 3873 3874Returns: 3875 An object of the form: 3876 3877 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 3878 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 3879 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 3880 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 3881 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 3882 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 3883 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 3884 { 3885 "code": "A String", # [Output Only] The error type identifier for this error. 3886 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 3887 "message": "A String", # [Output Only] An optional, human-readable error message. 3888 }, 3889 ], 3890 }, 3891 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 3892 "httpErrorStatusCode": 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. 3893 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 3894 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 3895 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 3896 "name": "A String", # [Output Only] Name of the operation. 3897 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 3898 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 3899 "progress": 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. 3900 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 3901 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 3902 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 3903 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 3904 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 3905 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 3906 "targetLink": "A String", # [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. 3907 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 3908 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 3909 { 3910 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 3911 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 3912 { 3913 "key": "A String", # [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). 3914 "value": "A String", # [Output Only] A warning data value corresponding to the key. 3915 }, 3916 ], 3917 "message": "A String", # [Output Only] A human-readable description of the warning code. 3918 }, 3919 ], 3920 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 3921}</pre> 3922</div> 3923 3924<div class="method"> 3925 <code class="details" id="setScheduling">setScheduling(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code> 3926 <pre>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. 3927 3928Args: 3929 project: string, Project ID for this request. (required) 3930 zone: string, The name of the zone for this request. (required) 3931 instance: string, Instance name for this request. (required) 3932 body: object, The request body. 3933 The object takes the form of: 3934 3935{ # Sets the scheduling options for an Instance. NextID: 21 3936 "automaticRestart": 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. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. 3937 "hostErrorTimeoutSeconds": 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. 3938 "instanceTerminationAction": "A String", # Specifies the termination action for the instance. 3939 "locationHint": "A String", # 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. 3940 "maintenanceFreezeDurationHours": 42, # Specifies the number of hours after VM instance creation where the VM won't be scheduled for maintenance. 3941 "maintenanceInterval": "A String", # For more information about maintenance intervals, see Setting maintenance intervals. 3942 "minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. 3943 "nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity. 3944 { # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled. 3945 "key": "A String", # Corresponds to the label key of Node resource. 3946 "operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity. 3947 "values": [ # Corresponds to the label values of Node resource. 3948 "A String", 3949 ], 3950 }, 3951 ], 3952 "onHostMaintenance": "A String", # 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. 3953 "preemptible": 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. 3954 "provisioningModel": "A String", # Specifies the provisioning model of the instance. 3955} 3956 3957 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 3958 x__xgafv: string, V1 error format. 3959 Allowed values 3960 1 - v1 error format 3961 2 - v2 error format 3962 3963Returns: 3964 An object of the form: 3965 3966 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 3967 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 3968 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 3969 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 3970 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 3971 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 3972 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 3973 { 3974 "code": "A String", # [Output Only] The error type identifier for this error. 3975 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 3976 "message": "A String", # [Output Only] An optional, human-readable error message. 3977 }, 3978 ], 3979 }, 3980 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 3981 "httpErrorStatusCode": 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. 3982 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 3983 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 3984 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 3985 "name": "A String", # [Output Only] Name of the operation. 3986 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 3987 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 3988 "progress": 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. 3989 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 3990 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 3991 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 3992 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 3993 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 3994 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 3995 "targetLink": "A String", # [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. 3996 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 3997 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 3998 { 3999 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 4000 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 4001 { 4002 "key": "A String", # [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). 4003 "value": "A String", # [Output Only] A warning data value corresponding to the key. 4004 }, 4005 ], 4006 "message": "A String", # [Output Only] A human-readable description of the warning code. 4007 }, 4008 ], 4009 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 4010}</pre> 4011</div> 4012 4013<div class="method"> 4014 <code class="details" id="setServiceAccount">setServiceAccount(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code> 4015 <pre>Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance. 4016 4017Args: 4018 project: string, Project ID for this request. (required) 4019 zone: string, The name of the zone for this request. (required) 4020 instance: string, Name of the instance resource to start. (required) 4021 body: object, The request body. 4022 The object takes the form of: 4023 4024{ 4025 "email": "A String", # Email address of the service account. 4026 "scopes": [ # The list of scopes to be made available for this service account. 4027 "A String", 4028 ], 4029} 4030 4031 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 4032 x__xgafv: string, V1 error format. 4033 Allowed values 4034 1 - v1 error format 4035 2 - v2 error format 4036 4037Returns: 4038 An object of the form: 4039 4040 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 4041 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 4042 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 4043 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 4044 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 4045 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 4046 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 4047 { 4048 "code": "A String", # [Output Only] The error type identifier for this error. 4049 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 4050 "message": "A String", # [Output Only] An optional, human-readable error message. 4051 }, 4052 ], 4053 }, 4054 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 4055 "httpErrorStatusCode": 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. 4056 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 4057 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 4058 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 4059 "name": "A String", # [Output Only] Name of the operation. 4060 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 4061 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 4062 "progress": 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. 4063 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 4064 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 4065 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 4066 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 4067 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 4068 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 4069 "targetLink": "A String", # [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. 4070 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 4071 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 4072 { 4073 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 4074 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 4075 { 4076 "key": "A String", # [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). 4077 "value": "A String", # [Output Only] A warning data value corresponding to the key. 4078 }, 4079 ], 4080 "message": "A String", # [Output Only] A human-readable description of the warning code. 4081 }, 4082 ], 4083 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 4084}</pre> 4085</div> 4086 4087<div class="method"> 4088 <code class="details" id="setShieldedInstanceIntegrityPolicy">setShieldedInstanceIntegrityPolicy(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code> 4089 <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. 4090 4091Args: 4092 project: string, Project ID for this request. (required) 4093 zone: string, The name of the zone for this request. (required) 4094 instance: string, Name or id of the instance scoping this request. (required) 4095 body: object, The request body. 4096 The object takes the form of: 4097 4098{ # The policy describes the baseline against which Instance boot integrity is measured. 4099 "updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot. 4100} 4101 4102 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 4103 x__xgafv: string, V1 error format. 4104 Allowed values 4105 1 - v1 error format 4106 2 - v2 error format 4107 4108Returns: 4109 An object of the form: 4110 4111 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 4112 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 4113 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 4114 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 4115 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 4116 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 4117 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 4118 { 4119 "code": "A String", # [Output Only] The error type identifier for this error. 4120 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 4121 "message": "A String", # [Output Only] An optional, human-readable error message. 4122 }, 4123 ], 4124 }, 4125 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 4126 "httpErrorStatusCode": 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. 4127 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 4128 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 4129 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 4130 "name": "A String", # [Output Only] Name of the operation. 4131 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 4132 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 4133 "progress": 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. 4134 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 4135 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 4136 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 4137 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 4138 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 4139 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 4140 "targetLink": "A String", # [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. 4141 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 4142 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 4143 { 4144 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 4145 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 4146 { 4147 "key": "A String", # [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). 4148 "value": "A String", # [Output Only] A warning data value corresponding to the key. 4149 }, 4150 ], 4151 "message": "A String", # [Output Only] A human-readable description of the warning code. 4152 }, 4153 ], 4154 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 4155}</pre> 4156</div> 4157 4158<div class="method"> 4159 <code class="details" id="setShieldedVmIntegrityPolicy">setShieldedVmIntegrityPolicy(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code> 4160 <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. 4161 4162Args: 4163 project: string, Project ID for this request. (required) 4164 zone: string, The name of the zone for this request. (required) 4165 instance: string, Name of the instance scoping this request. (required) 4166 body: object, The request body. 4167 The object takes the form of: 4168 4169{ # The policy describes the baseline against which VM instance boot integrity is measured. 4170 "updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot. 4171} 4172 4173 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 4174 x__xgafv: string, V1 error format. 4175 Allowed values 4176 1 - v1 error format 4177 2 - v2 error format 4178 4179Returns: 4180 An object of the form: 4181 4182 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 4183 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 4184 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 4185 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 4186 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 4187 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 4188 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 4189 { 4190 "code": "A String", # [Output Only] The error type identifier for this error. 4191 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 4192 "message": "A String", # [Output Only] An optional, human-readable error message. 4193 }, 4194 ], 4195 }, 4196 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 4197 "httpErrorStatusCode": 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. 4198 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 4199 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 4200 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 4201 "name": "A String", # [Output Only] Name of the operation. 4202 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 4203 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 4204 "progress": 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. 4205 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 4206 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 4207 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 4208 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 4209 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 4210 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 4211 "targetLink": "A String", # [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. 4212 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 4213 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 4214 { 4215 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 4216 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 4217 { 4218 "key": "A String", # [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). 4219 "value": "A String", # [Output Only] A warning data value corresponding to the key. 4220 }, 4221 ], 4222 "message": "A String", # [Output Only] A human-readable description of the warning code. 4223 }, 4224 ], 4225 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 4226}</pre> 4227</div> 4228 4229<div class="method"> 4230 <code class="details" id="setTags">setTags(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code> 4231 <pre>Sets network tags for the specified instance to the data included in the request. 4232 4233Args: 4234 project: string, Project ID for this request. (required) 4235 zone: string, The name of the zone for this request. (required) 4236 instance: string, Name of the instance scoping this request. (required) 4237 body: object, The request body. 4238 The object takes the form of: 4239 4240{ # A set of instance tags. 4241 "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the tags' 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. To see the latest fingerprint, make get() request to the instance. 4242 "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. 4243 "A String", 4244 ], 4245} 4246 4247 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 4248 x__xgafv: string, V1 error format. 4249 Allowed values 4250 1 - v1 error format 4251 2 - v2 error format 4252 4253Returns: 4254 An object of the form: 4255 4256 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 4257 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 4258 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 4259 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 4260 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 4261 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 4262 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 4263 { 4264 "code": "A String", # [Output Only] The error type identifier for this error. 4265 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 4266 "message": "A String", # [Output Only] An optional, human-readable error message. 4267 }, 4268 ], 4269 }, 4270 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 4271 "httpErrorStatusCode": 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. 4272 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 4273 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 4274 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 4275 "name": "A String", # [Output Only] Name of the operation. 4276 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 4277 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 4278 "progress": 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. 4279 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 4280 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 4281 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 4282 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 4283 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 4284 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 4285 "targetLink": "A String", # [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. 4286 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 4287 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 4288 { 4289 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 4290 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 4291 { 4292 "key": "A String", # [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). 4293 "value": "A String", # [Output Only] A warning data value corresponding to the key. 4294 }, 4295 ], 4296 "message": "A String", # [Output Only] A human-readable description of the warning code. 4297 }, 4298 ], 4299 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 4300}</pre> 4301</div> 4302 4303<div class="method"> 4304 <code class="details" id="simulateMaintenanceEvent">simulateMaintenanceEvent(project, zone, instance, x__xgafv=None)</code> 4305 <pre>Simulates a maintenance event on the instance. 4306 4307Args: 4308 project: string, Project ID for this request. (required) 4309 zone: string, The name of the zone for this request. (required) 4310 instance: string, Name of the instance scoping this request. (required) 4311 x__xgafv: string, V1 error format. 4312 Allowed values 4313 1 - v1 error format 4314 2 - v2 error format 4315 4316Returns: 4317 An object of the form: 4318 4319 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 4320 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 4321 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 4322 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 4323 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 4324 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 4325 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 4326 { 4327 "code": "A String", # [Output Only] The error type identifier for this error. 4328 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 4329 "message": "A String", # [Output Only] An optional, human-readable error message. 4330 }, 4331 ], 4332 }, 4333 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 4334 "httpErrorStatusCode": 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. 4335 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 4336 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 4337 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 4338 "name": "A String", # [Output Only] Name of the operation. 4339 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 4340 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 4341 "progress": 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. 4342 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 4343 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 4344 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 4345 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 4346 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 4347 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 4348 "targetLink": "A String", # [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. 4349 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 4350 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 4351 { 4352 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 4353 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 4354 { 4355 "key": "A String", # [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). 4356 "value": "A String", # [Output Only] A warning data value corresponding to the key. 4357 }, 4358 ], 4359 "message": "A String", # [Output Only] A human-readable description of the warning code. 4360 }, 4361 ], 4362 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 4363}</pre> 4364</div> 4365 4366<div class="method"> 4367 <code class="details" id="start">start(project, zone, instance, requestId=None, x__xgafv=None)</code> 4368 <pre>Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance. 4369 4370Args: 4371 project: string, Project ID for this request. (required) 4372 zone: string, The name of the zone for this request. (required) 4373 instance: string, Name of the instance resource to start. (required) 4374 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 4375 x__xgafv: string, V1 error format. 4376 Allowed values 4377 1 - v1 error format 4378 2 - v2 error format 4379 4380Returns: 4381 An object of the form: 4382 4383 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 4384 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 4385 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 4386 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 4387 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 4388 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 4389 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 4390 { 4391 "code": "A String", # [Output Only] The error type identifier for this error. 4392 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 4393 "message": "A String", # [Output Only] An optional, human-readable error message. 4394 }, 4395 ], 4396 }, 4397 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 4398 "httpErrorStatusCode": 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. 4399 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 4400 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 4401 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 4402 "name": "A String", # [Output Only] Name of the operation. 4403 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 4404 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 4405 "progress": 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. 4406 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 4407 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 4408 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 4409 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 4410 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 4411 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 4412 "targetLink": "A String", # [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. 4413 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 4414 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 4415 { 4416 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 4417 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 4418 { 4419 "key": "A String", # [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). 4420 "value": "A String", # [Output Only] A warning data value corresponding to the key. 4421 }, 4422 ], 4423 "message": "A String", # [Output Only] A human-readable description of the warning code. 4424 }, 4425 ], 4426 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 4427}</pre> 4428</div> 4429 4430<div class="method"> 4431 <code class="details" id="startWithEncryptionKey">startWithEncryptionKey(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code> 4432 <pre>Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance. 4433 4434Args: 4435 project: string, Project ID for this request. (required) 4436 zone: string, The name of the zone for this request. (required) 4437 instance: string, Name of the instance resource to start. (required) 4438 body: object, The request body. 4439 The object takes the form of: 4440 4441{ 4442 "disks": [ # Array of disks associated with this instance that are protected with a customer-supplied encryption key. In order to start the instance, the disk url and its corresponding key must be provided. If the disk is not protected with a customer-supplied encryption key it should not be specified. 4443 { 4444 "diskEncryptionKey": { # Decrypts data associated with the disk with a customer-supplied encryption key. 4445 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key 4446 "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ 4447 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" 4448 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 4449 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 4450 }, 4451 "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. For example: "source": "/compute/v1/projects/project_id/zones/zone/disks/ disk_name 4452 }, 4453 ], 4454} 4455 4456 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 4457 x__xgafv: string, V1 error format. 4458 Allowed values 4459 1 - v1 error format 4460 2 - v2 error format 4461 4462Returns: 4463 An object of the form: 4464 4465 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 4466 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 4467 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 4468 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 4469 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 4470 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 4471 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 4472 { 4473 "code": "A String", # [Output Only] The error type identifier for this error. 4474 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 4475 "message": "A String", # [Output Only] An optional, human-readable error message. 4476 }, 4477 ], 4478 }, 4479 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 4480 "httpErrorStatusCode": 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. 4481 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 4482 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 4483 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 4484 "name": "A String", # [Output Only] Name of the operation. 4485 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 4486 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 4487 "progress": 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. 4488 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 4489 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 4490 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 4491 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 4492 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 4493 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 4494 "targetLink": "A String", # [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. 4495 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 4496 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 4497 { 4498 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 4499 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 4500 { 4501 "key": "A String", # [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). 4502 "value": "A String", # [Output Only] A warning data value corresponding to the key. 4503 }, 4504 ], 4505 "message": "A String", # [Output Only] A human-readable description of the warning code. 4506 }, 4507 ], 4508 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 4509}</pre> 4510</div> 4511 4512<div class="method"> 4513 <code class="details" id="stop">stop(project, zone, instance, requestId=None, x__xgafv=None)</code> 4514 <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. 4515 4516Args: 4517 project: string, Project ID for this request. (required) 4518 zone: string, The name of the zone for this request. (required) 4519 instance: string, Name of the instance resource to stop. (required) 4520 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 4521 x__xgafv: string, V1 error format. 4522 Allowed values 4523 1 - v1 error format 4524 2 - v2 error format 4525 4526Returns: 4527 An object of the form: 4528 4529 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 4530 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 4531 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 4532 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 4533 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 4534 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 4535 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 4536 { 4537 "code": "A String", # [Output Only] The error type identifier for this error. 4538 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 4539 "message": "A String", # [Output Only] An optional, human-readable error message. 4540 }, 4541 ], 4542 }, 4543 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 4544 "httpErrorStatusCode": 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. 4545 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 4546 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 4547 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 4548 "name": "A String", # [Output Only] Name of the operation. 4549 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 4550 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 4551 "progress": 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. 4552 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 4553 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 4554 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 4555 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 4556 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 4557 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 4558 "targetLink": "A String", # [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. 4559 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 4560 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 4561 { 4562 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 4563 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 4564 { 4565 "key": "A String", # [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). 4566 "value": "A String", # [Output Only] A warning data value corresponding to the key. 4567 }, 4568 ], 4569 "message": "A String", # [Output Only] A human-readable description of the warning code. 4570 }, 4571 ], 4572 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 4573}</pre> 4574</div> 4575 4576<div class="method"> 4577 <code class="details" id="suspend">suspend(project, zone, instance, discardLocalSsd=None, requestId=None, x__xgafv=None)</code> 4578 <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. For more information, see Suspending and resuming an instance. 4579 4580Args: 4581 project: string, Project ID for this request. (required) 4582 zone: string, The name of the zone for this request. (required) 4583 instance: string, Name of the instance resource to suspend. (required) 4584 discardLocalSsd: boolean, If true, discard the contents of any attached localSSD partitions. Default value is false (== preserve localSSD data). 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 4586 x__xgafv: string, V1 error format. 4587 Allowed values 4588 1 - v1 error format 4589 2 - v2 error format 4590 4591Returns: 4592 An object of the form: 4593 4594 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 4595 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 4596 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 4597 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 4598 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 4599 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 4600 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 4601 { 4602 "code": "A String", # [Output Only] The error type identifier for this error. 4603 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 4604 "message": "A String", # [Output Only] An optional, human-readable error message. 4605 }, 4606 ], 4607 }, 4608 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 4609 "httpErrorStatusCode": 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. 4610 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 4611 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 4612 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 4613 "name": "A String", # [Output Only] Name of the operation. 4614 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 4615 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 4616 "progress": 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. 4617 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 4618 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 4619 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 4620 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 4621 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 4622 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 4623 "targetLink": "A String", # [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. 4624 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 4625 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 4626 { 4627 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 4628 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 4629 { 4630 "key": "A String", # [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). 4631 "value": "A String", # [Output Only] A warning data value corresponding to the key. 4632 }, 4633 ], 4634 "message": "A String", # [Output Only] A human-readable description of the warning code. 4635 }, 4636 ], 4637 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 4638}</pre> 4639</div> 4640 4641<div class="method"> 4642 <code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body=None, x__xgafv=None)</code> 4643 <pre>Returns permissions that a caller has on the specified resource. 4644 4645Args: 4646 project: string, Project ID for this request. (required) 4647 zone: string, The name of the zone for this request. (required) 4648 resource: string, Name or id of the resource for this request. (required) 4649 body: object, The request body. 4650 The object takes the form of: 4651 4652{ 4653 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 4654 "A String", 4655 ], 4656} 4657 4658 x__xgafv: string, V1 error format. 4659 Allowed values 4660 1 - v1 error format 4661 2 - v2 error format 4662 4663Returns: 4664 An object of the form: 4665 4666 { 4667 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 4668 "A String", 4669 ], 4670}</pre> 4671</div> 4672 4673<div class="method"> 4674 <code class="details" id="update">update(project, zone, instance, body=None, minimalAction=None, mostDisruptiveAllowedAction=None, requestId=None, x__xgafv=None)</code> 4675 <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. 4676 4677Args: 4678 project: string, Project ID for this request. (required) 4679 zone: string, The name of the zone for this request. (required) 4680 instance: string, Name of the instance resource to update. (required) 4681 body: object, The request body. 4682 The object takes the form of: 4683 4684{ # Represents an Instance resource. An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. 4685 "advancedMachineFeatures": { # 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. 4686 "enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false). 4687 "threadsPerCore": 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. 4688 }, 4689 "canIpForward": 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 . 4690 "confidentialInstanceConfig": { # A set of Confidential Instance options. 4691 "enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled. 4692 }, 4693 "cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance. 4694 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 4695 "deletionProtection": True or False, # Whether the resource should be protected against deletion. 4696 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 4697 "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them. 4698 { # An instance-attached disk resource. 4699 "autoDelete": 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). 4700 "boot": 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. 4701 "deviceName": "A String", # 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. 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. 4702 "diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key. 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. 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. 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. Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group. 4703 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key 4704 "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ 4705 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" 4706 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 4707 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 4708 }, 4709 "diskSizeGb": "A String", # The size of the disk in GB. 4710 "guestOsFeatures": [ # 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. 4711 { # Guest OS features. 4712 "type": "A String", # The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - SECURE_BOOT - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE For more information, see Enabling guest operating system features. 4713 }, 4714 ], 4715 "index": 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. 4716 "initializeParams": { # [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. This property is mutually exclusive with the source property; you can only define one or the other, but not both. # [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. This property is mutually exclusive with the source property; you can only define one or the other, but not both. 4717 "description": "A String", # An optional description. Provide this property when creating the disk. 4718 "diskName": "A String", # 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. 4719 "diskSizeGb": "A String", # 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. 4720 "diskType": "A String", # 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: https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you define this field, you can provide either the full or partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL. 4721 "guestOsFeatures": [ # 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. Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures 4722 { # Guest OS features. 4723 "type": "A String", # The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - SECURE_BOOT - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE For more information, see Enabling guest operating system features. 4724 }, 4725 ], 4726 "labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. 4727 "a_key": "A String", 4728 }, 4729 "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. 4730 "A String", 4731 ], 4732 "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance. 4733 "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk. 4734 "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation. 4735 "resourcePolicies": [ # 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. 4736 "A String", 4737 ], 4738 "sourceImage": "A String", # 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. 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: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image 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: global/images/family/my-image-family If the source image is deleted later, this field will not be set. 4739 "sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. 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. 4740 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key 4741 "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ 4742 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" 4743 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 4744 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 4745 }, 4746 "sourceSnapshot": "A String", # 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. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set. 4747 "sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot. 4748 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key 4749 "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ 4750 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" 4751 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 4752 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 4753 }, 4754 }, 4755 "interface": "A String", # 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. 4756 "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks. 4757 "licenses": [ # [Output Only] Any valid publicly visible licenses. 4758 "A String", 4759 ], 4760 "locked": True or False, # [Output Only] Whether to indicate the attached disk is locked. The locked disk is not allowed to be detached from the instance, or to be used as the source of the snapshot creation, and the image creation. The instance with at least one locked attached disk is not allow to be used as source of machine image creation, instant snapshot creation, and not allowed to be deleted with --keep-disk parameter set to true for locked disks. 4761 "mode": "A String", # 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. 4762 "shieldedInstanceInitialState": { # 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 4763 "dbs": [ # The Key Database (db). 4764 { 4765 "content": "A String", # The raw content in the secure keys file. 4766 "fileType": "A String", # The file type of source file. 4767 }, 4768 ], 4769 "dbxs": [ # The forbidden key database (dbx). 4770 { 4771 "content": "A String", # The raw content in the secure keys file. 4772 "fileType": "A String", # The file type of source file. 4773 }, 4774 ], 4775 "keks": [ # The Key Exchange Key (KEK). 4776 { 4777 "content": "A String", # The raw content in the secure keys file. 4778 "fileType": "A String", # The file type of source file. 4779 }, 4780 ], 4781 "pk": { # The Platform Key (PK). 4782 "content": "A String", # The raw content in the secure keys file. 4783 "fileType": "A String", # The file type of source file. 4784 }, 4785 }, 4786 "source": "A String", # 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. If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. Note that for InstanceTemplate, specify the disk name for zonal disk, and the URL for regional disk. 4787 "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. 4788 "userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of URLs to the license resource. Unlike regular licenses, user provided licenses can be modified after the disk is created. 4789 "A String", 4790 ], 4791 }, 4792 ], 4793 "displayDevice": { # A set of Display Device options # Enables display device for the instance. 4794 "enableDisplay": True or False, # Defines whether the instance has Display enabled. 4795 }, 4796 "eraseWindowsVssSignature": True or False, # Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature. 4797 "fingerprint": "A String", # Specifies a fingerprint for this resource, which is essentially a hash of the instance'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. To see the latest fingerprint, make get() request to the instance. 4798 "guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance. 4799 { # A specification of the type and number of accelerator cards attached to the instance. 4800 "acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance. 4801 "acceleratorType": "A String", # 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. 4802 }, 4803 ], 4804 "hostname": "A String", # 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. 4805 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 4806 "kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances. 4807 "labelFingerprint": "A String", # A fingerprint for this request, which is essentially a hash of the label'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. To see the latest fingerprint, make get() request to the instance. 4808 "labels": { # Labels to apply to this instance. These can be later modified by the setLabels method. 4809 "a_key": "A String", 4810 }, 4811 "lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format. 4812 "lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format. 4813 "lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format. 4814 "machineType": "A String", # 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: zones/us-central1-f/machineTypes/n1-standard-1 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): zones/zone/machineTypes/custom-CPUS-MEMORY For example: zones/us-central1-f/machineTypes/custom-4-5120 For a full list of restrictions, read the Specifications for custom machine types. 4815 "metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys. 4816 "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata'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. To see the latest fingerprint, make a get() request to retrieve the resource. 4817 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB. 4818 { # Metadata 4819 "key": "A String", # 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. 4820 "value": "A String", # 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). 4821 }, 4822 ], 4823 "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata. 4824 }, 4825 "minCpuPlatform": "A String", # Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge". 4826 "name": "A String", # 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. 4827 "networkInterfaces": [ # 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. 4828 { # A network interface resource attached to an instance. 4829 "accessConfigs": [ # 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. 4830 { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. 4831 "externalIpv6": "A String", # 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. 4832 "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. 4833 "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. 4834 "name": "A String", # 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. 4835 "natIP": "A String", # 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. 4836 "networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. 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. 4837 "publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled in accessConfig. If this field is unspecified in ipv6AccessConfig, a default PTR record will be createc for first IP in associated external IPv6 range. 4838 "setPublicPtr": True or False, # Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. This field is not used in ipv6AccessConfig. A default PTR record will be created if the VM has external IPv6 range associated. 4839 "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT. 4840 }, 4841 ], 4842 "aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks. 4843 { # An alias IP range attached to an instance's network interface. 4844 "ipCidrRange": "A String", # 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). 4845 "subnetworkRangeName": "A String", # 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. 4846 }, 4847 ], 4848 "fingerprint": "A String", # 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. 4849 "ipv6AccessConfigs": [ # 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. 4850 { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. 4851 "externalIpv6": "A String", # 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. 4852 "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. 4853 "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. 4854 "name": "A String", # 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. 4855 "natIP": "A String", # 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. 4856 "networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. 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. 4857 "publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled in accessConfig. If this field is unspecified in ipv6AccessConfig, a default PTR record will be createc for first IP in associated external IPv6 range. 4858 "setPublicPtr": True or False, # Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. This field is not used in ipv6AccessConfig. A default PTR record will be created if the VM has external IPv6 range associated. 4859 "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT. 4860 }, 4861 ], 4862 "ipv6AccessType": "A String", # [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. Valid only if stackType is IPV4_IPV6. 4863 "ipv6Address": "A String", # An IPv6 internal network address for this network interface. 4864 "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. 4865 "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. 4866 "network": "A String", # URL of the VPC 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 selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default 4867 "networkIP": "A String", # 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. 4868 "nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. 4869 "queueCount": 42, # The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users. 4870 "stackType": "A String", # 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. This field can be both set at instance creation and update network interface operations. 4871 "subnetwork": "A String", # 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: - https://www.googleapis.com/compute/v1/projects/project/regions/region /subnetworks/subnetwork - regions/region/subnetworks/subnetwork 4872 }, 4873 ], 4874 "networkPerformanceConfig": { 4875 "totalEgressBandwidthTier": "A String", 4876 }, 4877 "params": { # Additional instance params. # Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. 4878 "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty. 4879 "a_key": "A String", 4880 }, 4881 }, 4882 "postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance. 4883 "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default. 4884 "reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from. 4885 "consumeReservationType": "A String", # 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. 4886 "key": "A String", # 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. 4887 "values": [ # Corresponds to the label values of a reservation resource. This can be either a name to a reservation in the same project or "projects/different-project/reservations/some-reservation-name" to target a shared reservation in the same zone but in a different project. 4888 "A String", 4889 ], 4890 }, 4891 "resourcePolicies": [ # Resource policies applied to this instance. 4892 "A String", 4893 ], 4894 "satisfiesPzs": True or False, # [Output Only] Reserved for future use. 4895 "scheduling": { # Sets the scheduling options for an Instance. NextID: 21 # Sets the scheduling options for this instance. 4896 "automaticRestart": 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. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. 4897 "hostErrorTimeoutSeconds": 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. 4898 "instanceTerminationAction": "A String", # Specifies the termination action for the instance. 4899 "locationHint": "A String", # 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. 4900 "maintenanceFreezeDurationHours": 42, # Specifies the number of hours after VM instance creation where the VM won't be scheduled for maintenance. 4901 "maintenanceInterval": "A String", # For more information about maintenance intervals, see Setting maintenance intervals. 4902 "minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. 4903 "nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity. 4904 { # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled. 4905 "key": "A String", # Corresponds to the label key of Node resource. 4906 "operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity. 4907 "values": [ # Corresponds to the label values of Node resource. 4908 "A String", 4909 ], 4910 }, 4911 ], 4912 "onHostMaintenance": "A String", # 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. 4913 "preemptible": 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. 4914 "provisioningModel": "A String", # Specifies the provisioning model of the instance. 4915 }, 4916 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 4917 "serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. 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. 4918 { # A service account. 4919 "email": "A String", # Email address of the service account. 4920 "scopes": [ # The list of scopes to be made available for this service account. 4921 "A String", 4922 ], 4923 }, 4924 ], 4925 "shieldedInstanceConfig": { # A set of Shielded Instance options. 4926 "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default. 4927 "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default. 4928 "enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default. 4929 }, 4930 "shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured. 4931 "updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot. 4932 }, 4933 "shieldedVmConfig": { # A set of Shielded VM options. # Deprecating, please use shielded_instance_config. 4934 "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. 4935 "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. 4936 "enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. 4937 }, 4938 "shieldedVmIntegrityPolicy": { # The policy describes the baseline against which VM instance boot integrity is measured. # Deprecating, please use shielded_instance_integrity_policy. 4939 "updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot. 4940 }, 4941 "sourceMachineImage": "A String", # Source machine image 4942 "sourceMachineImageEncryptionKey": { # Source machine image encryption key when creating an instance from a machine image. 4943 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key 4944 "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ 4945 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" 4946 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 4947 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 4948 }, 4949 "startRestricted": True or False, # [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity. 4950 "status": "A String", # [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. 4951 "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status. 4952 "tags": { # 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 'tags.items' field. 4953 "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the tags' 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. To see the latest fingerprint, make get() request to the instance. 4954 "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. 4955 "A String", 4956 ], 4957 }, 4958 "zone": "A String", # [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. 4959} 4960 4961 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. 4962 Allowed values 4963 INVALID - 4964 NO_EFFECT - No changes can be made to the instance. 4965 REFRESH - The instance will not restart. 4966 RESTART - The instance will restart. 4967 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. 4968 Allowed values 4969 INVALID - 4970 NO_EFFECT - No changes can be made to the instance. 4971 REFRESH - The instance will not restart. 4972 RESTART - The instance will restart. 4973 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 4974 x__xgafv: string, V1 error format. 4975 Allowed values 4976 1 - v1 error format 4977 2 - v2 error format 4978 4979Returns: 4980 An object of the form: 4981 4982 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 4983 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 4984 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 4985 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 4986 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 4987 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 4988 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 4989 { 4990 "code": "A String", # [Output Only] The error type identifier for this error. 4991 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 4992 "message": "A String", # [Output Only] An optional, human-readable error message. 4993 }, 4994 ], 4995 }, 4996 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 4997 "httpErrorStatusCode": 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. 4998 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 4999 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 5000 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 5001 "name": "A String", # [Output Only] Name of the operation. 5002 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 5003 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 5004 "progress": 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. 5005 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 5006 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 5007 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 5008 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 5009 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 5010 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 5011 "targetLink": "A String", # [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. 5012 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 5013 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 5014 { 5015 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 5016 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 5017 { 5018 "key": "A String", # [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). 5019 "value": "A String", # [Output Only] A warning data value corresponding to the key. 5020 }, 5021 ], 5022 "message": "A String", # [Output Only] A human-readable description of the warning code. 5023 }, 5024 ], 5025 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 5026}</pre> 5027</div> 5028 5029<div class="method"> 5030 <code class="details" id="updateAccessConfig">updateAccessConfig(project, zone, instance, networkInterface, body=None, requestId=None, x__xgafv=None)</code> 5031 <pre>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. 5032 5033Args: 5034 project: string, Project ID for this request. (required) 5035 zone: string, The name of the zone for this request. (required) 5036 instance: string, The instance name for this request. (required) 5037 networkInterface: string, The name of the network interface where the access config is attached. (required) 5038 body: object, The request body. 5039 The object takes the form of: 5040 5041{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported. 5042 "externalIpv6": "A String", # 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. 5043 "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. 5044 "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. 5045 "name": "A String", # 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. 5046 "natIP": "A String", # 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. 5047 "networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. 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. 5048 "publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled in accessConfig. If this field is unspecified in ipv6AccessConfig, a default PTR record will be createc for first IP in associated external IPv6 range. 5049 "setPublicPtr": True or False, # Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. This field is not used in ipv6AccessConfig. A default PTR record will be created if the VM has external IPv6 range associated. 5050 "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT. 5051} 5052 5053 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 5054 x__xgafv: string, V1 error format. 5055 Allowed values 5056 1 - v1 error format 5057 2 - v2 error format 5058 5059Returns: 5060 An object of the form: 5061 5062 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 5063 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 5064 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 5065 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 5066 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 5067 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 5068 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 5069 { 5070 "code": "A String", # [Output Only] The error type identifier for this error. 5071 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 5072 "message": "A String", # [Output Only] An optional, human-readable error message. 5073 }, 5074 ], 5075 }, 5076 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 5077 "httpErrorStatusCode": 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. 5078 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 5079 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 5080 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 5081 "name": "A String", # [Output Only] Name of the operation. 5082 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 5083 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 5084 "progress": 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. 5085 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 5086 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 5087 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 5088 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 5089 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 5090 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 5091 "targetLink": "A String", # [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. 5092 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 5093 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 5094 { 5095 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 5096 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 5097 { 5098 "key": "A String", # [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). 5099 "value": "A String", # [Output Only] A warning data value corresponding to the key. 5100 }, 5101 ], 5102 "message": "A String", # [Output Only] A human-readable description of the warning code. 5103 }, 5104 ], 5105 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 5106}</pre> 5107</div> 5108 5109<div class="method"> 5110 <code class="details" id="updateDisplayDevice">updateDisplayDevice(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code> 5111 <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. 5112 5113Args: 5114 project: string, Project ID for this request. (required) 5115 zone: string, The name of the zone for this request. (required) 5116 instance: string, Name of the instance scoping this request. (required) 5117 body: object, The request body. 5118 The object takes the form of: 5119 5120{ # A set of Display Device options 5121 "enableDisplay": True or False, # Defines whether the instance has Display enabled. 5122} 5123 5124 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 5125 x__xgafv: string, V1 error format. 5126 Allowed values 5127 1 - v1 error format 5128 2 - v2 error format 5129 5130Returns: 5131 An object of the form: 5132 5133 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 5134 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 5135 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 5136 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 5137 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 5138 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 5139 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 5140 { 5141 "code": "A String", # [Output Only] The error type identifier for this error. 5142 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 5143 "message": "A String", # [Output Only] An optional, human-readable error message. 5144 }, 5145 ], 5146 }, 5147 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 5148 "httpErrorStatusCode": 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. 5149 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 5150 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 5151 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 5152 "name": "A String", # [Output Only] Name of the operation. 5153 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 5154 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 5155 "progress": 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. 5156 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 5157 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 5158 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 5159 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 5160 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 5161 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 5162 "targetLink": "A String", # [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. 5163 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 5164 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 5165 { 5166 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 5167 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 5168 { 5169 "key": "A String", # [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). 5170 "value": "A String", # [Output Only] A warning data value corresponding to the key. 5171 }, 5172 ], 5173 "message": "A String", # [Output Only] A human-readable description of the warning code. 5174 }, 5175 ], 5176 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 5177}</pre> 5178</div> 5179 5180<div class="method"> 5181 <code class="details" id="updateNetworkInterface">updateNetworkInterface(project, zone, instance, networkInterface, body=None, requestId=None, x__xgafv=None)</code> 5182 <pre>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. 5183 5184Args: 5185 project: string, Project ID for this request. (required) 5186 zone: string, The name of the zone for this request. (required) 5187 instance: string, The instance name for this request. (required) 5188 networkInterface: string, The name of the network interface to update. (required) 5189 body: object, The request body. 5190 The object takes the form of: 5191 5192{ # A network interface resource attached to an instance. 5193 "accessConfigs": [ # 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. 5194 { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. 5195 "externalIpv6": "A String", # 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. 5196 "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. 5197 "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. 5198 "name": "A String", # 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. 5199 "natIP": "A String", # 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. 5200 "networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. 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. 5201 "publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled in accessConfig. If this field is unspecified in ipv6AccessConfig, a default PTR record will be createc for first IP in associated external IPv6 range. 5202 "setPublicPtr": True or False, # Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. This field is not used in ipv6AccessConfig. A default PTR record will be created if the VM has external IPv6 range associated. 5203 "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT. 5204 }, 5205 ], 5206 "aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks. 5207 { # An alias IP range attached to an instance's network interface. 5208 "ipCidrRange": "A String", # 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). 5209 "subnetworkRangeName": "A String", # 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. 5210 }, 5211 ], 5212 "fingerprint": "A String", # 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. 5213 "ipv6AccessConfigs": [ # 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. 5214 { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. 5215 "externalIpv6": "A String", # 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. 5216 "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. 5217 "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. 5218 "name": "A String", # 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. 5219 "natIP": "A String", # 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. 5220 "networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. 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. 5221 "publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled in accessConfig. If this field is unspecified in ipv6AccessConfig, a default PTR record will be createc for first IP in associated external IPv6 range. 5222 "setPublicPtr": True or False, # Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. This field is not used in ipv6AccessConfig. A default PTR record will be created if the VM has external IPv6 range associated. 5223 "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT. 5224 }, 5225 ], 5226 "ipv6AccessType": "A String", # [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. Valid only if stackType is IPV4_IPV6. 5227 "ipv6Address": "A String", # An IPv6 internal network address for this network interface. 5228 "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. 5229 "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. 5230 "network": "A String", # URL of the VPC 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 selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default 5231 "networkIP": "A String", # 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. 5232 "nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. 5233 "queueCount": 42, # The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users. 5234 "stackType": "A String", # 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. This field can be both set at instance creation and update network interface operations. 5235 "subnetwork": "A String", # 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: - https://www.googleapis.com/compute/v1/projects/project/regions/region /subnetworks/subnetwork - regions/region/subnetworks/subnetwork 5236} 5237 5238 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 5239 x__xgafv: string, V1 error format. 5240 Allowed values 5241 1 - v1 error format 5242 2 - v2 error format 5243 5244Returns: 5245 An object of the form: 5246 5247 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 5248 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 5249 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 5250 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 5251 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 5252 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 5253 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 5254 { 5255 "code": "A String", # [Output Only] The error type identifier for this error. 5256 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 5257 "message": "A String", # [Output Only] An optional, human-readable error message. 5258 }, 5259 ], 5260 }, 5261 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 5262 "httpErrorStatusCode": 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. 5263 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 5264 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 5265 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 5266 "name": "A String", # [Output Only] Name of the operation. 5267 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 5268 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 5269 "progress": 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. 5270 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 5271 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 5272 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 5273 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 5274 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 5275 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 5276 "targetLink": "A String", # [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. 5277 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 5278 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 5279 { 5280 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 5281 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 5282 { 5283 "key": "A String", # [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). 5284 "value": "A String", # [Output Only] A warning data value corresponding to the key. 5285 }, 5286 ], 5287 "message": "A String", # [Output Only] A human-readable description of the warning code. 5288 }, 5289 ], 5290 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 5291}</pre> 5292</div> 5293 5294<div class="method"> 5295 <code class="details" id="updateShieldedInstanceConfig">updateShieldedInstanceConfig(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code> 5296 <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. 5297 5298Args: 5299 project: string, Project ID for this request. (required) 5300 zone: string, The name of the zone for this request. (required) 5301 instance: string, Name or id of the instance scoping this request. (required) 5302 body: object, The request body. 5303 The object takes the form of: 5304 5305{ # A set of Shielded Instance options. 5306 "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default. 5307 "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default. 5308 "enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default. 5309} 5310 5311 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 5312 x__xgafv: string, V1 error format. 5313 Allowed values 5314 1 - v1 error format 5315 2 - v2 error format 5316 5317Returns: 5318 An object of the form: 5319 5320 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 5321 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 5322 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 5323 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 5324 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 5325 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 5326 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 5327 { 5328 "code": "A String", # [Output Only] The error type identifier for this error. 5329 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 5330 "message": "A String", # [Output Only] An optional, human-readable error message. 5331 }, 5332 ], 5333 }, 5334 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 5335 "httpErrorStatusCode": 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. 5336 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 5337 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 5338 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 5339 "name": "A String", # [Output Only] Name of the operation. 5340 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 5341 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 5342 "progress": 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. 5343 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 5344 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 5345 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 5346 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 5347 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 5348 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 5349 "targetLink": "A String", # [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. 5350 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 5351 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 5352 { 5353 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 5354 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 5355 { 5356 "key": "A String", # [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). 5357 "value": "A String", # [Output Only] A warning data value corresponding to the key. 5358 }, 5359 ], 5360 "message": "A String", # [Output Only] A human-readable description of the warning code. 5361 }, 5362 ], 5363 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 5364}</pre> 5365</div> 5366 5367<div class="method"> 5368 <code class="details" id="updateShieldedVmConfig">updateShieldedVmConfig(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code> 5369 <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. 5370 5371Args: 5372 project: string, Project ID for this request. (required) 5373 zone: string, The name of the zone for this request. (required) 5374 instance: string, Name of the instance scoping this request. (required) 5375 body: object, The request body. 5376 The object takes the form of: 5377 5378{ # A set of Shielded VM options. 5379 "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. 5380 "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. 5381 "enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. 5382} 5383 5384 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 5385 x__xgafv: string, V1 error format. 5386 Allowed values 5387 1 - v1 error format 5388 2 - v2 error format 5389 5390Returns: 5391 An object of the form: 5392 5393 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 5394 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 5395 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 5396 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 5397 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 5398 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 5399 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 5400 { 5401 "code": "A String", # [Output Only] The error type identifier for this error. 5402 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 5403 "message": "A String", # [Output Only] An optional, human-readable error message. 5404 }, 5405 ], 5406 }, 5407 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 5408 "httpErrorStatusCode": 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. 5409 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 5410 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 5411 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 5412 "name": "A String", # [Output Only] Name of the operation. 5413 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 5414 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 5415 "progress": 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. 5416 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 5417 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 5418 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 5419 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 5420 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 5421 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 5422 "targetLink": "A String", # [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. 5423 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 5424 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 5425 { 5426 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 5427 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 5428 { 5429 "key": "A String", # [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). 5430 "value": "A String", # [Output Only] A warning data value corresponding to the key. 5431 }, 5432 ], 5433 "message": "A String", # [Output Only] A human-readable description of the warning code. 5434 }, 5435 ], 5436 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 5437}</pre> 5438</div> 5439 5440</body></html>