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_v1.html">Compute Engine API</a> . <a href="compute_v1.instances.html">instances</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#addAccessConfig">addAccessConfig(project, zone, instance, networkInterface, body=None, requestId=None, x__xgafv=None)</a></code></p> 79<p class="firstline">Adds an access config to an instance's network interface.</p> 80<p class="toc_element"> 81 <code><a href="#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="#insert">insert(project, zone, body=None, requestId=None, sourceInstanceTemplate=None, sourceMachineImage=None, x__xgafv=None)</a></code></p> 130<p class="firstline">Creates an instance resource in the specified project using the data included in the request.</p> 131<p class="toc_element"> 132 <code><a href="#list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> 133<p class="firstline">Retrieves the list of instances contained within the specified zone.</p> 134<p class="toc_element"> 135 <code><a href="#listReferrers">listReferrers(project, zone, instance, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> 136<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> 137<p class="toc_element"> 138 <code><a href="#listReferrers_next">listReferrers_next(previous_request, previous_response)</a></code></p> 139<p class="firstline">Retrieves the next page of results.</p> 140<p class="toc_element"> 141 <code><a href="#list_next">list_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="#removeResourcePolicies">removeResourcePolicies(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p> 145<p class="firstline">Removes resource policies from an instance.</p> 146<p class="toc_element"> 147 <code><a href="#reset">reset(project, zone, instance, requestId=None, x__xgafv=None)</a></code></p> 148<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> 149<p class="toc_element"> 150 <code><a href="#sendDiagnosticInterrupt">sendDiagnosticInterrupt(project, zone, instance, x__xgafv=None)</a></code></p> 151<p class="firstline">Sends diagnostic interrupt to the instance.</p> 152<p class="toc_element"> 153 <code><a href="#setDeletionProtection">setDeletionProtection(project, zone, resource, deletionProtection=None, requestId=None, x__xgafv=None)</a></code></p> 154<p class="firstline">Sets deletion protection on the instance.</p> 155<p class="toc_element"> 156 <code><a href="#setDiskAutoDelete">setDiskAutoDelete(project, zone, instance, autoDelete, deviceName, requestId=None, x__xgafv=None)</a></code></p> 157<p class="firstline">Sets the auto-delete flag for a disk attached to an instance.</p> 158<p class="toc_element"> 159 <code><a href="#setIamPolicy">setIamPolicy(project, zone, resource, body=None, x__xgafv=None)</a></code></p> 160<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p> 161<p class="toc_element"> 162 <code><a href="#setLabels">setLabels(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p> 163<p class="firstline">Sets labels on an instance. To learn more about labels, read the Labeling Resources documentation.</p> 164<p class="toc_element"> 165 <code><a href="#setMachineResources">setMachineResources(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p> 166<p class="firstline">Changes the number and/or type of accelerator for a stopped instance to the values specified in the request.</p> 167<p class="toc_element"> 168 <code><a href="#setMachineType">setMachineType(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p> 169<p class="firstline">Changes the machine type for a stopped instance to the machine type specified in the request.</p> 170<p class="toc_element"> 171 <code><a href="#setMetadata">setMetadata(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p> 172<p class="firstline">Sets metadata for the specified instance to the data included in the request.</p> 173<p class="toc_element"> 174 <code><a href="#setMinCpuPlatform">setMinCpuPlatform(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p> 175<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> 176<p class="toc_element"> 177 <code><a href="#setScheduling">setScheduling(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p> 178<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> 179<p class="toc_element"> 180 <code><a href="#setServiceAccount">setServiceAccount(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p> 181<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> 182<p class="toc_element"> 183 <code><a href="#setShieldedInstanceIntegrityPolicy">setShieldedInstanceIntegrityPolicy(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p> 184<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> 185<p class="toc_element"> 186 <code><a href="#setTags">setTags(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p> 187<p class="firstline">Sets network tags for the specified instance to the data included in the request.</p> 188<p class="toc_element"> 189 <code><a href="#simulateMaintenanceEvent">simulateMaintenanceEvent(project, zone, instance, x__xgafv=None)</a></code></p> 190<p class="firstline">Simulates a maintenance event on the instance.</p> 191<p class="toc_element"> 192 <code><a href="#start">start(project, zone, instance, requestId=None, x__xgafv=None)</a></code></p> 193<p class="firstline">Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance.</p> 194<p class="toc_element"> 195 <code><a href="#startWithEncryptionKey">startWithEncryptionKey(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p> 196<p class="firstline">Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance.</p> 197<p class="toc_element"> 198 <code><a href="#stop">stop(project, zone, instance, requestId=None, x__xgafv=None)</a></code></p> 199<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> 200<p class="toc_element"> 201 <code><a href="#testIamPermissions">testIamPermissions(project, zone, resource, body=None, x__xgafv=None)</a></code></p> 202<p class="firstline">Returns permissions that a caller has on the specified resource.</p> 203<p class="toc_element"> 204 <code><a href="#update">update(project, zone, instance, body=None, minimalAction=None, mostDisruptiveAllowedAction=None, requestId=None, x__xgafv=None)</a></code></p> 205<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> 206<p class="toc_element"> 207 <code><a href="#updateAccessConfig">updateAccessConfig(project, zone, instance, networkInterface, body=None, requestId=None, x__xgafv=None)</a></code></p> 208<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> 209<p class="toc_element"> 210 <code><a href="#updateDisplayDevice">updateDisplayDevice(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p> 211<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> 212<p class="toc_element"> 213 <code><a href="#updateNetworkInterface">updateNetworkInterface(project, zone, instance, networkInterface, body=None, requestId=None, x__xgafv=None)</a></code></p> 214<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> 215<p class="toc_element"> 216 <code><a href="#updateShieldedInstanceConfig">updateShieldedInstanceConfig(project, zone, instance, body=None, requestId=None, x__xgafv=None)</a></code></p> 217<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> 218<h3>Method Details</h3> 219<div class="method"> 220 <code class="details" id="addAccessConfig">addAccessConfig(project, zone, instance, networkInterface, body=None, requestId=None, x__xgafv=None)</code> 221 <pre>Adds an access config to an instance's network interface. 222 223Args: 224 project: string, Project ID for this request. (required) 225 zone: string, The name of the zone for this request. (required) 226 instance: string, The instance name for this request. (required) 227 networkInterface: string, The name of the network interface to add to this instance. (required) 228 body: object, The request body. 229 The object takes the form of: 230 231{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported. 232 "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. 233 "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. 234 "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. 235 "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. 236 "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. 237 "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. 238 "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. 239 "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. 240 "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT. 241} 242 243 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). 244 x__xgafv: string, V1 error format. 245 Allowed values 246 1 - v1 error format 247 2 - v2 error format 248 249Returns: 250 An object of the form: 251 252 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 253 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 254 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 255 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 256 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 257 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 258 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 259 { 260 "code": "A String", # [Output Only] The error type identifier for this error. 261 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 262 "message": "A String", # [Output Only] An optional, human-readable error message. 263 }, 264 ], 265 }, 266 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 267 "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. 268 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 269 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 270 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 271 "name": "A String", # [Output Only] Name of the operation. 272 "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. 273 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 274 "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. 275 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 276 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 277 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 278 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 279 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 280 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 281 "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. 282 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 283 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 284 { 285 "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. 286 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 287 { 288 "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). 289 "value": "A String", # [Output Only] A warning data value corresponding to the key. 290 }, 291 ], 292 "message": "A String", # [Output Only] A human-readable description of the warning code. 293 }, 294 ], 295 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 296}</pre> 297</div> 298 299<div class="method"> 300 <code class="details" id="addResourcePolicies">addResourcePolicies(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code> 301 <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. 302 303Args: 304 project: string, Project ID for this request. (required) 305 zone: string, The name of the zone for this request. (required) 306 instance: string, The instance name for this request. (required) 307 body: object, The request body. 308 The object takes the form of: 309 310{ 311 "resourcePolicies": [ # Resource policies to be added to this instance. 312 "A String", 313 ], 314} 315 316 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). 317 x__xgafv: string, V1 error format. 318 Allowed values 319 1 - v1 error format 320 2 - v2 error format 321 322Returns: 323 An object of the form: 324 325 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 326 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 327 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 328 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 329 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 330 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 331 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 332 { 333 "code": "A String", # [Output Only] The error type identifier for this error. 334 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 335 "message": "A String", # [Output Only] An optional, human-readable error message. 336 }, 337 ], 338 }, 339 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 340 "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. 341 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 342 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 343 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 344 "name": "A String", # [Output Only] Name of the operation. 345 "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. 346 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 347 "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. 348 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 349 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 350 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 351 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 352 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 353 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 354 "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. 355 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 356 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 357 { 358 "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. 359 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 360 { 361 "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). 362 "value": "A String", # [Output Only] A warning data value corresponding to the key. 363 }, 364 ], 365 "message": "A String", # [Output Only] A human-readable description of the warning code. 366 }, 367 ], 368 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 369}</pre> 370</div> 371 372<div class="method"> 373 <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 374 <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. 375 376Args: 377 project: string, Project ID for this request. (required) 378 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) ``` 379 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. 380 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`) 381 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. 382 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. 383 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 384 x__xgafv: string, V1 error format. 385 Allowed values 386 1 - v1 error format 387 2 - v2 error format 388 389Returns: 390 An object of the form: 391 392 { 393 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 394 "items": { # An object that contains a list of instances scoped by zone. 395 "a_key": { # [Output Only] Name of the scope containing this set of instances. 396 "instances": [ # [Output Only] A list of instances contained in this scope. 397 { # Represents an Instance resource. An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. 398 "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. 399 "enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false). 400 "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. 401 }, 402 "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 . 403 "confidentialInstanceConfig": { # A set of Confidential Instance options. 404 "enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled. 405 }, 406 "cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance. 407 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 408 "deletionProtection": True or False, # Whether the resource should be protected against deletion. 409 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 410 "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them. 411 { # An instance-attached disk resource. 412 "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). 413 "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. 414 "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. 415 "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. 416 "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 417 "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/ 418 "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=" 419 "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 420 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 421 }, 422 "diskSizeGb": "A String", # The size of the disk in GB. 423 "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. 424 { # Guest OS features. 425 "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. 426 }, 427 ], 428 "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. 429 "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. 430 "description": "A String", # An optional description. Provide this property when creating the disk. 431 "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. 432 "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. 433 "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. 434 "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. 435 "a_key": "A String", 436 }, 437 "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. 438 "A String", 439 ], 440 "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk. 441 "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. 442 "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. 443 "A String", 444 ], 445 "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. 446 "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. 447 "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 448 "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/ 449 "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=" 450 "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 451 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 452 }, 453 "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. 454 "sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot. 455 "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 456 "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/ 457 "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=" 458 "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 459 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 460 }, 461 }, 462 "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. 463 "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks. 464 "licenses": [ # [Output Only] Any valid publicly visible licenses. 465 "A String", 466 ], 467 "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. 468 "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 469 "dbs": [ # The Key Database (db). 470 { 471 "content": "A String", # The raw content in the secure keys file. 472 "fileType": "A String", # The file type of source file. 473 }, 474 ], 475 "dbxs": [ # The forbidden key database (dbx). 476 { 477 "content": "A String", # The raw content in the secure keys file. 478 "fileType": "A String", # The file type of source file. 479 }, 480 ], 481 "keks": [ # The Key Exchange Key (KEK). 482 { 483 "content": "A String", # The raw content in the secure keys file. 484 "fileType": "A String", # The file type of source file. 485 }, 486 ], 487 "pk": { # The Platform Key (PK). 488 "content": "A String", # The raw content in the secure keys file. 489 "fileType": "A String", # The file type of source file. 490 }, 491 }, 492 "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. 493 "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. 494 }, 495 ], 496 "displayDevice": { # A set of Display Device options # Enables display device for the instance. 497 "enableDisplay": True or False, # Defines whether the instance has Display enabled. 498 }, 499 "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. 500 "guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance. 501 { # A specification of the type and number of accelerator cards attached to the instance. 502 "acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance. 503 "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. 504 }, 505 ], 506 "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. 507 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 508 "kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances. 509 "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. 510 "labels": { # Labels to apply to this instance. These can be later modified by the setLabels method. 511 "a_key": "A String", 512 }, 513 "lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format. 514 "lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format. 515 "lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format. 516 "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. 517 "metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys. 518 "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. 519 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB. 520 { # Metadata 521 "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. 522 "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). 523 }, 524 ], 525 "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata. 526 }, 527 "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". 528 "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. 529 "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. 530 { # A network interface resource attached to an instance. 531 "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. 532 { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. 533 "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. 534 "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. 535 "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. 536 "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. 537 "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. 538 "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. 539 "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. 540 "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. 541 "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT. 542 }, 543 ], 544 "aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks. 545 { # An alias IP range attached to an instance's network interface. 546 "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). 547 "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. 548 }, 549 ], 550 "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. 551 "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. 552 { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. 553 "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. 554 "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. 555 "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. 556 "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. 557 "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. 558 "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. 559 "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. 560 "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. 561 "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT. 562 }, 563 ], 564 "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. 565 "ipv6Address": "A String", # An IPv6 internal network address for this network interface. 566 "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. 567 "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. 568 "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 569 "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. 570 "nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. 571 "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. 572 "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. 573 "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 574 }, 575 ], 576 "networkPerformanceConfig": { 577 "totalEgressBandwidthTier": "A String", 578 }, 579 "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default. 580 "reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from. 581 "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. 582 "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. 583 "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. 584 "A String", 585 ], 586 }, 587 "resourcePolicies": [ # Resource policies applied to this instance. 588 "A String", 589 ], 590 "satisfiesPzs": True or False, # [Output Only] Reserved for future use. 591 "scheduling": { # Sets the scheduling options for an Instance. NextID: 21 # Sets the scheduling options for this instance. 592 "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. 593 "instanceTerminationAction": "A String", # Specifies the termination action for the instance. 594 "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. 595 "minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. 596 "nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity. 597 { # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled. 598 "key": "A String", # Corresponds to the label key of Node resource. 599 "operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity. 600 "values": [ # Corresponds to the label values of Node resource. 601 "A String", 602 ], 603 }, 604 ], 605 "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. 606 "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. 607 "provisioningModel": "A String", # Specifies the provisioning model of the instance. 608 }, 609 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 610 "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. 611 { # A service account. 612 "email": "A String", # Email address of the service account. 613 "scopes": [ # The list of scopes to be made available for this service account. 614 "A String", 615 ], 616 }, 617 ], 618 "shieldedInstanceConfig": { # A set of Shielded Instance options. 619 "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default. 620 "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default. 621 "enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default. 622 }, 623 "shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured. 624 "updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot. 625 }, 626 "sourceMachineImage": "A String", # Source machine image 627 "sourceMachineImageEncryptionKey": { # Source machine image encryption key when creating an instance from a machine image. 628 "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 629 "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/ 630 "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=" 631 "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 632 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 633 }, 634 "startRestricted": True or False, # [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity. 635 "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. 636 "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status. 637 "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. 638 "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. 639 "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. 640 "A String", 641 ], 642 }, 643 "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. 644 }, 645 ], 646 "warning": { # [Output Only] Informational warning which replaces the list of instances when the list is empty. 647 "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. 648 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 649 { 650 "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). 651 "value": "A String", # [Output Only] A warning data value corresponding to the key. 652 }, 653 ], 654 "message": "A String", # [Output Only] A human-readable description of the warning code. 655 }, 656 }, 657 }, 658 "kind": "compute#instanceAggregatedList", # [Output Only] Type of resource. Always compute#instanceAggregatedList for aggregated lists of Instance resources. 659 "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. 660 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 661 "unreachables": [ # [Output Only] Unreachable resources. 662 "A String", 663 ], 664 "warning": { # [Output Only] Informational warning message. 665 "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. 666 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 667 { 668 "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). 669 "value": "A String", # [Output Only] A warning data value corresponding to the key. 670 }, 671 ], 672 "message": "A String", # [Output Only] A human-readable description of the warning code. 673 }, 674}</pre> 675</div> 676 677<div class="method"> 678 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code> 679 <pre>Retrieves the next page of results. 680 681Args: 682 previous_request: The request for the previous page. (required) 683 previous_response: The response from the request for the previous page. (required) 684 685Returns: 686 A request object that you can call 'execute()' on to request the next 687 page. Returns None if there are no more items in the collection. 688 </pre> 689</div> 690 691<div class="method"> 692 <code class="details" id="attachDisk">attachDisk(project, zone, instance, body=None, forceAttach=None, requestId=None, x__xgafv=None)</code> 693 <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. 694 695Args: 696 project: string, Project ID for this request. (required) 697 zone: string, The name of the zone for this request. (required) 698 instance: string, The instance name for this request. (required) 699 body: object, The request body. 700 The object takes the form of: 701 702{ # An instance-attached disk resource. 703 "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). 704 "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. 705 "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. 706 "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. 707 "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 708 "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/ 709 "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=" 710 "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 711 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 712 }, 713 "diskSizeGb": "A String", # The size of the disk in GB. 714 "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. 715 { # Guest OS features. 716 "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. 717 }, 718 ], 719 "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. 720 "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. 721 "description": "A String", # An optional description. Provide this property when creating the disk. 722 "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. 723 "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. 724 "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. 725 "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. 726 "a_key": "A String", 727 }, 728 "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. 729 "A String", 730 ], 731 "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk. 732 "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. 733 "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. 734 "A String", 735 ], 736 "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. 737 "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. 738 "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 739 "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/ 740 "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=" 741 "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 742 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 743 }, 744 "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. 745 "sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot. 746 "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 747 "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/ 748 "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=" 749 "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 750 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 751 }, 752 }, 753 "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. 754 "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks. 755 "licenses": [ # [Output Only] Any valid publicly visible licenses. 756 "A String", 757 ], 758 "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. 759 "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 760 "dbs": [ # The Key Database (db). 761 { 762 "content": "A String", # The raw content in the secure keys file. 763 "fileType": "A String", # The file type of source file. 764 }, 765 ], 766 "dbxs": [ # The forbidden key database (dbx). 767 { 768 "content": "A String", # The raw content in the secure keys file. 769 "fileType": "A String", # The file type of source file. 770 }, 771 ], 772 "keks": [ # The Key Exchange Key (KEK). 773 { 774 "content": "A String", # The raw content in the secure keys file. 775 "fileType": "A String", # The file type of source file. 776 }, 777 ], 778 "pk": { # The Platform Key (PK). 779 "content": "A String", # The raw content in the secure keys file. 780 "fileType": "A String", # The file type of source file. 781 }, 782 }, 783 "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. 784 "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. 785} 786 787 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. 788 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). 789 x__xgafv: string, V1 error format. 790 Allowed values 791 1 - v1 error format 792 2 - v2 error format 793 794Returns: 795 An object of the form: 796 797 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 798 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 799 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 800 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 801 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 802 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 803 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 804 { 805 "code": "A String", # [Output Only] The error type identifier for this error. 806 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 807 "message": "A String", # [Output Only] An optional, human-readable error message. 808 }, 809 ], 810 }, 811 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 812 "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. 813 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 814 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 815 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 816 "name": "A String", # [Output Only] Name of the operation. 817 "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. 818 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 819 "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. 820 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 821 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 822 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 823 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 824 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 825 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 826 "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. 827 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 828 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 829 { 830 "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. 831 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 832 { 833 "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). 834 "value": "A String", # [Output Only] A warning data value corresponding to the key. 835 }, 836 ], 837 "message": "A String", # [Output Only] A human-readable description of the warning code. 838 }, 839 ], 840 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 841}</pre> 842</div> 843 844<div class="method"> 845 <code class="details" id="bulkInsert">bulkInsert(project, zone, body=None, requestId=None, x__xgafv=None)</code> 846 <pre>Creates multiple instances. Count specifies the number of instances to create. 847 848Args: 849 project: string, Project ID for this request. (required) 850 zone: string, The name of the zone for this request. (required) 851 body: object, The request body. 852 The object takes the form of: 853 854{ # 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. 855 "count": "A String", # The maximum number of instances to create. 856 "instanceProperties": { # The instance properties defining the VM instances to be created. Required if sourceInstanceTemplate is not provided. 857 "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. 858 "enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false). 859 "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. 860 }, 861 "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. 862 "confidentialInstanceConfig": { # A set of Confidential Instance options. # Specifies the Confidential Instance options. Note that for MachineImage, this is not supported yet. 863 "enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled. 864 }, 865 "description": "A String", # An optional text description for the instances that are created from these properties. 866 "disks": [ # An array of disks that are associated with the instances that are created from these properties. 867 { # An instance-attached disk resource. 868 "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). 869 "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. 870 "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. 871 "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. 872 "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 873 "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/ 874 "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=" 875 "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 876 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 877 }, 878 "diskSizeGb": "A String", # The size of the disk in GB. 879 "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. 880 { # Guest OS features. 881 "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. 882 }, 883 ], 884 "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. 885 "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. 886 "description": "A String", # An optional description. Provide this property when creating the disk. 887 "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. 888 "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. 889 "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. 890 "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. 891 "a_key": "A String", 892 }, 893 "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. 894 "A String", 895 ], 896 "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk. 897 "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. 898 "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. 899 "A String", 900 ], 901 "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. 902 "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. 903 "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 904 "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/ 905 "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=" 906 "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 907 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 908 }, 909 "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. 910 "sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot. 911 "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 912 "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/ 913 "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=" 914 "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 915 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 916 }, 917 }, 918 "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. 919 "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks. 920 "licenses": [ # [Output Only] Any valid publicly visible licenses. 921 "A String", 922 ], 923 "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. 924 "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 925 "dbs": [ # The Key Database (db). 926 { 927 "content": "A String", # The raw content in the secure keys file. 928 "fileType": "A String", # The file type of source file. 929 }, 930 ], 931 "dbxs": [ # The forbidden key database (dbx). 932 { 933 "content": "A String", # The raw content in the secure keys file. 934 "fileType": "A String", # The file type of source file. 935 }, 936 ], 937 "keks": [ # The Key Exchange Key (KEK). 938 { 939 "content": "A String", # The raw content in the secure keys file. 940 "fileType": "A String", # The file type of source file. 941 }, 942 ], 943 "pk": { # The Platform Key (PK). 944 "content": "A String", # The raw content in the secure keys file. 945 "fileType": "A String", # The file type of source file. 946 }, 947 }, 948 "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. 949 "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. 950 }, 951 ], 952 "guestAccelerators": [ # A list of guest accelerator cards' type and count to use for instances created from these properties. 953 { # A specification of the type and number of accelerator cards attached to the instance. 954 "acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance. 955 "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. 956 }, 957 ], 958 "labels": { # Labels to apply to instances that are created from these properties. 959 "a_key": "A String", 960 }, 961 "machineType": "A String", # The machine type to use for instances that are created from these properties. 962 "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. 963 "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. 964 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB. 965 { # Metadata 966 "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. 967 "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). 968 }, 969 ], 970 "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata. 971 }, 972 "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. 973 "networkInterfaces": [ # An array of network access configurations for this interface. 974 { # A network interface resource attached to an instance. 975 "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. 976 { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. 977 "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. 978 "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. 979 "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. 980 "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. 981 "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. 982 "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. 983 "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. 984 "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. 985 "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT. 986 }, 987 ], 988 "aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks. 989 { # An alias IP range attached to an instance's network interface. 990 "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). 991 "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. 992 }, 993 ], 994 "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. 995 "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. 996 { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. 997 "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. 998 "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. 999 "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. 1000 "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. 1001 "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. 1002 "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. 1003 "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. 1004 "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. 1005 "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT. 1006 }, 1007 ], 1008 "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. 1009 "ipv6Address": "A String", # An IPv6 internal network address for this network interface. 1010 "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. 1011 "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. 1012 "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 1013 "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. 1014 "nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. 1015 "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. 1016 "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. 1017 "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 1018 }, 1019 ], 1020 "networkPerformanceConfig": { # Note that for MachineImage, this is not supported yet. 1021 "totalEgressBandwidthTier": "A String", 1022 }, 1023 "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. 1024 "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. 1025 "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. 1026 "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. 1027 "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. 1028 "A String", 1029 ], 1030 }, 1031 "resourcePolicies": [ # Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. 1032 "A String", 1033 ], 1034 "scheduling": { # Sets the scheduling options for an Instance. NextID: 21 # Specifies the scheduling options for the instances that are created from these properties. 1035 "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. 1036 "instanceTerminationAction": "A String", # Specifies the termination action for the instance. 1037 "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. 1038 "minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. 1039 "nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity. 1040 { # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled. 1041 "key": "A String", # Corresponds to the label key of Node resource. 1042 "operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity. 1043 "values": [ # Corresponds to the label values of Node resource. 1044 "A String", 1045 ], 1046 }, 1047 ], 1048 "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. 1049 "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. 1050 "provisioningModel": "A String", # Specifies the provisioning model of the instance. 1051 }, 1052 "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. 1053 { # A service account. 1054 "email": "A String", # Email address of the service account. 1055 "scopes": [ # The list of scopes to be made available for this service account. 1056 "A String", 1057 ], 1058 }, 1059 ], 1060 "shieldedInstanceConfig": { # A set of Shielded Instance options. # Note that for MachineImage, this is not supported yet. 1061 "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default. 1062 "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default. 1063 "enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default. 1064 }, 1065 "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. 1066 "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. 1067 "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. 1068 "A String", 1069 ], 1070 }, 1071 }, 1072 "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. 1073 "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. 1074 "a_key": { 1075 "preference": "A String", # Preference for a given location: ALLOW or DENY. 1076 }, 1077 }, 1078 }, 1079 "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. 1080 "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. 1081 "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. 1082 "a_key": { # Per-instance properties to be set on individual instances. To be extended in the future. 1083 "name": "A String", # This field is only temporary. It will be removed. Do not use it. 1084 }, 1085 }, 1086 "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. 1087} 1088 1089 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). 1090 x__xgafv: string, V1 error format. 1091 Allowed values 1092 1 - v1 error format 1093 2 - v2 error format 1094 1095Returns: 1096 An object of the form: 1097 1098 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 1099 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1100 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1101 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1102 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1103 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1104 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1105 { 1106 "code": "A String", # [Output Only] The error type identifier for this error. 1107 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1108 "message": "A String", # [Output Only] An optional, human-readable error message. 1109 }, 1110 ], 1111 }, 1112 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 1113 "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. 1114 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 1115 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1116 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 1117 "name": "A String", # [Output Only] Name of the operation. 1118 "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. 1119 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 1120 "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. 1121 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 1122 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1123 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1124 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 1125 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1126 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1127 "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. 1128 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 1129 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1130 { 1131 "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. 1132 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1133 { 1134 "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). 1135 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1136 }, 1137 ], 1138 "message": "A String", # [Output Only] A human-readable description of the warning code. 1139 }, 1140 ], 1141 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 1142}</pre> 1143</div> 1144 1145<div class="method"> 1146 <code class="details" id="close">close()</code> 1147 <pre>Close httplib2 connections.</pre> 1148</div> 1149 1150<div class="method"> 1151 <code class="details" id="delete">delete(project, zone, instance, requestId=None, x__xgafv=None)</code> 1152 <pre>Deletes the specified Instance resource. For more information, see Deleting an instance. 1153 1154Args: 1155 project: string, Project ID for this request. (required) 1156 zone: string, The name of the zone for this request. (required) 1157 instance: string, Name of the instance resource to delete. (required) 1158 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). 1159 x__xgafv: string, V1 error format. 1160 Allowed values 1161 1 - v1 error format 1162 2 - v2 error format 1163 1164Returns: 1165 An object of the form: 1166 1167 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 1168 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1169 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1170 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1171 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1172 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1173 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1174 { 1175 "code": "A String", # [Output Only] The error type identifier for this error. 1176 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1177 "message": "A String", # [Output Only] An optional, human-readable error message. 1178 }, 1179 ], 1180 }, 1181 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 1182 "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. 1183 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 1184 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1185 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 1186 "name": "A String", # [Output Only] Name of the operation. 1187 "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. 1188 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 1189 "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. 1190 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 1191 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1192 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1193 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 1194 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1195 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1196 "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. 1197 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 1198 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1199 { 1200 "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. 1201 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1202 { 1203 "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). 1204 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1205 }, 1206 ], 1207 "message": "A String", # [Output Only] A human-readable description of the warning code. 1208 }, 1209 ], 1210 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 1211}</pre> 1212</div> 1213 1214<div class="method"> 1215 <code class="details" id="deleteAccessConfig">deleteAccessConfig(project, zone, instance, accessConfig, networkInterface, requestId=None, x__xgafv=None)</code> 1216 <pre>Deletes an access config from an instance's network interface. 1217 1218Args: 1219 project: string, Project ID for this request. (required) 1220 zone: string, The name of the zone for this request. (required) 1221 instance: string, The instance name for this request. (required) 1222 accessConfig: string, The name of the access config to delete. (required) 1223 networkInterface: string, The name of the network interface. (required) 1224 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). 1225 x__xgafv: string, V1 error format. 1226 Allowed values 1227 1 - v1 error format 1228 2 - v2 error format 1229 1230Returns: 1231 An object of the form: 1232 1233 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 1234 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1235 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1236 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1237 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1238 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1239 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1240 { 1241 "code": "A String", # [Output Only] The error type identifier for this error. 1242 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1243 "message": "A String", # [Output Only] An optional, human-readable error message. 1244 }, 1245 ], 1246 }, 1247 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 1248 "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. 1249 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 1250 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1251 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 1252 "name": "A String", # [Output Only] Name of the operation. 1253 "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. 1254 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 1255 "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. 1256 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 1257 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1258 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1259 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 1260 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1261 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1262 "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. 1263 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 1264 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1265 { 1266 "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. 1267 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1268 { 1269 "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). 1270 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1271 }, 1272 ], 1273 "message": "A String", # [Output Only] A human-readable description of the warning code. 1274 }, 1275 ], 1276 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 1277}</pre> 1278</div> 1279 1280<div class="method"> 1281 <code class="details" id="detachDisk">detachDisk(project, zone, instance, deviceName, requestId=None, x__xgafv=None)</code> 1282 <pre>Detaches a disk from an instance. 1283 1284Args: 1285 project: string, Project ID for this request. (required) 1286 zone: string, The name of the zone for this request. (required) 1287 instance: string, Instance name for this request. (required) 1288 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) 1289 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). 1290 x__xgafv: string, V1 error format. 1291 Allowed values 1292 1 - v1 error format 1293 2 - v2 error format 1294 1295Returns: 1296 An object of the form: 1297 1298 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 1299 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1300 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1301 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1302 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1303 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1304 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1305 { 1306 "code": "A String", # [Output Only] The error type identifier for this error. 1307 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1308 "message": "A String", # [Output Only] An optional, human-readable error message. 1309 }, 1310 ], 1311 }, 1312 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 1313 "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. 1314 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 1315 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1316 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 1317 "name": "A String", # [Output Only] Name of the operation. 1318 "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. 1319 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 1320 "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. 1321 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 1322 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1323 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1324 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 1325 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1326 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1327 "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. 1328 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 1329 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1330 { 1331 "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. 1332 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1333 { 1334 "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). 1335 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1336 }, 1337 ], 1338 "message": "A String", # [Output Only] A human-readable description of the warning code. 1339 }, 1340 ], 1341 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 1342}</pre> 1343</div> 1344 1345<div class="method"> 1346 <code class="details" id="get">get(project, zone, instance, x__xgafv=None)</code> 1347 <pre>Returns the specified Instance resource. Gets a list of available instances by making a list() request. 1348 1349Args: 1350 project: string, Project ID for this request. (required) 1351 zone: string, The name of the zone for this request. (required) 1352 instance: string, Name of the instance resource to return. (required) 1353 x__xgafv: string, V1 error format. 1354 Allowed values 1355 1 - v1 error format 1356 2 - v2 error format 1357 1358Returns: 1359 An object of the form: 1360 1361 { # Represents an Instance resource. An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. 1362 "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. 1363 "enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false). 1364 "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. 1365 }, 1366 "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 . 1367 "confidentialInstanceConfig": { # A set of Confidential Instance options. 1368 "enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled. 1369 }, 1370 "cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance. 1371 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 1372 "deletionProtection": True or False, # Whether the resource should be protected against deletion. 1373 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 1374 "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them. 1375 { # An instance-attached disk resource. 1376 "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). 1377 "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. 1378 "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. 1379 "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. 1380 "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 1381 "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/ 1382 "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=" 1383 "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 1384 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 1385 }, 1386 "diskSizeGb": "A String", # The size of the disk in GB. 1387 "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. 1388 { # Guest OS features. 1389 "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. 1390 }, 1391 ], 1392 "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. 1393 "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. 1394 "description": "A String", # An optional description. Provide this property when creating the disk. 1395 "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. 1396 "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. 1397 "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. 1398 "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. 1399 "a_key": "A String", 1400 }, 1401 "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. 1402 "A String", 1403 ], 1404 "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk. 1405 "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. 1406 "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. 1407 "A String", 1408 ], 1409 "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. 1410 "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. 1411 "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 1412 "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/ 1413 "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=" 1414 "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 1415 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 1416 }, 1417 "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. 1418 "sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot. 1419 "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 1420 "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/ 1421 "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=" 1422 "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 1423 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 1424 }, 1425 }, 1426 "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. 1427 "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks. 1428 "licenses": [ # [Output Only] Any valid publicly visible licenses. 1429 "A String", 1430 ], 1431 "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. 1432 "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 1433 "dbs": [ # The Key Database (db). 1434 { 1435 "content": "A String", # The raw content in the secure keys file. 1436 "fileType": "A String", # The file type of source file. 1437 }, 1438 ], 1439 "dbxs": [ # The forbidden key database (dbx). 1440 { 1441 "content": "A String", # The raw content in the secure keys file. 1442 "fileType": "A String", # The file type of source file. 1443 }, 1444 ], 1445 "keks": [ # The Key Exchange Key (KEK). 1446 { 1447 "content": "A String", # The raw content in the secure keys file. 1448 "fileType": "A String", # The file type of source file. 1449 }, 1450 ], 1451 "pk": { # The Platform Key (PK). 1452 "content": "A String", # The raw content in the secure keys file. 1453 "fileType": "A String", # The file type of source file. 1454 }, 1455 }, 1456 "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. 1457 "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. 1458 }, 1459 ], 1460 "displayDevice": { # A set of Display Device options # Enables display device for the instance. 1461 "enableDisplay": True or False, # Defines whether the instance has Display enabled. 1462 }, 1463 "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. 1464 "guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance. 1465 { # A specification of the type and number of accelerator cards attached to the instance. 1466 "acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance. 1467 "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. 1468 }, 1469 ], 1470 "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. 1471 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 1472 "kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances. 1473 "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. 1474 "labels": { # Labels to apply to this instance. These can be later modified by the setLabels method. 1475 "a_key": "A String", 1476 }, 1477 "lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format. 1478 "lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format. 1479 "lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format. 1480 "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. 1481 "metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys. 1482 "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. 1483 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB. 1484 { # Metadata 1485 "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. 1486 "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). 1487 }, 1488 ], 1489 "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata. 1490 }, 1491 "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". 1492 "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. 1493 "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. 1494 { # A network interface resource attached to an instance. 1495 "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. 1496 { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. 1497 "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. 1498 "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. 1499 "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. 1500 "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. 1501 "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. 1502 "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. 1503 "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. 1504 "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. 1505 "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT. 1506 }, 1507 ], 1508 "aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks. 1509 { # An alias IP range attached to an instance's network interface. 1510 "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). 1511 "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. 1512 }, 1513 ], 1514 "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. 1515 "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. 1516 { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. 1517 "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. 1518 "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. 1519 "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. 1520 "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. 1521 "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. 1522 "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. 1523 "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. 1524 "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. 1525 "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT. 1526 }, 1527 ], 1528 "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. 1529 "ipv6Address": "A String", # An IPv6 internal network address for this network interface. 1530 "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. 1531 "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. 1532 "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 1533 "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. 1534 "nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. 1535 "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. 1536 "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. 1537 "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 1538 }, 1539 ], 1540 "networkPerformanceConfig": { 1541 "totalEgressBandwidthTier": "A String", 1542 }, 1543 "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default. 1544 "reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from. 1545 "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. 1546 "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. 1547 "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. 1548 "A String", 1549 ], 1550 }, 1551 "resourcePolicies": [ # Resource policies applied to this instance. 1552 "A String", 1553 ], 1554 "satisfiesPzs": True or False, # [Output Only] Reserved for future use. 1555 "scheduling": { # Sets the scheduling options for an Instance. NextID: 21 # Sets the scheduling options for this instance. 1556 "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. 1557 "instanceTerminationAction": "A String", # Specifies the termination action for the instance. 1558 "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. 1559 "minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. 1560 "nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity. 1561 { # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled. 1562 "key": "A String", # Corresponds to the label key of Node resource. 1563 "operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity. 1564 "values": [ # Corresponds to the label values of Node resource. 1565 "A String", 1566 ], 1567 }, 1568 ], 1569 "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. 1570 "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. 1571 "provisioningModel": "A String", # Specifies the provisioning model of the instance. 1572 }, 1573 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 1574 "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. 1575 { # A service account. 1576 "email": "A String", # Email address of the service account. 1577 "scopes": [ # The list of scopes to be made available for this service account. 1578 "A String", 1579 ], 1580 }, 1581 ], 1582 "shieldedInstanceConfig": { # A set of Shielded Instance options. 1583 "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default. 1584 "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default. 1585 "enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default. 1586 }, 1587 "shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured. 1588 "updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot. 1589 }, 1590 "sourceMachineImage": "A String", # Source machine image 1591 "sourceMachineImageEncryptionKey": { # Source machine image encryption key when creating an instance from a machine image. 1592 "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 1593 "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/ 1594 "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=" 1595 "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 1596 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 1597 }, 1598 "startRestricted": True or False, # [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity. 1599 "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. 1600 "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status. 1601 "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. 1602 "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. 1603 "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. 1604 "A String", 1605 ], 1606 }, 1607 "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. 1608}</pre> 1609</div> 1610 1611<div class="method"> 1612 <code class="details" id="getEffectiveFirewalls">getEffectiveFirewalls(project, zone, instance, networkInterface, x__xgafv=None)</code> 1613 <pre>Returns effective firewalls applied to an interface of the instance. 1614 1615Args: 1616 project: string, Project ID for this request. (required) 1617 zone: string, The name of the zone for this request. (required) 1618 instance: string, Name of the instance scoping this request. (required) 1619 networkInterface: string, The name of the network interface to get the effective firewalls. (required) 1620 x__xgafv: string, V1 error format. 1621 Allowed values 1622 1 - v1 error format 1623 2 - v2 error format 1624 1625Returns: 1626 An object of the form: 1627 1628 { 1629 "firewallPolicys": [ # Effective firewalls from firewall policies. 1630 { 1631 "displayName": "A String", # [Output Only] Deprecated, please use short name instead. The display name of the firewall policy. 1632 "name": "A String", # [Output Only] The name of the firewall policy. 1633 "rules": [ # The rules that apply to the network. 1634 { # 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). 1635 "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. 1636 "description": "A String", # An optional description for this resource. 1637 "direction": "A String", # The direction in which this rule applies. 1638 "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. 1639 "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. 1640 "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules 1641 "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. 1642 "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. 1643 "A String", 1644 ], 1645 "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. 1646 { 1647 "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. 1648 "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"]. 1649 "A String", 1650 ], 1651 }, 1652 ], 1653 "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. 1654 "A String", 1655 ], 1656 }, 1657 "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. 1658 "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. 1659 "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. 1660 "A String", 1661 ], 1662 "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. 1663 "A String", 1664 ], 1665 }, 1666 ], 1667 "shortName": "A String", # [Output Only] The short name of the firewall policy. 1668 "type": "A String", # [Output Only] The type of the firewall policy. 1669 }, 1670 ], 1671 "firewalls": [ # Effective firewalls on the instance. 1672 { # 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. 1673 "allowed": [ # The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection. 1674 { 1675 "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. 1676 "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"]. 1677 "A String", 1678 ], 1679 }, 1680 ], 1681 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 1682 "denied": [ # The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection. 1683 { 1684 "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. 1685 "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"]. 1686 "A String", 1687 ], 1688 }, 1689 ], 1690 "description": "A String", # An optional description of this resource. Provide this field when you create the resource. 1691 "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. 1692 "A String", 1693 ], 1694 "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. 1695 "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. 1696 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 1697 "kind": "compute#firewall", # [Output Only] Type of the resource. Always compute#firewall for firewall rules. 1698 "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. 1699 "enable": True or False, # This field denotes whether to enable logging for a particular firewall rule. 1700 "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. 1701 }, 1702 "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. 1703 "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 1704 "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`. 1705 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1706 "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. 1707 "A String", 1708 ], 1709 "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. 1710 "A String", 1711 ], 1712 "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. 1713 "A String", 1714 ], 1715 "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. 1716 "A String", 1717 ], 1718 "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. 1719 "A String", 1720 ], 1721 }, 1722 ], 1723}</pre> 1724</div> 1725 1726<div class="method"> 1727 <code class="details" id="getGuestAttributes">getGuestAttributes(project, zone, instance, queryPath=None, variableKey=None, x__xgafv=None)</code> 1728 <pre>Returns the specified guest attributes entry. 1729 1730Args: 1731 project: string, Project ID for this request. (required) 1732 zone: string, The name of the zone for this request. (required) 1733 instance: string, Name of the instance scoping this request. (required) 1734 queryPath: string, Specifies the guest attributes path to be queried. 1735 variableKey: string, Specifies the key for the guest attributes entry. 1736 x__xgafv: string, V1 error format. 1737 Allowed values 1738 1 - v1 error format 1739 2 - v2 error format 1740 1741Returns: 1742 An object of the form: 1743 1744 { # A guest attributes entry. 1745 "kind": "compute#guestAttributes", # [Output Only] Type of the resource. Always compute#guestAttributes for guest attributes entry. 1746 "queryPath": "A String", # The path to be queried. This can be the default namespace ('') or a nested namespace ('\/') or a specified key ('\/\'). 1747 "queryValue": { # Array of guest attribute namespace/key/value tuples. # [Output Only] The value of the requested queried path. 1748 "items": [ 1749 { # A guest attributes namespace/key/value entry. 1750 "key": "A String", # Key for the guest attribute entry. 1751 "namespace": "A String", # Namespace for the guest attribute entry. 1752 "value": "A String", # Value for the guest attribute entry. 1753 }, 1754 ], 1755 }, 1756 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 1757 "variableKey": "A String", # The key to search for. 1758 "variableValue": "A String", # [Output Only] The value found for the requested key. 1759}</pre> 1760</div> 1761 1762<div class="method"> 1763 <code class="details" id="getIamPolicy">getIamPolicy(project, zone, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</code> 1764 <pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists. 1765 1766Args: 1767 project: string, Project ID for this request. (required) 1768 zone: string, The name of the zone for this request. (required) 1769 resource: string, Name or id of the resource for this request. (required) 1770 optionsRequestedPolicyVersion: integer, Requested IAM Policy version. 1771 x__xgafv: string, V1 error format. 1772 Allowed values 1773 1 - v1 error format 1774 2 - v2 error format 1775 1776Returns: 1777 An object of the form: 1778 1779 { # 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/). 1780 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 1781 { # 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. 1782 "auditLogConfigs": [ # The configuration for logging of each type of permission. 1783 { # 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. 1784 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. 1785 "A String", 1786 ], 1787 "ignoreChildExemptions": True or False, # This is deprecated and has no effect. Do not use. 1788 "logType": "A String", # The log type that this config enables. 1789 }, 1790 ], 1791 "exemptedMembers": [ # This is deprecated and has no effect. Do not use. 1792 "A String", 1793 ], 1794 "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. 1795 }, 1796 ], 1797 "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`. 1798 { # Associates `members`, or principals, with a `role`. 1799 "bindingId": "A String", # This is deprecated and has no effect. Do not use. 1800 "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). 1801 "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. 1802 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 1803 "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. 1804 "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. 1805 }, 1806 "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`. 1807 "A String", 1808 ], 1809 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 1810 }, 1811 ], 1812 "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. 1813 "rules": [ # This is deprecated and has no effect. Do not use. 1814 { # This is deprecated and has no effect. Do not use. 1815 "action": "A String", # This is deprecated and has no effect. Do not use. 1816 "conditions": [ # This is deprecated and has no effect. Do not use. 1817 { # This is deprecated and has no effect. Do not use. 1818 "iam": "A String", # This is deprecated and has no effect. Do not use. 1819 "op": "A String", # This is deprecated and has no effect. Do not use. 1820 "svc": "A String", # This is deprecated and has no effect. Do not use. 1821 "sys": "A String", # This is deprecated and has no effect. Do not use. 1822 "values": [ # This is deprecated and has no effect. Do not use. 1823 "A String", 1824 ], 1825 }, 1826 ], 1827 "description": "A String", # This is deprecated and has no effect. Do not use. 1828 "ins": [ # This is deprecated and has no effect. Do not use. 1829 "A String", 1830 ], 1831 "logConfigs": [ # This is deprecated and has no effect. Do not use. 1832 { # This is deprecated and has no effect. Do not use. 1833 "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 1834 "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 1835 "permissionType": "A String", # This is deprecated and has no effect. Do not use. 1836 }, 1837 "logName": "A String", # This is deprecated and has no effect. Do not use. 1838 }, 1839 "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 1840 "customFields": [ # This is deprecated and has no effect. Do not use. 1841 { # This is deprecated and has no effect. Do not use. 1842 "name": "A String", # This is deprecated and has no effect. Do not use. 1843 "value": "A String", # This is deprecated and has no effect. Do not use. 1844 }, 1845 ], 1846 "field": "A String", # This is deprecated and has no effect. Do not use. 1847 "metric": "A String", # This is deprecated and has no effect. Do not use. 1848 }, 1849 "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 1850 "logMode": "A String", # This is deprecated and has no effect. Do not use. 1851 }, 1852 }, 1853 ], 1854 "notIns": [ # This is deprecated and has no effect. Do not use. 1855 "A String", 1856 ], 1857 "permissions": [ # This is deprecated and has no effect. Do not use. 1858 "A String", 1859 ], 1860 }, 1861 ], 1862 "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). 1863}</pre> 1864</div> 1865 1866<div class="method"> 1867 <code class="details" id="getScreenshot">getScreenshot(project, zone, instance, x__xgafv=None)</code> 1868 <pre>Returns the screenshot from the specified instance. 1869 1870Args: 1871 project: string, Project ID for this request. (required) 1872 zone: string, The name of the zone for this request. (required) 1873 instance: string, Name of the instance scoping this request. (required) 1874 x__xgafv: string, V1 error format. 1875 Allowed values 1876 1 - v1 error format 1877 2 - v2 error format 1878 1879Returns: 1880 An object of the form: 1881 1882 { # An instance's screenshot. 1883 "contents": "A String", # [Output Only] The Base64-encoded screenshot data. 1884 "kind": "compute#screenshot", # [Output Only] Type of the resource. Always compute#screenshot for the screenshots. 1885}</pre> 1886</div> 1887 1888<div class="method"> 1889 <code class="details" id="getSerialPortOutput">getSerialPortOutput(project, zone, instance, port=None, start=None, x__xgafv=None)</code> 1890 <pre>Returns the last 1 MB of serial port output from the specified instance. 1891 1892Args: 1893 project: string, Project ID for this request. (required) 1894 zone: string, The name of the zone for this request. (required) 1895 instance: string, Name of the instance for this request. (required) 1896 port: integer, Specifies which COM or serial port to retrieve data from. 1897 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. 1898 x__xgafv: string, V1 error format. 1899 Allowed values 1900 1 - v1 error format 1901 2 - v2 error format 1902 1903Returns: 1904 An object of the form: 1905 1906 { # An instance serial console output. 1907 "contents": "A String", # [Output Only] The contents of the console output. 1908 "kind": "compute#serialPortOutput", # [Output Only] Type of the resource. Always compute#serialPortOutput for serial port output. 1909 "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. 1910 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 1911 "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. 1912}</pre> 1913</div> 1914 1915<div class="method"> 1916 <code class="details" id="getShieldedInstanceIdentity">getShieldedInstanceIdentity(project, zone, instance, x__xgafv=None)</code> 1917 <pre>Returns the Shielded Instance Identity of an instance 1918 1919Args: 1920 project: string, Project ID for this request. (required) 1921 zone: string, The name of the zone for this request. (required) 1922 instance: string, Name or id of the instance scoping this request. (required) 1923 x__xgafv: string, V1 error format. 1924 Allowed values 1925 1 - v1 error format 1926 2 - v2 error format 1927 1928Returns: 1929 An object of the form: 1930 1931 { # A Shielded Instance Identity. 1932 "encryptionKey": { # A Shielded Instance Identity Entry. # An Endorsement Key (EK) made by the RSA 2048 algorithm issued to the Shielded Instance's vTPM. 1933 "ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty. 1934 "ekPub": "A String", # A PEM-encoded public key. 1935 }, 1936 "kind": "compute#shieldedInstanceIdentity", # [Output Only] Type of the resource. Always compute#shieldedInstanceIdentity for shielded Instance identity entry. 1937 "signingKey": { # A Shielded Instance Identity Entry. # An Attestation Key (AK) made by the RSA 2048 algorithm issued to the Shielded Instance's vTPM. 1938 "ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty. 1939 "ekPub": "A String", # A PEM-encoded public key. 1940 }, 1941}</pre> 1942</div> 1943 1944<div class="method"> 1945 <code class="details" id="insert">insert(project, zone, body=None, requestId=None, sourceInstanceTemplate=None, sourceMachineImage=None, x__xgafv=None)</code> 1946 <pre>Creates an instance resource in the specified project using the data included in the request. 1947 1948Args: 1949 project: string, Project ID for this request. (required) 1950 zone: string, The name of the zone for this request. (required) 1951 body: object, The request body. 1952 The object takes the form of: 1953 1954{ # Represents an Instance resource. An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. 1955 "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. 1956 "enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false). 1957 "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. 1958 }, 1959 "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 . 1960 "confidentialInstanceConfig": { # A set of Confidential Instance options. 1961 "enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled. 1962 }, 1963 "cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance. 1964 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 1965 "deletionProtection": True or False, # Whether the resource should be protected against deletion. 1966 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 1967 "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them. 1968 { # An instance-attached disk resource. 1969 "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). 1970 "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. 1971 "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. 1972 "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. 1973 "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 1974 "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/ 1975 "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=" 1976 "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 1977 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 1978 }, 1979 "diskSizeGb": "A String", # The size of the disk in GB. 1980 "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. 1981 { # Guest OS features. 1982 "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. 1983 }, 1984 ], 1985 "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. 1986 "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. 1987 "description": "A String", # An optional description. Provide this property when creating the disk. 1988 "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. 1989 "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. 1990 "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. 1991 "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. 1992 "a_key": "A String", 1993 }, 1994 "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. 1995 "A String", 1996 ], 1997 "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk. 1998 "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. 1999 "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. 2000 "A String", 2001 ], 2002 "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. 2003 "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. 2004 "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 2005 "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/ 2006 "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=" 2007 "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 2008 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 2009 }, 2010 "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. 2011 "sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot. 2012 "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 2013 "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/ 2014 "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=" 2015 "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 2016 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 2017 }, 2018 }, 2019 "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. 2020 "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks. 2021 "licenses": [ # [Output Only] Any valid publicly visible licenses. 2022 "A String", 2023 ], 2024 "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. 2025 "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 2026 "dbs": [ # The Key Database (db). 2027 { 2028 "content": "A String", # The raw content in the secure keys file. 2029 "fileType": "A String", # The file type of source file. 2030 }, 2031 ], 2032 "dbxs": [ # The forbidden key database (dbx). 2033 { 2034 "content": "A String", # The raw content in the secure keys file. 2035 "fileType": "A String", # The file type of source file. 2036 }, 2037 ], 2038 "keks": [ # The Key Exchange Key (KEK). 2039 { 2040 "content": "A String", # The raw content in the secure keys file. 2041 "fileType": "A String", # The file type of source file. 2042 }, 2043 ], 2044 "pk": { # The Platform Key (PK). 2045 "content": "A String", # The raw content in the secure keys file. 2046 "fileType": "A String", # The file type of source file. 2047 }, 2048 }, 2049 "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. 2050 "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. 2051 }, 2052 ], 2053 "displayDevice": { # A set of Display Device options # Enables display device for the instance. 2054 "enableDisplay": True or False, # Defines whether the instance has Display enabled. 2055 }, 2056 "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. 2057 "guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance. 2058 { # A specification of the type and number of accelerator cards attached to the instance. 2059 "acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance. 2060 "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. 2061 }, 2062 ], 2063 "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. 2064 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 2065 "kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances. 2066 "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. 2067 "labels": { # Labels to apply to this instance. These can be later modified by the setLabels method. 2068 "a_key": "A String", 2069 }, 2070 "lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format. 2071 "lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format. 2072 "lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format. 2073 "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. 2074 "metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys. 2075 "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. 2076 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB. 2077 { # Metadata 2078 "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. 2079 "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). 2080 }, 2081 ], 2082 "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata. 2083 }, 2084 "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". 2085 "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. 2086 "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. 2087 { # A network interface resource attached to an instance. 2088 "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. 2089 { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. 2090 "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. 2091 "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. 2092 "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. 2093 "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. 2094 "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. 2095 "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. 2096 "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. 2097 "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. 2098 "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT. 2099 }, 2100 ], 2101 "aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks. 2102 { # An alias IP range attached to an instance's network interface. 2103 "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). 2104 "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. 2105 }, 2106 ], 2107 "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. 2108 "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. 2109 { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. 2110 "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. 2111 "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. 2112 "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. 2113 "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. 2114 "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. 2115 "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. 2116 "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. 2117 "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. 2118 "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT. 2119 }, 2120 ], 2121 "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. 2122 "ipv6Address": "A String", # An IPv6 internal network address for this network interface. 2123 "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. 2124 "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. 2125 "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 2126 "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. 2127 "nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. 2128 "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. 2129 "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. 2130 "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 2131 }, 2132 ], 2133 "networkPerformanceConfig": { 2134 "totalEgressBandwidthTier": "A String", 2135 }, 2136 "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default. 2137 "reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from. 2138 "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. 2139 "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. 2140 "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. 2141 "A String", 2142 ], 2143 }, 2144 "resourcePolicies": [ # Resource policies applied to this instance. 2145 "A String", 2146 ], 2147 "satisfiesPzs": True or False, # [Output Only] Reserved for future use. 2148 "scheduling": { # Sets the scheduling options for an Instance. NextID: 21 # Sets the scheduling options for this instance. 2149 "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. 2150 "instanceTerminationAction": "A String", # Specifies the termination action for the instance. 2151 "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. 2152 "minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. 2153 "nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity. 2154 { # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled. 2155 "key": "A String", # Corresponds to the label key of Node resource. 2156 "operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity. 2157 "values": [ # Corresponds to the label values of Node resource. 2158 "A String", 2159 ], 2160 }, 2161 ], 2162 "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. 2163 "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. 2164 "provisioningModel": "A String", # Specifies the provisioning model of the instance. 2165 }, 2166 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 2167 "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. 2168 { # A service account. 2169 "email": "A String", # Email address of the service account. 2170 "scopes": [ # The list of scopes to be made available for this service account. 2171 "A String", 2172 ], 2173 }, 2174 ], 2175 "shieldedInstanceConfig": { # A set of Shielded Instance options. 2176 "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default. 2177 "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default. 2178 "enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default. 2179 }, 2180 "shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured. 2181 "updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot. 2182 }, 2183 "sourceMachineImage": "A String", # Source machine image 2184 "sourceMachineImageEncryptionKey": { # Source machine image encryption key when creating an instance from a machine image. 2185 "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 2186 "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/ 2187 "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=" 2188 "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 2189 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 2190 }, 2191 "startRestricted": True or False, # [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity. 2192 "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. 2193 "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status. 2194 "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. 2195 "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. 2196 "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. 2197 "A String", 2198 ], 2199 }, 2200 "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. 2201} 2202 2203 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). 2204 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 2205 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 2206 x__xgafv: string, V1 error format. 2207 Allowed values 2208 1 - v1 error format 2209 2 - v2 error format 2210 2211Returns: 2212 An object of the form: 2213 2214 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 2215 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 2216 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 2217 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 2218 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 2219 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 2220 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 2221 { 2222 "code": "A String", # [Output Only] The error type identifier for this error. 2223 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 2224 "message": "A String", # [Output Only] An optional, human-readable error message. 2225 }, 2226 ], 2227 }, 2228 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 2229 "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. 2230 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 2231 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 2232 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 2233 "name": "A String", # [Output Only] Name of the operation. 2234 "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. 2235 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 2236 "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. 2237 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 2238 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 2239 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 2240 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 2241 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 2242 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 2243 "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. 2244 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 2245 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 2246 { 2247 "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. 2248 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 2249 { 2250 "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). 2251 "value": "A String", # [Output Only] A warning data value corresponding to the key. 2252 }, 2253 ], 2254 "message": "A String", # [Output Only] A human-readable description of the warning code. 2255 }, 2256 ], 2257 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 2258}</pre> 2259</div> 2260 2261<div class="method"> 2262 <code class="details" id="list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 2263 <pre>Retrieves the list of instances contained within the specified zone. 2264 2265Args: 2266 project: string, Project ID for this request. (required) 2267 zone: string, The name of the zone for this request. (required) 2268 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) ``` 2269 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`) 2270 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. 2271 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. 2272 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 2273 x__xgafv: string, V1 error format. 2274 Allowed values 2275 1 - v1 error format 2276 2 - v2 error format 2277 2278Returns: 2279 An object of the form: 2280 2281 { # Contains a list of instances. 2282 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 2283 "items": [ # A list of Instance resources. 2284 { # Represents an Instance resource. An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. 2285 "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. 2286 "enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false). 2287 "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. 2288 }, 2289 "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 . 2290 "confidentialInstanceConfig": { # A set of Confidential Instance options. 2291 "enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled. 2292 }, 2293 "cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance. 2294 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 2295 "deletionProtection": True or False, # Whether the resource should be protected against deletion. 2296 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 2297 "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them. 2298 { # An instance-attached disk resource. 2299 "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). 2300 "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. 2301 "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. 2302 "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. 2303 "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 2304 "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/ 2305 "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=" 2306 "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 2307 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 2308 }, 2309 "diskSizeGb": "A String", # The size of the disk in GB. 2310 "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. 2311 { # Guest OS features. 2312 "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. 2313 }, 2314 ], 2315 "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. 2316 "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. 2317 "description": "A String", # An optional description. Provide this property when creating the disk. 2318 "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. 2319 "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. 2320 "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. 2321 "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. 2322 "a_key": "A String", 2323 }, 2324 "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. 2325 "A String", 2326 ], 2327 "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk. 2328 "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. 2329 "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. 2330 "A String", 2331 ], 2332 "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. 2333 "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. 2334 "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 2335 "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/ 2336 "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=" 2337 "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 2338 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 2339 }, 2340 "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. 2341 "sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot. 2342 "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 2343 "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/ 2344 "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=" 2345 "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 2346 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 2347 }, 2348 }, 2349 "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. 2350 "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks. 2351 "licenses": [ # [Output Only] Any valid publicly visible licenses. 2352 "A String", 2353 ], 2354 "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. 2355 "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 2356 "dbs": [ # The Key Database (db). 2357 { 2358 "content": "A String", # The raw content in the secure keys file. 2359 "fileType": "A String", # The file type of source file. 2360 }, 2361 ], 2362 "dbxs": [ # The forbidden key database (dbx). 2363 { 2364 "content": "A String", # The raw content in the secure keys file. 2365 "fileType": "A String", # The file type of source file. 2366 }, 2367 ], 2368 "keks": [ # The Key Exchange Key (KEK). 2369 { 2370 "content": "A String", # The raw content in the secure keys file. 2371 "fileType": "A String", # The file type of source file. 2372 }, 2373 ], 2374 "pk": { # The Platform Key (PK). 2375 "content": "A String", # The raw content in the secure keys file. 2376 "fileType": "A String", # The file type of source file. 2377 }, 2378 }, 2379 "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. 2380 "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. 2381 }, 2382 ], 2383 "displayDevice": { # A set of Display Device options # Enables display device for the instance. 2384 "enableDisplay": True or False, # Defines whether the instance has Display enabled. 2385 }, 2386 "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. 2387 "guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance. 2388 { # A specification of the type and number of accelerator cards attached to the instance. 2389 "acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance. 2390 "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. 2391 }, 2392 ], 2393 "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. 2394 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 2395 "kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances. 2396 "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. 2397 "labels": { # Labels to apply to this instance. These can be later modified by the setLabels method. 2398 "a_key": "A String", 2399 }, 2400 "lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format. 2401 "lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format. 2402 "lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format. 2403 "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. 2404 "metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys. 2405 "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. 2406 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB. 2407 { # Metadata 2408 "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. 2409 "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). 2410 }, 2411 ], 2412 "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata. 2413 }, 2414 "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". 2415 "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. 2416 "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. 2417 { # A network interface resource attached to an instance. 2418 "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. 2419 { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. 2420 "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. 2421 "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. 2422 "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. 2423 "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. 2424 "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. 2425 "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. 2426 "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. 2427 "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. 2428 "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT. 2429 }, 2430 ], 2431 "aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks. 2432 { # An alias IP range attached to an instance's network interface. 2433 "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). 2434 "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. 2435 }, 2436 ], 2437 "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. 2438 "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. 2439 { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. 2440 "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. 2441 "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. 2442 "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. 2443 "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. 2444 "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. 2445 "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. 2446 "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. 2447 "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. 2448 "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT. 2449 }, 2450 ], 2451 "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. 2452 "ipv6Address": "A String", # An IPv6 internal network address for this network interface. 2453 "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. 2454 "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. 2455 "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 2456 "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. 2457 "nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. 2458 "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. 2459 "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. 2460 "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 2461 }, 2462 ], 2463 "networkPerformanceConfig": { 2464 "totalEgressBandwidthTier": "A String", 2465 }, 2466 "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default. 2467 "reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from. 2468 "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. 2469 "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. 2470 "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. 2471 "A String", 2472 ], 2473 }, 2474 "resourcePolicies": [ # Resource policies applied to this instance. 2475 "A String", 2476 ], 2477 "satisfiesPzs": True or False, # [Output Only] Reserved for future use. 2478 "scheduling": { # Sets the scheduling options for an Instance. NextID: 21 # Sets the scheduling options for this instance. 2479 "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. 2480 "instanceTerminationAction": "A String", # Specifies the termination action for the instance. 2481 "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. 2482 "minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. 2483 "nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity. 2484 { # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled. 2485 "key": "A String", # Corresponds to the label key of Node resource. 2486 "operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity. 2487 "values": [ # Corresponds to the label values of Node resource. 2488 "A String", 2489 ], 2490 }, 2491 ], 2492 "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. 2493 "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. 2494 "provisioningModel": "A String", # Specifies the provisioning model of the instance. 2495 }, 2496 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 2497 "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. 2498 { # A service account. 2499 "email": "A String", # Email address of the service account. 2500 "scopes": [ # The list of scopes to be made available for this service account. 2501 "A String", 2502 ], 2503 }, 2504 ], 2505 "shieldedInstanceConfig": { # A set of Shielded Instance options. 2506 "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default. 2507 "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default. 2508 "enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default. 2509 }, 2510 "shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured. 2511 "updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot. 2512 }, 2513 "sourceMachineImage": "A String", # Source machine image 2514 "sourceMachineImageEncryptionKey": { # Source machine image encryption key when creating an instance from a machine image. 2515 "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 2516 "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/ 2517 "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=" 2518 "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 2519 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 2520 }, 2521 "startRestricted": True or False, # [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity. 2522 "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. 2523 "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status. 2524 "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. 2525 "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. 2526 "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. 2527 "A String", 2528 ], 2529 }, 2530 "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. 2531 }, 2532 ], 2533 "kind": "compute#instanceList", # [Output Only] Type of resource. Always compute#instanceList for lists of Instance resources. 2534 "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. 2535 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 2536 "warning": { # [Output Only] Informational warning message. 2537 "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. 2538 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 2539 { 2540 "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). 2541 "value": "A String", # [Output Only] A warning data value corresponding to the key. 2542 }, 2543 ], 2544 "message": "A String", # [Output Only] A human-readable description of the warning code. 2545 }, 2546}</pre> 2547</div> 2548 2549<div class="method"> 2550 <code class="details" id="listReferrers">listReferrers(project, zone, instance, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 2551 <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. 2552 2553Args: 2554 project: string, Project ID for this request. (required) 2555 zone: string, The name of the zone for this request. (required) 2556 instance: string, Name of the target instance scoping this request, or '-' if the request should span over all instances in the container. (required) 2557 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) ``` 2558 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`) 2559 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. 2560 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. 2561 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 2562 x__xgafv: string, V1 error format. 2563 Allowed values 2564 1 - v1 error format 2565 2 - v2 error format 2566 2567Returns: 2568 An object of the form: 2569 2570 { # Contains a list of instance referrers. 2571 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 2572 "items": [ # A list of Reference resources. 2573 { # Represents a reference to a resource. 2574 "kind": "compute#reference", # [Output Only] Type of the resource. Always compute#reference for references. 2575 "referenceType": "A String", # A description of the reference type with no implied semantics. Possible values include: 1. MEMBER_OF 2576 "referrer": "A String", # URL of the resource which refers to the target. 2577 "target": "A String", # URL of the resource to which this reference points. 2578 }, 2579 ], 2580 "kind": "compute#instanceListReferrers", # [Output Only] Type of resource. Always compute#instanceListReferrers for lists of Instance referrers. 2581 "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. 2582 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 2583 "warning": { # [Output Only] Informational warning message. 2584 "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. 2585 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 2586 { 2587 "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). 2588 "value": "A String", # [Output Only] A warning data value corresponding to the key. 2589 }, 2590 ], 2591 "message": "A String", # [Output Only] A human-readable description of the warning code. 2592 }, 2593}</pre> 2594</div> 2595 2596<div class="method"> 2597 <code class="details" id="listReferrers_next">listReferrers_next(previous_request, previous_response)</code> 2598 <pre>Retrieves the next page of results. 2599 2600Args: 2601 previous_request: The request for the previous page. (required) 2602 previous_response: The response from the request for the previous page. (required) 2603 2604Returns: 2605 A request object that you can call 'execute()' on to request the next 2606 page. Returns None if there are no more items in the collection. 2607 </pre> 2608</div> 2609 2610<div class="method"> 2611 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 2612 <pre>Retrieves the next page of results. 2613 2614Args: 2615 previous_request: The request for the previous page. (required) 2616 previous_response: The response from the request for the previous page. (required) 2617 2618Returns: 2619 A request object that you can call 'execute()' on to request the next 2620 page. Returns None if there are no more items in the collection. 2621 </pre> 2622</div> 2623 2624<div class="method"> 2625 <code class="details" id="removeResourcePolicies">removeResourcePolicies(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code> 2626 <pre>Removes resource policies from an instance. 2627 2628Args: 2629 project: string, Project ID for this request. (required) 2630 zone: string, The name of the zone for this request. (required) 2631 instance: string, The instance name for this request. (required) 2632 body: object, The request body. 2633 The object takes the form of: 2634 2635{ 2636 "resourcePolicies": [ # Resource policies to be removed from this instance. 2637 "A String", 2638 ], 2639} 2640 2641 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). 2642 x__xgafv: string, V1 error format. 2643 Allowed values 2644 1 - v1 error format 2645 2 - v2 error format 2646 2647Returns: 2648 An object of the form: 2649 2650 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 2651 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 2652 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 2653 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 2654 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 2655 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 2656 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 2657 { 2658 "code": "A String", # [Output Only] The error type identifier for this error. 2659 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 2660 "message": "A String", # [Output Only] An optional, human-readable error message. 2661 }, 2662 ], 2663 }, 2664 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 2665 "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. 2666 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 2667 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 2668 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 2669 "name": "A String", # [Output Only] Name of the operation. 2670 "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. 2671 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 2672 "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. 2673 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 2674 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 2675 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 2676 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 2677 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 2678 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 2679 "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. 2680 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 2681 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 2682 { 2683 "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. 2684 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 2685 { 2686 "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). 2687 "value": "A String", # [Output Only] A warning data value corresponding to the key. 2688 }, 2689 ], 2690 "message": "A String", # [Output Only] A human-readable description of the warning code. 2691 }, 2692 ], 2693 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 2694}</pre> 2695</div> 2696 2697<div class="method"> 2698 <code class="details" id="reset">reset(project, zone, instance, requestId=None, x__xgafv=None)</code> 2699 <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. 2700 2701Args: 2702 project: string, Project ID for this request. (required) 2703 zone: string, The name of the zone for this request. (required) 2704 instance: string, Name of the instance scoping this request. (required) 2705 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). 2706 x__xgafv: string, V1 error format. 2707 Allowed values 2708 1 - v1 error format 2709 2 - v2 error format 2710 2711Returns: 2712 An object of the form: 2713 2714 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 2715 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 2716 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 2717 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 2718 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 2719 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 2720 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 2721 { 2722 "code": "A String", # [Output Only] The error type identifier for this error. 2723 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 2724 "message": "A String", # [Output Only] An optional, human-readable error message. 2725 }, 2726 ], 2727 }, 2728 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 2729 "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. 2730 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 2731 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 2732 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 2733 "name": "A String", # [Output Only] Name of the operation. 2734 "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. 2735 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 2736 "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. 2737 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 2738 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 2739 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 2740 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 2741 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 2742 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 2743 "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. 2744 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 2745 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 2746 { 2747 "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. 2748 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 2749 { 2750 "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). 2751 "value": "A String", # [Output Only] A warning data value corresponding to the key. 2752 }, 2753 ], 2754 "message": "A String", # [Output Only] A human-readable description of the warning code. 2755 }, 2756 ], 2757 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 2758}</pre> 2759</div> 2760 2761<div class="method"> 2762 <code class="details" id="sendDiagnosticInterrupt">sendDiagnosticInterrupt(project, zone, instance, x__xgafv=None)</code> 2763 <pre>Sends diagnostic interrupt to the instance. 2764 2765Args: 2766 project: string, Project ID for this request. (required) 2767 zone: string, The name of the zone for this request. (required) 2768 instance: string, Name of the instance scoping this request. (required) 2769 x__xgafv: string, V1 error format. 2770 Allowed values 2771 1 - v1 error format 2772 2 - v2 error format 2773</pre> 2774</div> 2775 2776<div class="method"> 2777 <code class="details" id="setDeletionProtection">setDeletionProtection(project, zone, resource, deletionProtection=None, requestId=None, x__xgafv=None)</code> 2778 <pre>Sets deletion protection on the instance. 2779 2780Args: 2781 project: string, Project ID for this request. (required) 2782 zone: string, The name of the zone for this request. (required) 2783 resource: string, Name or id of the resource for this request. (required) 2784 deletionProtection: boolean, Whether the resource should be protected against deletion. 2785 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). 2786 x__xgafv: string, V1 error format. 2787 Allowed values 2788 1 - v1 error format 2789 2 - v2 error format 2790 2791Returns: 2792 An object of the form: 2793 2794 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 2795 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 2796 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 2797 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 2798 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 2799 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 2800 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 2801 { 2802 "code": "A String", # [Output Only] The error type identifier for this error. 2803 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 2804 "message": "A String", # [Output Only] An optional, human-readable error message. 2805 }, 2806 ], 2807 }, 2808 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 2809 "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. 2810 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 2811 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 2812 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 2813 "name": "A String", # [Output Only] Name of the operation. 2814 "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. 2815 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 2816 "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. 2817 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 2818 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 2819 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 2820 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 2821 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 2822 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 2823 "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. 2824 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 2825 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 2826 { 2827 "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. 2828 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 2829 { 2830 "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). 2831 "value": "A String", # [Output Only] A warning data value corresponding to the key. 2832 }, 2833 ], 2834 "message": "A String", # [Output Only] A human-readable description of the warning code. 2835 }, 2836 ], 2837 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 2838}</pre> 2839</div> 2840 2841<div class="method"> 2842 <code class="details" id="setDiskAutoDelete">setDiskAutoDelete(project, zone, instance, autoDelete, deviceName, requestId=None, x__xgafv=None)</code> 2843 <pre>Sets the auto-delete flag for a disk attached to an instance. 2844 2845Args: 2846 project: string, Project ID for this request. (required) 2847 zone: string, The name of the zone for this request. (required) 2848 instance: string, The instance name for this request. (required) 2849 autoDelete: boolean, Whether to auto-delete the disk when the instance is deleted. (required) 2850 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) 2851 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). 2852 x__xgafv: string, V1 error format. 2853 Allowed values 2854 1 - v1 error format 2855 2 - v2 error format 2856 2857Returns: 2858 An object of the form: 2859 2860 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 2861 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 2862 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 2863 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 2864 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 2865 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 2866 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 2867 { 2868 "code": "A String", # [Output Only] The error type identifier for this error. 2869 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 2870 "message": "A String", # [Output Only] An optional, human-readable error message. 2871 }, 2872 ], 2873 }, 2874 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 2875 "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. 2876 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 2877 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 2878 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 2879 "name": "A String", # [Output Only] Name of the operation. 2880 "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. 2881 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 2882 "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. 2883 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 2884 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 2885 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 2886 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 2887 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 2888 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 2889 "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. 2890 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 2891 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 2892 { 2893 "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. 2894 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 2895 { 2896 "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). 2897 "value": "A String", # [Output Only] A warning data value corresponding to the key. 2898 }, 2899 ], 2900 "message": "A String", # [Output Only] A human-readable description of the warning code. 2901 }, 2902 ], 2903 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 2904}</pre> 2905</div> 2906 2907<div class="method"> 2908 <code class="details" id="setIamPolicy">setIamPolicy(project, zone, resource, body=None, x__xgafv=None)</code> 2909 <pre>Sets the access control policy on the specified resource. Replaces any existing policy. 2910 2911Args: 2912 project: string, Project ID for this request. (required) 2913 zone: string, The name of the zone for this request. (required) 2914 resource: string, Name or id of the resource for this request. (required) 2915 body: object, The request body. 2916 The object takes the form of: 2917 2918{ 2919 "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. 2920 { # Associates `members`, or principals, with a `role`. 2921 "bindingId": "A String", # This is deprecated and has no effect. Do not use. 2922 "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). 2923 "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. 2924 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 2925 "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. 2926 "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. 2927 }, 2928 "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`. 2929 "A String", 2930 ], 2931 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 2932 }, 2933 ], 2934 "etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. 2935 "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. 2936 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 2937 { # 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. 2938 "auditLogConfigs": [ # The configuration for logging of each type of permission. 2939 { # 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. 2940 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. 2941 "A String", 2942 ], 2943 "ignoreChildExemptions": True or False, # This is deprecated and has no effect. Do not use. 2944 "logType": "A String", # The log type that this config enables. 2945 }, 2946 ], 2947 "exemptedMembers": [ # This is deprecated and has no effect. Do not use. 2948 "A String", 2949 ], 2950 "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. 2951 }, 2952 ], 2953 "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`. 2954 { # Associates `members`, or principals, with a `role`. 2955 "bindingId": "A String", # This is deprecated and has no effect. Do not use. 2956 "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). 2957 "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. 2958 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 2959 "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. 2960 "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. 2961 }, 2962 "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`. 2963 "A String", 2964 ], 2965 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 2966 }, 2967 ], 2968 "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. 2969 "rules": [ # This is deprecated and has no effect. Do not use. 2970 { # This is deprecated and has no effect. Do not use. 2971 "action": "A String", # This is deprecated and has no effect. Do not use. 2972 "conditions": [ # This is deprecated and has no effect. Do not use. 2973 { # This is deprecated and has no effect. Do not use. 2974 "iam": "A String", # This is deprecated and has no effect. Do not use. 2975 "op": "A String", # This is deprecated and has no effect. Do not use. 2976 "svc": "A String", # This is deprecated and has no effect. Do not use. 2977 "sys": "A String", # This is deprecated and has no effect. Do not use. 2978 "values": [ # This is deprecated and has no effect. Do not use. 2979 "A String", 2980 ], 2981 }, 2982 ], 2983 "description": "A String", # This is deprecated and has no effect. Do not use. 2984 "ins": [ # This is deprecated and has no effect. Do not use. 2985 "A String", 2986 ], 2987 "logConfigs": [ # This is deprecated and has no effect. Do not use. 2988 { # This is deprecated and has no effect. Do not use. 2989 "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 2990 "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 2991 "permissionType": "A String", # This is deprecated and has no effect. Do not use. 2992 }, 2993 "logName": "A String", # This is deprecated and has no effect. Do not use. 2994 }, 2995 "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 2996 "customFields": [ # This is deprecated and has no effect. Do not use. 2997 { # This is deprecated and has no effect. Do not use. 2998 "name": "A String", # This is deprecated and has no effect. Do not use. 2999 "value": "A String", # This is deprecated and has no effect. Do not use. 3000 }, 3001 ], 3002 "field": "A String", # This is deprecated and has no effect. Do not use. 3003 "metric": "A String", # This is deprecated and has no effect. Do not use. 3004 }, 3005 "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 3006 "logMode": "A String", # This is deprecated and has no effect. Do not use. 3007 }, 3008 }, 3009 ], 3010 "notIns": [ # This is deprecated and has no effect. Do not use. 3011 "A String", 3012 ], 3013 "permissions": [ # This is deprecated and has no effect. Do not use. 3014 "A String", 3015 ], 3016 }, 3017 ], 3018 "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). 3019 }, 3020} 3021 3022 x__xgafv: string, V1 error format. 3023 Allowed values 3024 1 - v1 error format 3025 2 - v2 error format 3026 3027Returns: 3028 An object of the form: 3029 3030 { # 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/). 3031 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 3032 { # 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. 3033 "auditLogConfigs": [ # The configuration for logging of each type of permission. 3034 { # 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. 3035 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. 3036 "A String", 3037 ], 3038 "ignoreChildExemptions": True or False, # This is deprecated and has no effect. Do not use. 3039 "logType": "A String", # The log type that this config enables. 3040 }, 3041 ], 3042 "exemptedMembers": [ # This is deprecated and has no effect. Do not use. 3043 "A String", 3044 ], 3045 "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. 3046 }, 3047 ], 3048 "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`. 3049 { # Associates `members`, or principals, with a `role`. 3050 "bindingId": "A String", # This is deprecated and has no effect. Do not use. 3051 "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). 3052 "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. 3053 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 3054 "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. 3055 "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. 3056 }, 3057 "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`. 3058 "A String", 3059 ], 3060 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 3061 }, 3062 ], 3063 "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. 3064 "rules": [ # This is deprecated and has no effect. Do not use. 3065 { # This is deprecated and has no effect. Do not use. 3066 "action": "A String", # This is deprecated and has no effect. Do not use. 3067 "conditions": [ # This is deprecated and has no effect. Do not use. 3068 { # This is deprecated and has no effect. Do not use. 3069 "iam": "A String", # This is deprecated and has no effect. Do not use. 3070 "op": "A String", # This is deprecated and has no effect. Do not use. 3071 "svc": "A String", # This is deprecated and has no effect. Do not use. 3072 "sys": "A String", # This is deprecated and has no effect. Do not use. 3073 "values": [ # This is deprecated and has no effect. Do not use. 3074 "A String", 3075 ], 3076 }, 3077 ], 3078 "description": "A String", # This is deprecated and has no effect. Do not use. 3079 "ins": [ # This is deprecated and has no effect. Do not use. 3080 "A String", 3081 ], 3082 "logConfigs": [ # This is deprecated and has no effect. Do not use. 3083 { # This is deprecated and has no effect. Do not use. 3084 "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 3085 "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 3086 "permissionType": "A String", # This is deprecated and has no effect. Do not use. 3087 }, 3088 "logName": "A String", # This is deprecated and has no effect. Do not use. 3089 }, 3090 "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 3091 "customFields": [ # This is deprecated and has no effect. Do not use. 3092 { # This is deprecated and has no effect. Do not use. 3093 "name": "A String", # This is deprecated and has no effect. Do not use. 3094 "value": "A String", # This is deprecated and has no effect. Do not use. 3095 }, 3096 ], 3097 "field": "A String", # This is deprecated and has no effect. Do not use. 3098 "metric": "A String", # This is deprecated and has no effect. Do not use. 3099 }, 3100 "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 3101 "logMode": "A String", # This is deprecated and has no effect. Do not use. 3102 }, 3103 }, 3104 ], 3105 "notIns": [ # This is deprecated and has no effect. Do not use. 3106 "A String", 3107 ], 3108 "permissions": [ # This is deprecated and has no effect. Do not use. 3109 "A String", 3110 ], 3111 }, 3112 ], 3113 "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). 3114}</pre> 3115</div> 3116 3117<div class="method"> 3118 <code class="details" id="setLabels">setLabels(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code> 3119 <pre>Sets labels on an instance. To learn more about labels, read the Labeling Resources documentation. 3120 3121Args: 3122 project: string, Project ID for this request. (required) 3123 zone: string, The name of the zone for this request. (required) 3124 instance: string, Name of the instance scoping this request. (required) 3125 body: object, The request body. 3126 The object takes the form of: 3127 3128{ 3129 "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. 3130 "labels": { 3131 "a_key": "A String", 3132 }, 3133} 3134 3135 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). 3136 x__xgafv: string, V1 error format. 3137 Allowed values 3138 1 - v1 error format 3139 2 - v2 error format 3140 3141Returns: 3142 An object of the form: 3143 3144 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 3145 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 3146 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 3147 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 3148 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 3149 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 3150 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 3151 { 3152 "code": "A String", # [Output Only] The error type identifier for this error. 3153 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 3154 "message": "A String", # [Output Only] An optional, human-readable error message. 3155 }, 3156 ], 3157 }, 3158 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 3159 "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. 3160 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 3161 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 3162 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 3163 "name": "A String", # [Output Only] Name of the operation. 3164 "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. 3165 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 3166 "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. 3167 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 3168 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 3169 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 3170 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 3171 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 3172 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 3173 "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. 3174 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 3175 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 3176 { 3177 "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. 3178 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 3179 { 3180 "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). 3181 "value": "A String", # [Output Only] A warning data value corresponding to the key. 3182 }, 3183 ], 3184 "message": "A String", # [Output Only] A human-readable description of the warning code. 3185 }, 3186 ], 3187 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 3188}</pre> 3189</div> 3190 3191<div class="method"> 3192 <code class="details" id="setMachineResources">setMachineResources(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code> 3193 <pre>Changes the number and/or type of accelerator for a stopped instance to the values specified in the request. 3194 3195Args: 3196 project: string, Project ID for this request. (required) 3197 zone: string, The name of the zone for this request. (required) 3198 instance: string, Name of the instance scoping this request. (required) 3199 body: object, The request body. 3200 The object takes the form of: 3201 3202{ 3203 "guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance. 3204 { # A specification of the type and number of accelerator cards attached to the instance. 3205 "acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance. 3206 "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. 3207 }, 3208 ], 3209} 3210 3211 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). 3212 x__xgafv: string, V1 error format. 3213 Allowed values 3214 1 - v1 error format 3215 2 - v2 error format 3216 3217Returns: 3218 An object of the form: 3219 3220 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 3221 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 3222 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 3223 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 3224 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 3225 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 3226 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 3227 { 3228 "code": "A String", # [Output Only] The error type identifier for this error. 3229 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 3230 "message": "A String", # [Output Only] An optional, human-readable error message. 3231 }, 3232 ], 3233 }, 3234 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 3235 "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. 3236 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 3237 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 3238 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 3239 "name": "A String", # [Output Only] Name of the operation. 3240 "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. 3241 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 3242 "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. 3243 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 3244 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 3245 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 3246 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 3247 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 3248 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 3249 "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. 3250 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 3251 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 3252 { 3253 "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. 3254 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 3255 { 3256 "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). 3257 "value": "A String", # [Output Only] A warning data value corresponding to the key. 3258 }, 3259 ], 3260 "message": "A String", # [Output Only] A human-readable description of the warning code. 3261 }, 3262 ], 3263 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 3264}</pre> 3265</div> 3266 3267<div class="method"> 3268 <code class="details" id="setMachineType">setMachineType(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code> 3269 <pre>Changes the machine type for a stopped instance to the machine type specified in the request. 3270 3271Args: 3272 project: string, Project ID for this request. (required) 3273 zone: string, The name of the zone for this request. (required) 3274 instance: string, Name of the instance scoping this request. (required) 3275 body: object, The request body. 3276 The object takes the form of: 3277 3278{ 3279 "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 3280} 3281 3282 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). 3283 x__xgafv: string, V1 error format. 3284 Allowed values 3285 1 - v1 error format 3286 2 - v2 error format 3287 3288Returns: 3289 An object of the form: 3290 3291 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 3292 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 3293 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 3294 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 3295 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 3296 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 3297 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 3298 { 3299 "code": "A String", # [Output Only] The error type identifier for this error. 3300 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 3301 "message": "A String", # [Output Only] An optional, human-readable error message. 3302 }, 3303 ], 3304 }, 3305 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 3306 "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. 3307 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 3308 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 3309 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 3310 "name": "A String", # [Output Only] Name of the operation. 3311 "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. 3312 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 3313 "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. 3314 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 3315 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 3316 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 3317 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 3318 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 3319 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 3320 "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. 3321 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 3322 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 3323 { 3324 "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. 3325 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 3326 { 3327 "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). 3328 "value": "A String", # [Output Only] A warning data value corresponding to the key. 3329 }, 3330 ], 3331 "message": "A String", # [Output Only] A human-readable description of the warning code. 3332 }, 3333 ], 3334 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 3335}</pre> 3336</div> 3337 3338<div class="method"> 3339 <code class="details" id="setMetadata">setMetadata(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code> 3340 <pre>Sets metadata for the specified instance to the data included in the request. 3341 3342Args: 3343 project: string, Project ID for this request. (required) 3344 zone: string, The name of the zone for this request. (required) 3345 instance: string, Name of the instance scoping this request. (required) 3346 body: object, The request body. 3347 The object takes the form of: 3348 3349{ # A metadata key/value entry. 3350 "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. 3351 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB. 3352 { # Metadata 3353 "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. 3354 "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). 3355 }, 3356 ], 3357 "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata. 3358} 3359 3360 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). 3361 x__xgafv: string, V1 error format. 3362 Allowed values 3363 1 - v1 error format 3364 2 - v2 error format 3365 3366Returns: 3367 An object of the form: 3368 3369 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 3370 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 3371 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 3372 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 3373 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 3374 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 3375 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 3376 { 3377 "code": "A String", # [Output Only] The error type identifier for this error. 3378 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 3379 "message": "A String", # [Output Only] An optional, human-readable error message. 3380 }, 3381 ], 3382 }, 3383 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 3384 "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. 3385 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 3386 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 3387 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 3388 "name": "A String", # [Output Only] Name of the operation. 3389 "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. 3390 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 3391 "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. 3392 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 3393 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 3394 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 3395 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 3396 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 3397 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 3398 "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. 3399 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 3400 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 3401 { 3402 "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. 3403 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 3404 { 3405 "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). 3406 "value": "A String", # [Output Only] A warning data value corresponding to the key. 3407 }, 3408 ], 3409 "message": "A String", # [Output Only] A human-readable description of the warning code. 3410 }, 3411 ], 3412 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 3413}</pre> 3414</div> 3415 3416<div class="method"> 3417 <code class="details" id="setMinCpuPlatform">setMinCpuPlatform(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code> 3418 <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. 3419 3420Args: 3421 project: string, Project ID for this request. (required) 3422 zone: string, The name of the zone for this request. (required) 3423 instance: string, Name of the instance scoping this request. (required) 3424 body: object, The request body. 3425 The object takes the form of: 3426 3427{ 3428 "minCpuPlatform": "A String", # Minimum cpu/platform this instance should be started at. 3429} 3430 3431 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). 3432 x__xgafv: string, V1 error format. 3433 Allowed values 3434 1 - v1 error format 3435 2 - v2 error format 3436 3437Returns: 3438 An object of the form: 3439 3440 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 3441 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 3442 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 3443 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 3444 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 3445 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 3446 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 3447 { 3448 "code": "A String", # [Output Only] The error type identifier for this error. 3449 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 3450 "message": "A String", # [Output Only] An optional, human-readable error message. 3451 }, 3452 ], 3453 }, 3454 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 3455 "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. 3456 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 3457 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 3458 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 3459 "name": "A String", # [Output Only] Name of the operation. 3460 "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. 3461 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 3462 "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. 3463 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 3464 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 3465 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 3466 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 3467 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 3468 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 3469 "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. 3470 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 3471 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 3472 { 3473 "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. 3474 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 3475 { 3476 "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). 3477 "value": "A String", # [Output Only] A warning data value corresponding to the key. 3478 }, 3479 ], 3480 "message": "A String", # [Output Only] A human-readable description of the warning code. 3481 }, 3482 ], 3483 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 3484}</pre> 3485</div> 3486 3487<div class="method"> 3488 <code class="details" id="setScheduling">setScheduling(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code> 3489 <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. 3490 3491Args: 3492 project: string, Project ID for this request. (required) 3493 zone: string, The name of the zone for this request. (required) 3494 instance: string, Instance name for this request. (required) 3495 body: object, The request body. 3496 The object takes the form of: 3497 3498{ # Sets the scheduling options for an Instance. NextID: 21 3499 "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. 3500 "instanceTerminationAction": "A String", # Specifies the termination action for the instance. 3501 "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. 3502 "minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. 3503 "nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity. 3504 { # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled. 3505 "key": "A String", # Corresponds to the label key of Node resource. 3506 "operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity. 3507 "values": [ # Corresponds to the label values of Node resource. 3508 "A String", 3509 ], 3510 }, 3511 ], 3512 "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. 3513 "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. 3514 "provisioningModel": "A String", # Specifies the provisioning model of the instance. 3515} 3516 3517 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). 3518 x__xgafv: string, V1 error format. 3519 Allowed values 3520 1 - v1 error format 3521 2 - v2 error format 3522 3523Returns: 3524 An object of the form: 3525 3526 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 3527 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 3528 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 3529 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 3530 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 3531 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 3532 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 3533 { 3534 "code": "A String", # [Output Only] The error type identifier for this error. 3535 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 3536 "message": "A String", # [Output Only] An optional, human-readable error message. 3537 }, 3538 ], 3539 }, 3540 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 3541 "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. 3542 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 3543 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 3544 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 3545 "name": "A String", # [Output Only] Name of the operation. 3546 "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. 3547 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 3548 "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. 3549 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 3550 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 3551 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 3552 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 3553 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 3554 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 3555 "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. 3556 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 3557 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 3558 { 3559 "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. 3560 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 3561 { 3562 "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). 3563 "value": "A String", # [Output Only] A warning data value corresponding to the key. 3564 }, 3565 ], 3566 "message": "A String", # [Output Only] A human-readable description of the warning code. 3567 }, 3568 ], 3569 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 3570}</pre> 3571</div> 3572 3573<div class="method"> 3574 <code class="details" id="setServiceAccount">setServiceAccount(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code> 3575 <pre>Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance. 3576 3577Args: 3578 project: string, Project ID for this request. (required) 3579 zone: string, The name of the zone for this request. (required) 3580 instance: string, Name of the instance resource to start. (required) 3581 body: object, The request body. 3582 The object takes the form of: 3583 3584{ 3585 "email": "A String", # Email address of the service account. 3586 "scopes": [ # The list of scopes to be made available for this service account. 3587 "A String", 3588 ], 3589} 3590 3591 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). 3592 x__xgafv: string, V1 error format. 3593 Allowed values 3594 1 - v1 error format 3595 2 - v2 error format 3596 3597Returns: 3598 An object of the form: 3599 3600 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 3601 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 3602 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 3603 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 3604 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 3605 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 3606 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 3607 { 3608 "code": "A String", # [Output Only] The error type identifier for this error. 3609 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 3610 "message": "A String", # [Output Only] An optional, human-readable error message. 3611 }, 3612 ], 3613 }, 3614 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 3615 "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. 3616 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 3617 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 3618 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 3619 "name": "A String", # [Output Only] Name of the operation. 3620 "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. 3621 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 3622 "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. 3623 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 3624 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 3625 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 3626 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 3627 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 3628 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 3629 "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. 3630 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 3631 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 3632 { 3633 "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. 3634 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 3635 { 3636 "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). 3637 "value": "A String", # [Output Only] A warning data value corresponding to the key. 3638 }, 3639 ], 3640 "message": "A String", # [Output Only] A human-readable description of the warning code. 3641 }, 3642 ], 3643 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 3644}</pre> 3645</div> 3646 3647<div class="method"> 3648 <code class="details" id="setShieldedInstanceIntegrityPolicy">setShieldedInstanceIntegrityPolicy(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code> 3649 <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. 3650 3651Args: 3652 project: string, Project ID for this request. (required) 3653 zone: string, The name of the zone for this request. (required) 3654 instance: string, Name or id of the instance scoping this request. (required) 3655 body: object, The request body. 3656 The object takes the form of: 3657 3658{ # The policy describes the baseline against which Instance boot integrity is measured. 3659 "updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot. 3660} 3661 3662 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). 3663 x__xgafv: string, V1 error format. 3664 Allowed values 3665 1 - v1 error format 3666 2 - v2 error format 3667 3668Returns: 3669 An object of the form: 3670 3671 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 3672 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 3673 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 3674 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 3675 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 3676 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 3677 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 3678 { 3679 "code": "A String", # [Output Only] The error type identifier for this error. 3680 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 3681 "message": "A String", # [Output Only] An optional, human-readable error message. 3682 }, 3683 ], 3684 }, 3685 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 3686 "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. 3687 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 3688 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 3689 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 3690 "name": "A String", # [Output Only] Name of the operation. 3691 "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. 3692 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 3693 "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. 3694 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 3695 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 3696 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 3697 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 3698 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 3699 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 3700 "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. 3701 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 3702 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 3703 { 3704 "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. 3705 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 3706 { 3707 "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). 3708 "value": "A String", # [Output Only] A warning data value corresponding to the key. 3709 }, 3710 ], 3711 "message": "A String", # [Output Only] A human-readable description of the warning code. 3712 }, 3713 ], 3714 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 3715}</pre> 3716</div> 3717 3718<div class="method"> 3719 <code class="details" id="setTags">setTags(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code> 3720 <pre>Sets network tags for the specified instance to the data included in the request. 3721 3722Args: 3723 project: string, Project ID for this request. (required) 3724 zone: string, The name of the zone for this request. (required) 3725 instance: string, Name of the instance scoping this request. (required) 3726 body: object, The request body. 3727 The object takes the form of: 3728 3729{ # A set of instance tags. 3730 "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. 3731 "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. 3732 "A String", 3733 ], 3734} 3735 3736 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). 3737 x__xgafv: string, V1 error format. 3738 Allowed values 3739 1 - v1 error format 3740 2 - v2 error format 3741 3742Returns: 3743 An object of the form: 3744 3745 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 3746 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 3747 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 3748 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 3749 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 3750 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 3751 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 3752 { 3753 "code": "A String", # [Output Only] The error type identifier for this error. 3754 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 3755 "message": "A String", # [Output Only] An optional, human-readable error message. 3756 }, 3757 ], 3758 }, 3759 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 3760 "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. 3761 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 3762 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 3763 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 3764 "name": "A String", # [Output Only] Name of the operation. 3765 "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. 3766 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 3767 "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. 3768 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 3769 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 3770 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 3771 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 3772 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 3773 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 3774 "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. 3775 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 3776 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 3777 { 3778 "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. 3779 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 3780 { 3781 "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). 3782 "value": "A String", # [Output Only] A warning data value corresponding to the key. 3783 }, 3784 ], 3785 "message": "A String", # [Output Only] A human-readable description of the warning code. 3786 }, 3787 ], 3788 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 3789}</pre> 3790</div> 3791 3792<div class="method"> 3793 <code class="details" id="simulateMaintenanceEvent">simulateMaintenanceEvent(project, zone, instance, x__xgafv=None)</code> 3794 <pre>Simulates a maintenance event on the instance. 3795 3796Args: 3797 project: string, Project ID for this request. (required) 3798 zone: string, The name of the zone for this request. (required) 3799 instance: string, Name of the instance scoping this request. (required) 3800 x__xgafv: string, V1 error format. 3801 Allowed values 3802 1 - v1 error format 3803 2 - v2 error format 3804 3805Returns: 3806 An object of the form: 3807 3808 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 3809 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 3810 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 3811 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 3812 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 3813 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 3814 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 3815 { 3816 "code": "A String", # [Output Only] The error type identifier for this error. 3817 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 3818 "message": "A String", # [Output Only] An optional, human-readable error message. 3819 }, 3820 ], 3821 }, 3822 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 3823 "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. 3824 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 3825 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 3826 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 3827 "name": "A String", # [Output Only] Name of the operation. 3828 "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. 3829 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 3830 "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. 3831 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 3832 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 3833 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 3834 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 3835 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 3836 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 3837 "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. 3838 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 3839 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 3840 { 3841 "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. 3842 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 3843 { 3844 "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). 3845 "value": "A String", # [Output Only] A warning data value corresponding to the key. 3846 }, 3847 ], 3848 "message": "A String", # [Output Only] A human-readable description of the warning code. 3849 }, 3850 ], 3851 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 3852}</pre> 3853</div> 3854 3855<div class="method"> 3856 <code class="details" id="start">start(project, zone, instance, requestId=None, x__xgafv=None)</code> 3857 <pre>Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance. 3858 3859Args: 3860 project: string, Project ID for this request. (required) 3861 zone: string, The name of the zone for this request. (required) 3862 instance: string, Name of the instance resource to start. (required) 3863 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). 3864 x__xgafv: string, V1 error format. 3865 Allowed values 3866 1 - v1 error format 3867 2 - v2 error format 3868 3869Returns: 3870 An object of the form: 3871 3872 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 3873 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 3874 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 3875 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 3876 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 3877 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 3878 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 3879 { 3880 "code": "A String", # [Output Only] The error type identifier for this error. 3881 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 3882 "message": "A String", # [Output Only] An optional, human-readable error message. 3883 }, 3884 ], 3885 }, 3886 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 3887 "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. 3888 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 3889 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 3890 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 3891 "name": "A String", # [Output Only] Name of the operation. 3892 "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. 3893 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 3894 "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. 3895 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 3896 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 3897 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 3898 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 3899 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 3900 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 3901 "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. 3902 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 3903 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 3904 { 3905 "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. 3906 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 3907 { 3908 "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). 3909 "value": "A String", # [Output Only] A warning data value corresponding to the key. 3910 }, 3911 ], 3912 "message": "A String", # [Output Only] A human-readable description of the warning code. 3913 }, 3914 ], 3915 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 3916}</pre> 3917</div> 3918 3919<div class="method"> 3920 <code class="details" id="startWithEncryptionKey">startWithEncryptionKey(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code> 3921 <pre>Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance. 3922 3923Args: 3924 project: string, Project ID for this request. (required) 3925 zone: string, The name of the zone for this request. (required) 3926 instance: string, Name of the instance resource to start. (required) 3927 body: object, The request body. 3928 The object takes the form of: 3929 3930{ 3931 "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. 3932 { 3933 "diskEncryptionKey": { # Decrypts data associated with the disk with a customer-supplied encryption key. 3934 "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 3935 "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/ 3936 "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=" 3937 "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 3938 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 3939 }, 3940 "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 3941 }, 3942 ], 3943} 3944 3945 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). 3946 x__xgafv: string, V1 error format. 3947 Allowed values 3948 1 - v1 error format 3949 2 - v2 error format 3950 3951Returns: 3952 An object of the form: 3953 3954 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 3955 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 3956 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 3957 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 3958 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 3959 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 3960 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 3961 { 3962 "code": "A String", # [Output Only] The error type identifier for this error. 3963 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 3964 "message": "A String", # [Output Only] An optional, human-readable error message. 3965 }, 3966 ], 3967 }, 3968 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 3969 "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. 3970 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 3971 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 3972 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 3973 "name": "A String", # [Output Only] Name of the operation. 3974 "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. 3975 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 3976 "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. 3977 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 3978 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 3979 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 3980 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 3981 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 3982 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 3983 "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. 3984 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 3985 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 3986 { 3987 "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. 3988 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 3989 { 3990 "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). 3991 "value": "A String", # [Output Only] A warning data value corresponding to the key. 3992 }, 3993 ], 3994 "message": "A String", # [Output Only] A human-readable description of the warning code. 3995 }, 3996 ], 3997 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 3998}</pre> 3999</div> 4000 4001<div class="method"> 4002 <code class="details" id="stop">stop(project, zone, instance, requestId=None, x__xgafv=None)</code> 4003 <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. 4004 4005Args: 4006 project: string, Project ID for this request. (required) 4007 zone: string, The name of the zone for this request. (required) 4008 instance: string, Name of the instance resource to stop. (required) 4009 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). 4010 x__xgafv: string, V1 error format. 4011 Allowed values 4012 1 - v1 error format 4013 2 - v2 error format 4014 4015Returns: 4016 An object of the form: 4017 4018 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 4019 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 4020 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 4021 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 4022 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 4023 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 4024 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 4025 { 4026 "code": "A String", # [Output Only] The error type identifier for this error. 4027 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 4028 "message": "A String", # [Output Only] An optional, human-readable error message. 4029 }, 4030 ], 4031 }, 4032 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 4033 "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. 4034 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 4035 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 4036 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 4037 "name": "A String", # [Output Only] Name of the operation. 4038 "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. 4039 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 4040 "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. 4041 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 4042 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 4043 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 4044 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 4045 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 4046 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 4047 "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. 4048 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 4049 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 4050 { 4051 "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. 4052 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 4053 { 4054 "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). 4055 "value": "A String", # [Output Only] A warning data value corresponding to the key. 4056 }, 4057 ], 4058 "message": "A String", # [Output Only] A human-readable description of the warning code. 4059 }, 4060 ], 4061 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 4062}</pre> 4063</div> 4064 4065<div class="method"> 4066 <code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body=None, x__xgafv=None)</code> 4067 <pre>Returns permissions that a caller has on the specified resource. 4068 4069Args: 4070 project: string, Project ID for this request. (required) 4071 zone: string, The name of the zone for this request. (required) 4072 resource: string, Name or id of the resource for this request. (required) 4073 body: object, The request body. 4074 The object takes the form of: 4075 4076{ 4077 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 4078 "A String", 4079 ], 4080} 4081 4082 x__xgafv: string, V1 error format. 4083 Allowed values 4084 1 - v1 error format 4085 2 - v2 error format 4086 4087Returns: 4088 An object of the form: 4089 4090 { 4091 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 4092 "A String", 4093 ], 4094}</pre> 4095</div> 4096 4097<div class="method"> 4098 <code class="details" id="update">update(project, zone, instance, body=None, minimalAction=None, mostDisruptiveAllowedAction=None, requestId=None, x__xgafv=None)</code> 4099 <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. 4100 4101Args: 4102 project: string, Project ID for this request. (required) 4103 zone: string, The name of the zone for this request. (required) 4104 instance: string, Name of the instance resource to update. (required) 4105 body: object, The request body. 4106 The object takes the form of: 4107 4108{ # Represents an Instance resource. An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. 4109 "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. 4110 "enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false). 4111 "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. 4112 }, 4113 "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 . 4114 "confidentialInstanceConfig": { # A set of Confidential Instance options. 4115 "enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled. 4116 }, 4117 "cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance. 4118 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 4119 "deletionProtection": True or False, # Whether the resource should be protected against deletion. 4120 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 4121 "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them. 4122 { # An instance-attached disk resource. 4123 "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). 4124 "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. 4125 "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. 4126 "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. 4127 "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 4128 "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/ 4129 "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=" 4130 "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 4131 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 4132 }, 4133 "diskSizeGb": "A String", # The size of the disk in GB. 4134 "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. 4135 { # Guest OS features. 4136 "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. 4137 }, 4138 ], 4139 "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. 4140 "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. 4141 "description": "A String", # An optional description. Provide this property when creating the disk. 4142 "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. 4143 "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. 4144 "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. 4145 "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. 4146 "a_key": "A String", 4147 }, 4148 "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. 4149 "A String", 4150 ], 4151 "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk. 4152 "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. 4153 "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. 4154 "A String", 4155 ], 4156 "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. 4157 "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. 4158 "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 4159 "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/ 4160 "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=" 4161 "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 4162 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 4163 }, 4164 "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. 4165 "sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot. 4166 "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 4167 "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/ 4168 "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=" 4169 "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 4170 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 4171 }, 4172 }, 4173 "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. 4174 "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks. 4175 "licenses": [ # [Output Only] Any valid publicly visible licenses. 4176 "A String", 4177 ], 4178 "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. 4179 "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 4180 "dbs": [ # The Key Database (db). 4181 { 4182 "content": "A String", # The raw content in the secure keys file. 4183 "fileType": "A String", # The file type of source file. 4184 }, 4185 ], 4186 "dbxs": [ # The forbidden key database (dbx). 4187 { 4188 "content": "A String", # The raw content in the secure keys file. 4189 "fileType": "A String", # The file type of source file. 4190 }, 4191 ], 4192 "keks": [ # The Key Exchange Key (KEK). 4193 { 4194 "content": "A String", # The raw content in the secure keys file. 4195 "fileType": "A String", # The file type of source file. 4196 }, 4197 ], 4198 "pk": { # The Platform Key (PK). 4199 "content": "A String", # The raw content in the secure keys file. 4200 "fileType": "A String", # The file type of source file. 4201 }, 4202 }, 4203 "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. 4204 "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. 4205 }, 4206 ], 4207 "displayDevice": { # A set of Display Device options # Enables display device for the instance. 4208 "enableDisplay": True or False, # Defines whether the instance has Display enabled. 4209 }, 4210 "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. 4211 "guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance. 4212 { # A specification of the type and number of accelerator cards attached to the instance. 4213 "acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance. 4214 "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. 4215 }, 4216 ], 4217 "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. 4218 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 4219 "kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances. 4220 "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. 4221 "labels": { # Labels to apply to this instance. These can be later modified by the setLabels method. 4222 "a_key": "A String", 4223 }, 4224 "lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format. 4225 "lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format. 4226 "lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format. 4227 "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. 4228 "metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys. 4229 "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. 4230 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB. 4231 { # Metadata 4232 "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. 4233 "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). 4234 }, 4235 ], 4236 "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata. 4237 }, 4238 "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". 4239 "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. 4240 "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. 4241 { # A network interface resource attached to an instance. 4242 "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. 4243 { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. 4244 "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. 4245 "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. 4246 "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. 4247 "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. 4248 "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. 4249 "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. 4250 "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. 4251 "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. 4252 "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT. 4253 }, 4254 ], 4255 "aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks. 4256 { # An alias IP range attached to an instance's network interface. 4257 "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). 4258 "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. 4259 }, 4260 ], 4261 "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. 4262 "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. 4263 { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. 4264 "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. 4265 "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. 4266 "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. 4267 "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. 4268 "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. 4269 "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. 4270 "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. 4271 "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. 4272 "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT. 4273 }, 4274 ], 4275 "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. 4276 "ipv6Address": "A String", # An IPv6 internal network address for this network interface. 4277 "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. 4278 "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. 4279 "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 4280 "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. 4281 "nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. 4282 "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. 4283 "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. 4284 "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 4285 }, 4286 ], 4287 "networkPerformanceConfig": { 4288 "totalEgressBandwidthTier": "A String", 4289 }, 4290 "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default. 4291 "reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from. 4292 "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. 4293 "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. 4294 "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. 4295 "A String", 4296 ], 4297 }, 4298 "resourcePolicies": [ # Resource policies applied to this instance. 4299 "A String", 4300 ], 4301 "satisfiesPzs": True or False, # [Output Only] Reserved for future use. 4302 "scheduling": { # Sets the scheduling options for an Instance. NextID: 21 # Sets the scheduling options for this instance. 4303 "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. 4304 "instanceTerminationAction": "A String", # Specifies the termination action for the instance. 4305 "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. 4306 "minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. 4307 "nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity. 4308 { # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled. 4309 "key": "A String", # Corresponds to the label key of Node resource. 4310 "operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity. 4311 "values": [ # Corresponds to the label values of Node resource. 4312 "A String", 4313 ], 4314 }, 4315 ], 4316 "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. 4317 "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. 4318 "provisioningModel": "A String", # Specifies the provisioning model of the instance. 4319 }, 4320 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 4321 "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. 4322 { # A service account. 4323 "email": "A String", # Email address of the service account. 4324 "scopes": [ # The list of scopes to be made available for this service account. 4325 "A String", 4326 ], 4327 }, 4328 ], 4329 "shieldedInstanceConfig": { # A set of Shielded Instance options. 4330 "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default. 4331 "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default. 4332 "enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default. 4333 }, 4334 "shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured. 4335 "updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot. 4336 }, 4337 "sourceMachineImage": "A String", # Source machine image 4338 "sourceMachineImageEncryptionKey": { # Source machine image encryption key when creating an instance from a machine image. 4339 "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 4340 "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/ 4341 "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=" 4342 "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 4343 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 4344 }, 4345 "startRestricted": True or False, # [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity. 4346 "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. 4347 "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status. 4348 "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. 4349 "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. 4350 "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. 4351 "A String", 4352 ], 4353 }, 4354 "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. 4355} 4356 4357 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. 4358 Allowed values 4359 INVALID - 4360 NO_EFFECT - No changes can be made to the instance. 4361 REFRESH - The instance will not restart. 4362 RESTART - The instance will restart. 4363 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. 4364 Allowed values 4365 INVALID - 4366 NO_EFFECT - No changes can be made to the instance. 4367 REFRESH - The instance will not restart. 4368 RESTART - The instance will restart. 4369 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). 4370 x__xgafv: string, V1 error format. 4371 Allowed values 4372 1 - v1 error format 4373 2 - v2 error format 4374 4375Returns: 4376 An object of the form: 4377 4378 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 4379 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 4380 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 4381 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 4382 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 4383 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 4384 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 4385 { 4386 "code": "A String", # [Output Only] The error type identifier for this error. 4387 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 4388 "message": "A String", # [Output Only] An optional, human-readable error message. 4389 }, 4390 ], 4391 }, 4392 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 4393 "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. 4394 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 4395 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 4396 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 4397 "name": "A String", # [Output Only] Name of the operation. 4398 "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. 4399 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 4400 "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. 4401 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 4402 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 4403 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 4404 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 4405 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 4406 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 4407 "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. 4408 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 4409 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 4410 { 4411 "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. 4412 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 4413 { 4414 "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). 4415 "value": "A String", # [Output Only] A warning data value corresponding to the key. 4416 }, 4417 ], 4418 "message": "A String", # [Output Only] A human-readable description of the warning code. 4419 }, 4420 ], 4421 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 4422}</pre> 4423</div> 4424 4425<div class="method"> 4426 <code class="details" id="updateAccessConfig">updateAccessConfig(project, zone, instance, networkInterface, body=None, requestId=None, x__xgafv=None)</code> 4427 <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. 4428 4429Args: 4430 project: string, Project ID for this request. (required) 4431 zone: string, The name of the zone for this request. (required) 4432 instance: string, The instance name for this request. (required) 4433 networkInterface: string, The name of the network interface where the access config is attached. (required) 4434 body: object, The request body. 4435 The object takes the form of: 4436 4437{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported. 4438 "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. 4439 "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. 4440 "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. 4441 "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. 4442 "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. 4443 "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. 4444 "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. 4445 "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. 4446 "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT. 4447} 4448 4449 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). 4450 x__xgafv: string, V1 error format. 4451 Allowed values 4452 1 - v1 error format 4453 2 - v2 error format 4454 4455Returns: 4456 An object of the form: 4457 4458 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 4459 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 4460 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 4461 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 4462 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 4463 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 4464 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 4465 { 4466 "code": "A String", # [Output Only] The error type identifier for this error. 4467 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 4468 "message": "A String", # [Output Only] An optional, human-readable error message. 4469 }, 4470 ], 4471 }, 4472 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 4473 "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. 4474 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 4475 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 4476 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 4477 "name": "A String", # [Output Only] Name of the operation. 4478 "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. 4479 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 4480 "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. 4481 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 4482 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 4483 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 4484 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 4485 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 4486 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 4487 "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. 4488 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 4489 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 4490 { 4491 "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. 4492 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 4493 { 4494 "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). 4495 "value": "A String", # [Output Only] A warning data value corresponding to the key. 4496 }, 4497 ], 4498 "message": "A String", # [Output Only] A human-readable description of the warning code. 4499 }, 4500 ], 4501 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 4502}</pre> 4503</div> 4504 4505<div class="method"> 4506 <code class="details" id="updateDisplayDevice">updateDisplayDevice(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code> 4507 <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. 4508 4509Args: 4510 project: string, Project ID for this request. (required) 4511 zone: string, The name of the zone for this request. (required) 4512 instance: string, Name of the instance scoping this request. (required) 4513 body: object, The request body. 4514 The object takes the form of: 4515 4516{ # A set of Display Device options 4517 "enableDisplay": True or False, # Defines whether the instance has Display enabled. 4518} 4519 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/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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="updateNetworkInterface">updateNetworkInterface(project, zone, instance, networkInterface, body=None, requestId=None, x__xgafv=None)</code> 4578 <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. 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, The instance name for this request. (required) 4584 networkInterface: string, The name of the network interface to update. (required) 4585 body: object, The request body. 4586 The object takes the form of: 4587 4588{ # A network interface resource attached to an instance. 4589 "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. 4590 { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. 4591 "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. 4592 "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. 4593 "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. 4594 "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. 4595 "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. 4596 "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. 4597 "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. 4598 "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. 4599 "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT. 4600 }, 4601 ], 4602 "aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks. 4603 { # An alias IP range attached to an instance's network interface. 4604 "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). 4605 "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. 4606 }, 4607 ], 4608 "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. 4609 "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. 4610 { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. 4611 "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. 4612 "externalIpv6PrefixLength": 42, # The prefix length of the external IPv6 range. 4613 "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. 4614 "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. 4615 "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. 4616 "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. 4617 "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. 4618 "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. 4619 "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT. 4620 }, 4621 ], 4622 "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. 4623 "ipv6Address": "A String", # An IPv6 internal network address for this network interface. 4624 "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. 4625 "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. 4626 "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 4627 "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. 4628 "nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. 4629 "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. 4630 "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. 4631 "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 4632} 4633 4634 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). 4635 x__xgafv: string, V1 error format. 4636 Allowed values 4637 1 - v1 error format 4638 2 - v2 error format 4639 4640Returns: 4641 An object of the form: 4642 4643 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 4644 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 4645 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 4646 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 4647 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 4648 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 4649 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 4650 { 4651 "code": "A String", # [Output Only] The error type identifier for this error. 4652 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 4653 "message": "A String", # [Output Only] An optional, human-readable error message. 4654 }, 4655 ], 4656 }, 4657 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 4658 "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. 4659 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 4660 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 4661 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 4662 "name": "A String", # [Output Only] Name of the operation. 4663 "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. 4664 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 4665 "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. 4666 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 4667 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 4668 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 4669 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 4670 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 4671 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 4672 "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. 4673 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 4674 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 4675 { 4676 "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. 4677 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 4678 { 4679 "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). 4680 "value": "A String", # [Output Only] A warning data value corresponding to the key. 4681 }, 4682 ], 4683 "message": "A String", # [Output Only] A human-readable description of the warning code. 4684 }, 4685 ], 4686 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 4687}</pre> 4688</div> 4689 4690<div class="method"> 4691 <code class="details" id="updateShieldedInstanceConfig">updateShieldedInstanceConfig(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code> 4692 <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. 4693 4694Args: 4695 project: string, Project ID for this request. (required) 4696 zone: string, The name of the zone for this request. (required) 4697 instance: string, Name or id of the instance scoping this request. (required) 4698 body: object, The request body. 4699 The object takes the form of: 4700 4701{ # A set of Shielded Instance options. 4702 "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default. 4703 "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default. 4704 "enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default. 4705} 4706 4707 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). 4708 x__xgafv: string, V1 error format. 4709 Allowed values 4710 1 - v1 error format 4711 2 - v2 error format 4712 4713Returns: 4714 An object of the form: 4715 4716 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 4717 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 4718 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 4719 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 4720 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 4721 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 4722 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 4723 { 4724 "code": "A String", # [Output Only] The error type identifier for this error. 4725 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 4726 "message": "A String", # [Output Only] An optional, human-readable error message. 4727 }, 4728 ], 4729 }, 4730 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 4731 "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. 4732 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 4733 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 4734 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 4735 "name": "A String", # [Output Only] Name of the operation. 4736 "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. 4737 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 4738 "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. 4739 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 4740 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 4741 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 4742 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 4743 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 4744 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 4745 "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. 4746 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 4747 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 4748 { 4749 "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. 4750 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 4751 { 4752 "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). 4753 "value": "A String", # [Output Only] A warning data value corresponding to the key. 4754 }, 4755 ], 4756 "message": "A String", # [Output Only] A human-readable description of the warning code. 4757 }, 4758 ], 4759 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 4760}</pre> 4761</div> 4762 4763</body></html>