1 <html><body> 2 <style> 3 4 body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13 } 14 15 body { 16 font-size: 13px; 17 padding: 1em; 18 } 19 20 h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23 } 24 25 h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28 } 29 30 h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34 } 35 36 pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39 } 40 41 pre { 42 margin-top: 0.5em; 43 } 44 45 h1, h2, h3, p { 46 font-family: Arial, sans serif; 47 } 48 49 h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51 } 52 53 .toc_element { 54 margin-top: 0.5em; 55 } 56 57 .firstline { 58 margin-left: 2 em; 59 } 60 61 .method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66 } 67 68 .details { 69 font-weight: bold; 70 font-size: 14px; 71 } 72 73 </style> 74 75 <h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.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, requestId=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="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 82 <p class="firstline">Retrieves aggregated list of instances.</p> 83 <p class="toc_element"> 84 <code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p> 85 <p class="firstline">Retrieves the next page of results.</p> 86 <p class="toc_element"> 87 <code><a href="#attachDisk">attachDisk(project, zone, instance, body, forceAttach=None, requestId=None)</a></code></p> 88 <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> 89 <p class="toc_element"> 90 <code><a href="#delete">delete(project, zone, instance, requestId=None)</a></code></p> 91 <p class="firstline">Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance.</p> 92 <p class="toc_element"> 93 <code><a href="#deleteAccessConfig">deleteAccessConfig(project, zone, instance, accessConfig, networkInterface, requestId=None)</a></code></p> 94 <p class="firstline">Deletes an access config from an instance's network interface.</p> 95 <p class="toc_element"> 96 <code><a href="#detachDisk">detachDisk(project, zone, instance, deviceName, requestId=None)</a></code></p> 97 <p class="firstline">Detaches a disk from an instance.</p> 98 <p class="toc_element"> 99 <code><a href="#get">get(project, zone, instance)</a></code></p> 100 <p class="firstline">Returns the specified Instance resource. Get a list of available instances by making a list() request.</p> 101 <p class="toc_element"> 102 <code><a href="#getIamPolicy">getIamPolicy(project, zone, resource)</a></code></p> 103 <p class="firstline">Gets the access control policy for a resource. May be empty if no such policy or resource exists.</p> 104 <p class="toc_element"> 105 <code><a href="#getSerialPortOutput">getSerialPortOutput(project, zone, instance, start=None, port=None)</a></code></p> 106 <p class="firstline">Returns the specified instance's serial port output.</p> 107 <p class="toc_element"> 108 <code><a href="#insert">insert(project, zone, body, requestId=None)</a></code></p> 109 <p class="firstline">Creates an instance resource in the specified project using the data included in the request.</p> 110 <p class="toc_element"> 111 <code><a href="#list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 112 <p class="firstline">Retrieves the list of instances contained within the specified zone.</p> 113 <p class="toc_element"> 114 <code><a href="#listReferrers">listReferrers(project, zone, instance, orderBy=None, filter=None, maxResults=None, pageToken=None)</a></code></p> 115 <p class="firstline">Retrieves the list of referrers to instances contained within the specified zone.</p> 116 <p class="toc_element"> 117 <code><a href="#listReferrers_next">listReferrers_next(previous_request, previous_response)</a></code></p> 118 <p class="firstline">Retrieves the next page of results.</p> 119 <p class="toc_element"> 120 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 121 <p class="firstline">Retrieves the next page of results.</p> 122 <p class="toc_element"> 123 <code><a href="#reset">reset(project, zone, instance, requestId=None)</a></code></p> 124 <p class="firstline">Performs a reset on the instance. For more information, see Resetting an instance.</p> 125 <p class="toc_element"> 126 <code><a href="#setDiskAutoDelete">setDiskAutoDelete(project, zone, instance, autoDelete, deviceName, requestId=None)</a></code></p> 127 <p class="firstline">Sets the auto-delete flag for a disk attached to an instance.</p> 128 <p class="toc_element"> 129 <code><a href="#setIamPolicy">setIamPolicy(project, zone, resource, body)</a></code></p> 130 <p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p> 131 <p class="toc_element"> 132 <code><a href="#setLabels">setLabels(project, zone, instance, body, requestId=None)</a></code></p> 133 <p class="firstline">Sets labels on an instance. To learn more about labels, read the Labeling or Tagging Resources documentation.</p> 134 <p class="toc_element"> 135 <code><a href="#setMachineResources">setMachineResources(project, zone, instance, body, requestId=None)</a></code></p> 136 <p class="firstline">Changes the number and/or type of accelerator for a stopped instance to the values specified in the request.</p> 137 <p class="toc_element"> 138 <code><a href="#setMachineType">setMachineType(project, zone, instance, body, requestId=None)</a></code></p> 139 <p class="firstline">Changes the machine type for a stopped instance to the machine type specified in the request.</p> 140 <p class="toc_element"> 141 <code><a href="#setMetadata">setMetadata(project, zone, instance, body, requestId=None)</a></code></p> 142 <p class="firstline">Sets metadata for the specified instance to the data included in the request.</p> 143 <p class="toc_element"> 144 <code><a href="#setMinCpuPlatform">setMinCpuPlatform(project, zone, instance, body, requestId=None)</a></code></p> 145 <p class="firstline">Changes the minimum cpu/platform that this instance should be started as. This is called on a stopped instance.</p> 146 <p class="toc_element"> 147 <code><a href="#setScheduling">setScheduling(project, zone, instance, body, requestId=None)</a></code></p> 148 <p class="firstline">Sets an instance's scheduling options.</p> 149 <p class="toc_element"> 150 <code><a href="#setServiceAccount">setServiceAccount(project, zone, instance, body, requestId=None)</a></code></p> 151 <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> 152 <p class="toc_element"> 153 <code><a href="#setTags">setTags(project, zone, instance, body, requestId=None)</a></code></p> 154 <p class="firstline">Sets tags for the specified instance to the data included in the request.</p> 155 <p class="toc_element"> 156 <code><a href="#simulateMaintenanceEvent">simulateMaintenanceEvent(project, zone, instance)</a></code></p> 157 <p class="firstline">Simulates a maintenance event on the instance.</p> 158 <p class="toc_element"> 159 <code><a href="#start">start(project, zone, instance, requestId=None)</a></code></p> 160 <p class="firstline">Starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.</p> 161 <p class="toc_element"> 162 <code><a href="#startWithEncryptionKey">startWithEncryptionKey(project, zone, instance, body, requestId=None)</a></code></p> 163 <p class="firstline">Starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.</p> 164 <p class="toc_element"> 165 <code><a href="#stop">stop(project, zone, instance, discardLocalSsd=None, requestId=None)</a></code></p> 166 <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 per-minute, virtual machine usage charges while they are stopped, but any resources that the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance.</p> 167 <p class="toc_element"> 168 <code><a href="#suspend">suspend(project, zone, instance, discardLocalSsd=None, requestId=None)</a></code></p> 169 <p class="firstline">This method suspends a running instance, saving its state to persistent storage, and allows you to resume the instance at a later time. Suspended instances incur reduced per-minute, virtual machine usage charges while they are suspended. Any resources the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted.</p> 170 <p class="toc_element"> 171 <code><a href="#testIamPermissions">testIamPermissions(project, zone, resource, body)</a></code></p> 172 <p class="firstline">Returns permissions that a caller has on the specified resource.</p> 173 <p class="toc_element"> 174 <code><a href="#updateAccessConfig">updateAccessConfig(project, zone, instance, networkInterface, body, requestId=None)</a></code></p> 175 <p class="firstline">Updates the specified access config from an instance's network interface with the data included in the request.</p> 176 <p class="toc_element"> 177 <code><a href="#updateNetworkInterface">updateNetworkInterface(project, zone, instance, networkInterface, body, requestId=None)</a></code></p> 178 <p class="firstline">Updates an instance's network interface. This method follows PATCH semantics.</p> 179 <h3>Method Details</h3> 180 <div class="method"> 181 <code class="details" id="addAccessConfig">addAccessConfig(project, zone, instance, networkInterface, body, requestId=None)</code> 182 <pre>Adds an access config to an instance's network interface. 183 184 Args: 185 project: string, Project ID for this request. (required) 186 zone: string, The name of the zone for this request. (required) 187 instance: string, The instance name for this request. (required) 188 networkInterface: string, The name of the network interface to add to this instance. (required) 189 body: object, The request body. (required) 190 The object takes the form of: 191 192 { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. 193 "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. 194 "name": "A String", # The name of this access configuration. The default and recommended name is External NAT but you can use any arbitrary string you would like. For example, My external IP or Network Access. 195 "setPublicDns": True or False, # Specifies whether a public DNS ?A? record should be created for the external IP address of this access configuration. 196 "publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance. 197 "networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM , SELECT. If this field is not specified, it is assumed to be PREMIUM. 198 "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. 199 "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. 200 "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT. 201 "publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. This field can only be set when the set_public_ptr field is enabled. 202 } 203 204 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 205 206 Returns: 207 An object of the form: 208 209 { # An Operation resource, used to manage asynchronous API requests. 210 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 211 "clientOperationId": "A String", # [Output Only] Reserved for future use. 212 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 213 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 214 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 215 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 216 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 217 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 218 "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. 219 "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. 220 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 221 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 222 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 223 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 224 { 225 "message": "A String", # [Output Only] A human-readable description of the warning code. 226 "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. 227 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 228 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 229 { 230 "value": "A String", # [Output Only] A warning data value corresponding to the key. 231 "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). 232 }, 233 ], 234 }, 235 ], 236 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 237 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 238 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 239 "name": "A String", # [Output Only] Name of the resource. 240 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 241 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 242 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 243 { 244 "message": "A String", # [Output Only] An optional, human-readable error message. 245 "code": "A String", # [Output Only] The error type identifier for this error. 246 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 247 }, 248 ], 249 }, 250 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 251 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 252 "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. 253 }</pre> 254 </div> 255 256 <div class="method"> 257 <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 258 <pre>Retrieves aggregated list of instances. 259 260 Args: 261 project: string, Project ID for this request. (required) 262 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 263 264 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. 265 266 Currently, only sorting by name or creationTimestamp desc is supported. 267 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) 268 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. 269 filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. 270 271 The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. 272 273 For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. 274 275 You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. 276 277 To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. 278 279 Returns: 280 An object of the form: 281 282 { 283 "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. 284 "items": { # [Output Only] A map of scoped instance lists. 285 "a_key": { # [Output Only] Name of the scope containing this set of instances. 286 "instances": [ # [Output Only] List of instances contained in this scope. 287 { # An Instance resource. 288 "status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, and TERMINATED. 289 "guestAccelerators": [ # List of the type and count of accelerator cards attached to the instance. 290 { # A specification of the type and number of accelerator cards attached to the instance. 291 "acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance. 292 "acceleratorType": "A String", # Full or partial URL of the accelerator type resource to expose to this instance. 293 }, 294 ], 295 "labels": { # Labels to apply to this instance. These can be later modified by the setLabels method. 296 "a_key": "A String", 297 }, 298 "scheduling": { # Sets the scheduling options for an Instance. # Sets the scheduling options for this instance. 299 "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. 300 # 301 # By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. 302 "preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation, it cannot be set or changed after the instance has been created. 303 "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. 304 }, 305 "minCpuPlatform": "A String", # Minimum cpu/platform to be used by this instance. We may schedule on the specified or later cpu/platform. 306 "serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. 307 # 308 # 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. 309 { # A service account. 310 "scopes": [ # The list of scopes to be made available for this service account. 311 "A String", 312 ], 313 "email": "A String", # Email address of the service account. 314 }, 315 ], 316 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 317 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 318 "networkInterfaces": [ # An array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Only one interface is supported per instance. 319 { # A network interface resource attached to an instance. 320 "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. 321 "aliasIpRanges": [ # An array of alias IP ranges for this network interface. Can only be specified for network interfaces on subnet-mode networks. 322 { # An alias IP range attached to an instance's network interface. 323 "subnetworkRangeName": "A String", # Optional subnetwork secondary range name specifying the secondary range from which to allocate the IP CIDR range for this alias IP range. If left unspecified, the primary range of the subnetwork will be used. 324 "ipCidrRange": "A String", # The IP CIDR range represented by this alias IP range. 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 (e.g. 10.2.3.4), a netmask (e.g. /24) or a CIDR format string (e.g. 10.1.2.0/24). 325 }, 326 ], 327 "network": "A String", # URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred. 328 # 329 # This field is optional when creating a firewall rule. If not specified when creating a firewall rule, the default network global/networks/default is used. 330 # 331 # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: 332 # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network 333 # - projects/project/global/networks/network 334 # - global/networks/default 335 "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. 336 { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. 337 "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. 338 "name": "A String", # The name of this access configuration. The default and recommended name is External NAT but you can use any arbitrary string you would like. For example, My external IP or Network Access. 339 "setPublicDns": True or False, # Specifies whether a public DNS ?A? record should be created for the external IP address of this access configuration. 340 "publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance. 341 "networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM , SELECT. If this field is not specified, it is assumed to be PREMIUM. 342 "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. 343 "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. 344 "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT. 345 "publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. This field can only be set when the set_public_ptr field is enabled. 346 }, 347 ], 348 "networkIP": "A String", # An IPv4 internal network 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. 349 "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. 350 "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: 351 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork 352 # - regions/region/subnetworks/subnetwork 353 "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc. 354 }, 355 ], 356 "startRestricted": True or False, # [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity. 357 "zone": "A String", # [Output Only] URL of the zone where the instance resides. 358 "instanceEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts data for an instance with a customer-supplied encryption key. 359 # 360 # If you are creating a new instance, this field encrypts the local SSD and in-memory contents of the instance using a key that you provide. 361 # 362 # If you are restarting an instance protected with a customer-supplied encryption key, you must provide the correct key in order to successfully restart the instance. 363 # 364 # If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key and you do not need to provide a key to start the instance later. 365 # 366 # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt local SSDs and in-memory content in a managed instance group. 367 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 368 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 369 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 370 # 371 # The key must meet the following requirements before you can provide it to Compute Engine: 372 # - The key is wrapped using a RSA public key certificate provided by Google. 373 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at: 374 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 375 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. 376 }, 377 "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status. 378 "metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys. 379 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB. 380 { 381 "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 32768 bytes. 382 "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. 383 }, 384 ], 385 "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata. 386 "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. 387 }, 388 "cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance. 389 "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. 390 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 391 "tags": { # A set of instance tags. # A list of 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. 392 "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. 393 "A String", 394 ], 395 "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. 396 # 397 # To see the latest fingerprint, make get() request to the instance. 398 }, 399 "labelFingerprint": "A String", # 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. 400 # 401 # To see the latest fingerprint, make get() request to the instance. 402 "host": "A String", # Full or partial URL of the host resource that the instance should be placed on, in the format: zones/zone/hosts/host. 403 # 404 # Optional, Private Host (physical machine) that the instance will be placed on when it's created. The instance is guaranteed to be placed on the same machine as other instances with the same private host. 405 # 406 # The request will be rejected if the private host has run out of resources. 407 "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: 408 # 409 # zones/us-central1-f/machineTypes/n1-standard-1 410 # 411 # 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): 412 # 413 # zones/zone/machineTypes/custom-CPUS-MEMORY 414 # 415 # For example: zones/us-central1-f/machineTypes/custom-4-5120 416 # 417 # For a full list of restrictions, read the Specifications for custom machine types. 418 "kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances. 419 "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. 420 "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them. 421 { # An instance-attached disk resource. 422 "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key. 423 # 424 # 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. 425 # 426 # 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. 427 # 428 # 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. 429 # 430 # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group. 431 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 432 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 433 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 434 # 435 # The key must meet the following requirements before you can provide it to Compute Engine: 436 # - The key is wrapped using a RSA public key certificate provided by Google. 437 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at: 438 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 439 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. 440 }, 441 "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. 442 # 443 # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks. 444 "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks. 445 "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. # [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. 446 # 447 # This property is mutually exclusive with the source property; you can only define one or the other, but not both. 448 # 449 # This property is mutually exclusive with the source property; you can only define one or the other, but not both. 450 "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. 451 # 452 # 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. 453 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 454 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 455 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 456 # 457 # The key must meet the following requirements before you can provide it to Compute Engine: 458 # - The key is wrapped using a RSA public key certificate provided by Google. 459 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at: 460 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 461 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. 462 }, 463 "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance. 464 "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: 465 # 466 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard 467 # 468 # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values: 469 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType 470 # - projects/project/zones/zone/diskTypes/diskType 471 # - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL. 472 "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. 473 "sourceImage": "A String", # The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or disks.source is required. 474 # 475 # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image: 476 # 477 # projects/debian-cloud/global/images/family/debian-8 478 # 479 # Alternatively, use a specific version of a public operating system image: 480 # 481 # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD 482 # 483 # To create a disk with a private image that you created, specify the image name in the following format: 484 # 485 # global/images/my-private-image 486 # 487 # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: 488 # 489 # global/images/family/my-private-family 490 # 491 # If the source image is deleted later, this field will not be set. 492 "diskStorageType": "A String", # [Deprecated] Storage type of the disk. 493 }, 494 "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). 495 "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value. 496 "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. 497 "diskSizeGb": "A String", # The size of the disk in base-2 GB. This supersedes disk_size_gb in InitializeParams. 498 "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. 499 "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. 500 "licenses": [ # [Output Only] Any valid publicly visible licenses. 501 "A String", 502 ], 503 "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. 504 "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 disks.source is required. 505 # 506 # If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. 507 # 508 # Note that for InstanceTemplate, specify the disk name, not the URL for the disk. 509 }, 510 ], 511 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 512 }, 513 ], 514 "warning": { # [Output Only] Informational warning which replaces the list of instances when the list is empty. 515 "message": "A String", # [Output Only] A human-readable description of the warning code. 516 "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. 517 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 518 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 519 { 520 "value": "A String", # [Output Only] A warning data value corresponding to the key. 521 "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). 522 }, 523 ], 524 }, 525 }, 526 }, 527 "kind": "compute#instanceAggregatedList", # [Output Only] Type of resource. Always compute#instanceAggregatedList for aggregated lists of Instance resources. 528 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 529 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 530 }</pre> 531 </div> 532 533 <div class="method"> 534 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code> 535 <pre>Retrieves the next page of results. 536 537 Args: 538 previous_request: The request for the previous page. (required) 539 previous_response: The response from the request for the previous page. (required) 540 541 Returns: 542 A request object that you can call 'execute()' on to request the next 543 page. Returns None if there are no more items in the collection. 544 </pre> 545 </div> 546 547 <div class="method"> 548 <code class="details" id="attachDisk">attachDisk(project, zone, instance, body, forceAttach=None, requestId=None)</code> 549 <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. 550 551 Args: 552 project: string, Project ID for this request. (required) 553 zone: string, The name of the zone for this request. (required) 554 instance: string, The instance name for this request. (required) 555 body: object, The request body. (required) 556 The object takes the form of: 557 558 { # An instance-attached disk resource. 559 "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key. 560 # 561 # 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. 562 # 563 # 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. 564 # 565 # 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. 566 # 567 # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group. 568 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 569 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 570 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 571 # 572 # The key must meet the following requirements before you can provide it to Compute Engine: 573 # - The key is wrapped using a RSA public key certificate provided by Google. 574 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at: 575 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 576 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. 577 }, 578 "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. 579 # 580 # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks. 581 "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks. 582 "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. # [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. 583 # 584 # This property is mutually exclusive with the source property; you can only define one or the other, but not both. 585 # 586 # This property is mutually exclusive with the source property; you can only define one or the other, but not both. 587 "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. 588 # 589 # 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. 590 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 591 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 592 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 593 # 594 # The key must meet the following requirements before you can provide it to Compute Engine: 595 # - The key is wrapped using a RSA public key certificate provided by Google. 596 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at: 597 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 598 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. 599 }, 600 "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance. 601 "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: 602 # 603 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard 604 # 605 # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values: 606 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType 607 # - projects/project/zones/zone/diskTypes/diskType 608 # - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL. 609 "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. 610 "sourceImage": "A String", # The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or disks.source is required. 611 # 612 # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image: 613 # 614 # projects/debian-cloud/global/images/family/debian-8 615 # 616 # Alternatively, use a specific version of a public operating system image: 617 # 618 # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD 619 # 620 # To create a disk with a private image that you created, specify the image name in the following format: 621 # 622 # global/images/my-private-image 623 # 624 # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: 625 # 626 # global/images/family/my-private-family 627 # 628 # If the source image is deleted later, this field will not be set. 629 "diskStorageType": "A String", # [Deprecated] Storage type of the disk. 630 }, 631 "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). 632 "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value. 633 "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. 634 "diskSizeGb": "A String", # The size of the disk in base-2 GB. This supersedes disk_size_gb in InitializeParams. 635 "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. 636 "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. 637 "licenses": [ # [Output Only] Any valid publicly visible licenses. 638 "A String", 639 ], 640 "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. 641 "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 disks.source is required. 642 # 643 # If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. 644 # 645 # Note that for InstanceTemplate, specify the disk name, not the URL for the disk. 646 } 647 648 forceAttach: boolean, Whether to force attach the disk even if it's currently attached to another instance. This is only available for regional disks. 649 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 650 651 Returns: 652 An object of the form: 653 654 { # An Operation resource, used to manage asynchronous API requests. 655 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 656 "clientOperationId": "A String", # [Output Only] Reserved for future use. 657 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 658 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 659 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 660 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 661 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 662 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 663 "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. 664 "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. 665 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 666 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 667 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 668 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 669 { 670 "message": "A String", # [Output Only] A human-readable description of the warning code. 671 "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. 672 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 673 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 674 { 675 "value": "A String", # [Output Only] A warning data value corresponding to the key. 676 "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). 677 }, 678 ], 679 }, 680 ], 681 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 682 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 683 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 684 "name": "A String", # [Output Only] Name of the resource. 685 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 686 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 687 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 688 { 689 "message": "A String", # [Output Only] An optional, human-readable error message. 690 "code": "A String", # [Output Only] The error type identifier for this error. 691 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 692 }, 693 ], 694 }, 695 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 696 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 697 "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. 698 }</pre> 699 </div> 700 701 <div class="method"> 702 <code class="details" id="delete">delete(project, zone, instance, requestId=None)</code> 703 <pre>Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance. 704 705 Args: 706 project: string, Project ID for this request. (required) 707 zone: string, The name of the zone for this request. (required) 708 instance: string, Name of the instance resource to delete. (required) 709 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 710 711 Returns: 712 An object of the form: 713 714 { # An Operation resource, used to manage asynchronous API requests. 715 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 716 "clientOperationId": "A String", # [Output Only] Reserved for future use. 717 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 718 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 719 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 720 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 721 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 722 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 723 "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. 724 "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. 725 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 726 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 727 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 728 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 729 { 730 "message": "A String", # [Output Only] A human-readable description of the warning code. 731 "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. 732 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 733 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 734 { 735 "value": "A String", # [Output Only] A warning data value corresponding to the key. 736 "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). 737 }, 738 ], 739 }, 740 ], 741 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 742 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 743 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 744 "name": "A String", # [Output Only] Name of the resource. 745 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 746 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 747 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 748 { 749 "message": "A String", # [Output Only] An optional, human-readable error message. 750 "code": "A String", # [Output Only] The error type identifier for this error. 751 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 752 }, 753 ], 754 }, 755 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 756 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 757 "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. 758 }</pre> 759 </div> 760 761 <div class="method"> 762 <code class="details" id="deleteAccessConfig">deleteAccessConfig(project, zone, instance, accessConfig, networkInterface, requestId=None)</code> 763 <pre>Deletes an access config from an instance's network interface. 764 765 Args: 766 project: string, Project ID for this request. (required) 767 zone: string, The name of the zone for this request. (required) 768 instance: string, The instance name for this request. (required) 769 accessConfig: string, The name of the access config to delete. (required) 770 networkInterface: string, The name of the network interface. (required) 771 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 772 773 Returns: 774 An object of the form: 775 776 { # An Operation resource, used to manage asynchronous API requests. 777 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 778 "clientOperationId": "A String", # [Output Only] Reserved for future use. 779 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 780 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 781 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 782 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 783 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 784 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 785 "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. 786 "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. 787 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 788 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 789 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 790 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 791 { 792 "message": "A String", # [Output Only] A human-readable description of the warning code. 793 "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. 794 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 795 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 796 { 797 "value": "A String", # [Output Only] A warning data value corresponding to the key. 798 "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). 799 }, 800 ], 801 }, 802 ], 803 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 804 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 805 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 806 "name": "A String", # [Output Only] Name of the resource. 807 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 808 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 809 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 810 { 811 "message": "A String", # [Output Only] An optional, human-readable error message. 812 "code": "A String", # [Output Only] The error type identifier for this error. 813 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 814 }, 815 ], 816 }, 817 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 818 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 819 "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. 820 }</pre> 821 </div> 822 823 <div class="method"> 824 <code class="details" id="detachDisk">detachDisk(project, zone, instance, deviceName, requestId=None)</code> 825 <pre>Detaches a disk from an instance. 826 827 Args: 828 project: string, Project ID for this request. (required) 829 zone: string, The name of the zone for this request. (required) 830 instance: string, Instance name. (required) 831 deviceName: string, Disk device name to detach. (required) 832 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 833 834 Returns: 835 An object of the form: 836 837 { # An Operation resource, used to manage asynchronous API requests. 838 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 839 "clientOperationId": "A String", # [Output Only] Reserved for future use. 840 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 841 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 842 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 843 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 844 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 845 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 846 "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. 847 "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. 848 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 849 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 850 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 851 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 852 { 853 "message": "A String", # [Output Only] A human-readable description of the warning code. 854 "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. 855 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 856 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 857 { 858 "value": "A String", # [Output Only] A warning data value corresponding to the key. 859 "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). 860 }, 861 ], 862 }, 863 ], 864 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 865 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 866 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 867 "name": "A String", # [Output Only] Name of the resource. 868 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 869 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 870 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 871 { 872 "message": "A String", # [Output Only] An optional, human-readable error message. 873 "code": "A String", # [Output Only] The error type identifier for this error. 874 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 875 }, 876 ], 877 }, 878 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 879 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 880 "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. 881 }</pre> 882 </div> 883 884 <div class="method"> 885 <code class="details" id="get">get(project, zone, instance)</code> 886 <pre>Returns the specified Instance resource. Get a list of available instances by making a list() request. 887 888 Args: 889 project: string, Project ID for this request. (required) 890 zone: string, The name of the zone for this request. (required) 891 instance: string, Name of the instance resource to return. (required) 892 893 Returns: 894 An object of the form: 895 896 { # An Instance resource. 897 "status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, and TERMINATED. 898 "guestAccelerators": [ # List of the type and count of accelerator cards attached to the instance. 899 { # A specification of the type and number of accelerator cards attached to the instance. 900 "acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance. 901 "acceleratorType": "A String", # Full or partial URL of the accelerator type resource to expose to this instance. 902 }, 903 ], 904 "labels": { # Labels to apply to this instance. These can be later modified by the setLabels method. 905 "a_key": "A String", 906 }, 907 "scheduling": { # Sets the scheduling options for an Instance. # Sets the scheduling options for this instance. 908 "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. 909 # 910 # By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. 911 "preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation, it cannot be set or changed after the instance has been created. 912 "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. 913 }, 914 "minCpuPlatform": "A String", # Minimum cpu/platform to be used by this instance. We may schedule on the specified or later cpu/platform. 915 "serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. 916 # 917 # 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. 918 { # A service account. 919 "scopes": [ # The list of scopes to be made available for this service account. 920 "A String", 921 ], 922 "email": "A String", # Email address of the service account. 923 }, 924 ], 925 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 926 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 927 "networkInterfaces": [ # An array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Only one interface is supported per instance. 928 { # A network interface resource attached to an instance. 929 "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. 930 "aliasIpRanges": [ # An array of alias IP ranges for this network interface. Can only be specified for network interfaces on subnet-mode networks. 931 { # An alias IP range attached to an instance's network interface. 932 "subnetworkRangeName": "A String", # Optional subnetwork secondary range name specifying the secondary range from which to allocate the IP CIDR range for this alias IP range. If left unspecified, the primary range of the subnetwork will be used. 933 "ipCidrRange": "A String", # The IP CIDR range represented by this alias IP range. 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 (e.g. 10.2.3.4), a netmask (e.g. /24) or a CIDR format string (e.g. 10.1.2.0/24). 934 }, 935 ], 936 "network": "A String", # URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred. 937 # 938 # This field is optional when creating a firewall rule. If not specified when creating a firewall rule, the default network global/networks/default is used. 939 # 940 # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: 941 # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network 942 # - projects/project/global/networks/network 943 # - global/networks/default 944 "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. 945 { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. 946 "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. 947 "name": "A String", # The name of this access configuration. The default and recommended name is External NAT but you can use any arbitrary string you would like. For example, My external IP or Network Access. 948 "setPublicDns": True or False, # Specifies whether a public DNS ?A? record should be created for the external IP address of this access configuration. 949 "publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance. 950 "networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM , SELECT. If this field is not specified, it is assumed to be PREMIUM. 951 "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. 952 "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. 953 "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT. 954 "publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. This field can only be set when the set_public_ptr field is enabled. 955 }, 956 ], 957 "networkIP": "A String", # An IPv4 internal network 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. 958 "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. 959 "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: 960 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork 961 # - regions/region/subnetworks/subnetwork 962 "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc. 963 }, 964 ], 965 "startRestricted": True or False, # [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity. 966 "zone": "A String", # [Output Only] URL of the zone where the instance resides. 967 "instanceEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts data for an instance with a customer-supplied encryption key. 968 # 969 # If you are creating a new instance, this field encrypts the local SSD and in-memory contents of the instance using a key that you provide. 970 # 971 # If you are restarting an instance protected with a customer-supplied encryption key, you must provide the correct key in order to successfully restart the instance. 972 # 973 # If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key and you do not need to provide a key to start the instance later. 974 # 975 # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt local SSDs and in-memory content in a managed instance group. 976 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 977 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 978 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 979 # 980 # The key must meet the following requirements before you can provide it to Compute Engine: 981 # - The key is wrapped using a RSA public key certificate provided by Google. 982 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at: 983 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 984 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. 985 }, 986 "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status. 987 "metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys. 988 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB. 989 { 990 "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 32768 bytes. 991 "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. 992 }, 993 ], 994 "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata. 995 "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. 996 }, 997 "cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance. 998 "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. 999 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 1000 "tags": { # A set of instance tags. # A list of 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. 1001 "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. 1002 "A String", 1003 ], 1004 "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. 1005 # 1006 # To see the latest fingerprint, make get() request to the instance. 1007 }, 1008 "labelFingerprint": "A String", # 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. 1009 # 1010 # To see the latest fingerprint, make get() request to the instance. 1011 "host": "A String", # Full or partial URL of the host resource that the instance should be placed on, in the format: zones/zone/hosts/host. 1012 # 1013 # Optional, Private Host (physical machine) that the instance will be placed on when it's created. The instance is guaranteed to be placed on the same machine as other instances with the same private host. 1014 # 1015 # The request will be rejected if the private host has run out of resources. 1016 "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: 1017 # 1018 # zones/us-central1-f/machineTypes/n1-standard-1 1019 # 1020 # 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): 1021 # 1022 # zones/zone/machineTypes/custom-CPUS-MEMORY 1023 # 1024 # For example: zones/us-central1-f/machineTypes/custom-4-5120 1025 # 1026 # For a full list of restrictions, read the Specifications for custom machine types. 1027 "kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances. 1028 "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. 1029 "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them. 1030 { # An instance-attached disk resource. 1031 "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key. 1032 # 1033 # 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. 1034 # 1035 # 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. 1036 # 1037 # 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. 1038 # 1039 # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group. 1040 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 1041 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 1042 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 1043 # 1044 # The key must meet the following requirements before you can provide it to Compute Engine: 1045 # - The key is wrapped using a RSA public key certificate provided by Google. 1046 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at: 1047 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 1048 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. 1049 }, 1050 "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. 1051 # 1052 # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks. 1053 "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks. 1054 "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. # [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. 1055 # 1056 # This property is mutually exclusive with the source property; you can only define one or the other, but not both. 1057 # 1058 # This property is mutually exclusive with the source property; you can only define one or the other, but not both. 1059 "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. 1060 # 1061 # 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. 1062 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 1063 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 1064 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 1065 # 1066 # The key must meet the following requirements before you can provide it to Compute Engine: 1067 # - The key is wrapped using a RSA public key certificate provided by Google. 1068 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at: 1069 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 1070 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. 1071 }, 1072 "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance. 1073 "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: 1074 # 1075 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard 1076 # 1077 # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values: 1078 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType 1079 # - projects/project/zones/zone/diskTypes/diskType 1080 # - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL. 1081 "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. 1082 "sourceImage": "A String", # The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or disks.source is required. 1083 # 1084 # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image: 1085 # 1086 # projects/debian-cloud/global/images/family/debian-8 1087 # 1088 # Alternatively, use a specific version of a public operating system image: 1089 # 1090 # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD 1091 # 1092 # To create a disk with a private image that you created, specify the image name in the following format: 1093 # 1094 # global/images/my-private-image 1095 # 1096 # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: 1097 # 1098 # global/images/family/my-private-family 1099 # 1100 # If the source image is deleted later, this field will not be set. 1101 "diskStorageType": "A String", # [Deprecated] Storage type of the disk. 1102 }, 1103 "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). 1104 "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value. 1105 "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. 1106 "diskSizeGb": "A String", # The size of the disk in base-2 GB. This supersedes disk_size_gb in InitializeParams. 1107 "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. 1108 "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. 1109 "licenses": [ # [Output Only] Any valid publicly visible licenses. 1110 "A String", 1111 ], 1112 "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. 1113 "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 disks.source is required. 1114 # 1115 # If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. 1116 # 1117 # Note that for InstanceTemplate, specify the disk name, not the URL for the disk. 1118 }, 1119 ], 1120 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 1121 }</pre> 1122 </div> 1123 1124 <div class="method"> 1125 <code class="details" id="getIamPolicy">getIamPolicy(project, zone, resource)</code> 1126 <pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists. 1127 1128 Args: 1129 project: string, Project ID for this request. (required) 1130 zone: string, The name of the zone for this request. (required) 1131 resource: string, Name of the resource for this request. (required) 1132 1133 Returns: 1134 An object of the form: 1135 1136 { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. 1137 # 1138 # 1139 # 1140 # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. 1141 # 1142 # **Example** 1143 # 1144 # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike (a] example.com", "group:admins (a] example.com", "domain:google.com", "serviceAccount:my-other-app (a] appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean (a] example.com"] } ] } 1145 # 1146 # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam). 1147 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 1148 { # 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. 1149 # 1150 # 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 AuditConfig are exempted. 1151 # 1152 # Example Policy with multiple AuditConfigs: 1153 # 1154 # { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo (a] gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar (a] gmail.com" ] } ] } ] } 1155 # 1156 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo (a] gmail.com from DATA_READ logging, and bar (a] gmail.com from DATA_WRITE logging. 1157 "exemptedMembers": [ 1158 "A String", 1159 ], 1160 "auditLogConfigs": [ # The configuration for logging of each type of permission. 1161 { # Provides the configuration for logging a type of permissions. Example: 1162 # 1163 # { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo (a] gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } 1164 # 1165 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo (a] gmail.com from DATA_READ logging. 1166 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][]. 1167 "A String", 1168 ], 1169 "logType": "A String", # The log type that this config enables. 1170 }, 1171 ], 1172 "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. 1173 }, 1174 ], 1175 "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied. 1176 { # A rule to be applied in a Policy. 1177 "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. 1178 { # Specifies what kind of log the caller must write 1179 "counter": { # Options for counters # Counter options. 1180 "field": "A String", # The field value to attribute. 1181 "metric": "A String", # The metric to update. 1182 }, 1183 "cloudAudit": { # Write a Cloud Audit log # Cloud audit options. 1184 "logName": "A String", # The log_name to populate in the Cloud Audit Record. 1185 }, 1186 }, 1187 ], 1188 "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. 1189 "A String", 1190 ], 1191 "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. 1192 "A String", 1193 ], 1194 "action": "A String", # Required 1195 "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs. 1196 "A String", 1197 ], 1198 "conditions": [ # Additional restrictions that must be met 1199 { # A condition to be met. 1200 "iam": "A String", # Trusted attributes supplied by the IAM system. 1201 "svc": "A String", # Trusted attributes discharged by the service. 1202 "value": "A String", # DEPRECATED. Use 'values' instead. 1203 "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. 1204 "values": [ # The objects of the condition. This is mutually exclusive with 'value'. 1205 "A String", 1206 ], 1207 "op": "A String", # An operator to apply the subject with. 1208 }, 1209 ], 1210 "description": "A String", # Human-readable description of the rule. 1211 }, 1212 ], 1213 "version": 42, # Version of the `Policy`. The default version is 0. 1214 "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. 1215 # 1216 # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. 1217 "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error. 1218 { # Associates `members` with a `role`. 1219 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 1220 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: 1221 # 1222 # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. 1223 # 1224 # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. 1225 # 1226 # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice (a] gmail.com` or `joe (a] example.com`. 1227 # 1228 # 1229 # 1230 # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app (a] appspot.gserviceaccount.com`. 1231 # 1232 # * `group:{emailid}`: An email address that represents a Google group. For example, `admins (a] example.com`. 1233 # 1234 # 1235 # 1236 # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`. 1237 "A String", 1238 ], 1239 }, 1240 ], 1241 "iamOwned": True or False, 1242 }</pre> 1243 </div> 1244 1245 <div class="method"> 1246 <code class="details" id="getSerialPortOutput">getSerialPortOutput(project, zone, instance, start=None, port=None)</code> 1247 <pre>Returns the specified instance's serial port output. 1248 1249 Args: 1250 project: string, Project ID for this request. (required) 1251 zone: string, The name of the zone for this request. (required) 1252 instance: string, Name of the instance scoping this request. (required) 1253 start: string, Returns output starting from a specific byte position. Use this to page through output when the output is too large to return in a single request. For the initial request, leave this field unspecified. For subsequent calls, this field should be set to the next value returned in the previous call. 1254 port: integer, Specifies which COM or serial port to retrieve data from. 1255 1256 Returns: 1257 An object of the form: 1258 1259 { # An instance's serial console output. 1260 "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, older output will be overwritten by newer content and the start values will be mismatched. 1261 "kind": "compute#serialPortOutput", # [Output Only] Type of the resource. Always compute#serialPortOutput for serial port output. 1262 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 1263 "contents": "A String", # [Output Only] The contents of the console output. 1264 "next": "A String", # [Output Only] The position of the next byte of content from the serial console output. Use this value in the next request as the start parameter. 1265 }</pre> 1266 </div> 1267 1268 <div class="method"> 1269 <code class="details" id="insert">insert(project, zone, body, requestId=None)</code> 1270 <pre>Creates an instance resource in the specified project using the data included in the request. 1271 1272 Args: 1273 project: string, Project ID for this request. (required) 1274 zone: string, The name of the zone for this request. (required) 1275 body: object, The request body. (required) 1276 The object takes the form of: 1277 1278 { # An Instance resource. 1279 "status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, and TERMINATED. 1280 "guestAccelerators": [ # List of the type and count of accelerator cards attached to the instance. 1281 { # A specification of the type and number of accelerator cards attached to the instance. 1282 "acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance. 1283 "acceleratorType": "A String", # Full or partial URL of the accelerator type resource to expose to this instance. 1284 }, 1285 ], 1286 "labels": { # Labels to apply to this instance. These can be later modified by the setLabels method. 1287 "a_key": "A String", 1288 }, 1289 "scheduling": { # Sets the scheduling options for an Instance. # Sets the scheduling options for this instance. 1290 "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. 1291 # 1292 # By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. 1293 "preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation, it cannot be set or changed after the instance has been created. 1294 "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. 1295 }, 1296 "minCpuPlatform": "A String", # Minimum cpu/platform to be used by this instance. We may schedule on the specified or later cpu/platform. 1297 "serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. 1298 # 1299 # 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. 1300 { # A service account. 1301 "scopes": [ # The list of scopes to be made available for this service account. 1302 "A String", 1303 ], 1304 "email": "A String", # Email address of the service account. 1305 }, 1306 ], 1307 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 1308 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 1309 "networkInterfaces": [ # An array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Only one interface is supported per instance. 1310 { # A network interface resource attached to an instance. 1311 "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. 1312 "aliasIpRanges": [ # An array of alias IP ranges for this network interface. Can only be specified for network interfaces on subnet-mode networks. 1313 { # An alias IP range attached to an instance's network interface. 1314 "subnetworkRangeName": "A String", # Optional subnetwork secondary range name specifying the secondary range from which to allocate the IP CIDR range for this alias IP range. If left unspecified, the primary range of the subnetwork will be used. 1315 "ipCidrRange": "A String", # The IP CIDR range represented by this alias IP range. 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 (e.g. 10.2.3.4), a netmask (e.g. /24) or a CIDR format string (e.g. 10.1.2.0/24). 1316 }, 1317 ], 1318 "network": "A String", # URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred. 1319 # 1320 # This field is optional when creating a firewall rule. If not specified when creating a firewall rule, the default network global/networks/default is used. 1321 # 1322 # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: 1323 # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network 1324 # - projects/project/global/networks/network 1325 # - global/networks/default 1326 "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. 1327 { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. 1328 "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. 1329 "name": "A String", # The name of this access configuration. The default and recommended name is External NAT but you can use any arbitrary string you would like. For example, My external IP or Network Access. 1330 "setPublicDns": True or False, # Specifies whether a public DNS ?A? record should be created for the external IP address of this access configuration. 1331 "publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance. 1332 "networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM , SELECT. If this field is not specified, it is assumed to be PREMIUM. 1333 "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. 1334 "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. 1335 "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT. 1336 "publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. This field can only be set when the set_public_ptr field is enabled. 1337 }, 1338 ], 1339 "networkIP": "A String", # An IPv4 internal network 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. 1340 "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. 1341 "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: 1342 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork 1343 # - regions/region/subnetworks/subnetwork 1344 "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc. 1345 }, 1346 ], 1347 "startRestricted": True or False, # [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity. 1348 "zone": "A String", # [Output Only] URL of the zone where the instance resides. 1349 "instanceEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts data for an instance with a customer-supplied encryption key. 1350 # 1351 # If you are creating a new instance, this field encrypts the local SSD and in-memory contents of the instance using a key that you provide. 1352 # 1353 # If you are restarting an instance protected with a customer-supplied encryption key, you must provide the correct key in order to successfully restart the instance. 1354 # 1355 # If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key and you do not need to provide a key to start the instance later. 1356 # 1357 # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt local SSDs and in-memory content in a managed instance group. 1358 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 1359 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 1360 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 1361 # 1362 # The key must meet the following requirements before you can provide it to Compute Engine: 1363 # - The key is wrapped using a RSA public key certificate provided by Google. 1364 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at: 1365 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 1366 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. 1367 }, 1368 "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status. 1369 "metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys. 1370 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB. 1371 { 1372 "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 32768 bytes. 1373 "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. 1374 }, 1375 ], 1376 "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata. 1377 "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. 1378 }, 1379 "cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance. 1380 "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. 1381 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 1382 "tags": { # A set of instance tags. # A list of 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. 1383 "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. 1384 "A String", 1385 ], 1386 "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. 1387 # 1388 # To see the latest fingerprint, make get() request to the instance. 1389 }, 1390 "labelFingerprint": "A String", # 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. 1391 # 1392 # To see the latest fingerprint, make get() request to the instance. 1393 "host": "A String", # Full or partial URL of the host resource that the instance should be placed on, in the format: zones/zone/hosts/host. 1394 # 1395 # Optional, Private Host (physical machine) that the instance will be placed on when it's created. The instance is guaranteed to be placed on the same machine as other instances with the same private host. 1396 # 1397 # The request will be rejected if the private host has run out of resources. 1398 "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: 1399 # 1400 # zones/us-central1-f/machineTypes/n1-standard-1 1401 # 1402 # 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): 1403 # 1404 # zones/zone/machineTypes/custom-CPUS-MEMORY 1405 # 1406 # For example: zones/us-central1-f/machineTypes/custom-4-5120 1407 # 1408 # For a full list of restrictions, read the Specifications for custom machine types. 1409 "kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances. 1410 "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. 1411 "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them. 1412 { # An instance-attached disk resource. 1413 "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key. 1414 # 1415 # 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. 1416 # 1417 # 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. 1418 # 1419 # 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. 1420 # 1421 # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group. 1422 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 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 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 1425 # 1426 # The key must meet the following requirements before you can provide it to Compute Engine: 1427 # - The key is wrapped using a RSA public key certificate provided by Google. 1428 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at: 1429 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 1430 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. 1431 }, 1432 "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. 1433 # 1434 # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks. 1435 "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks. 1436 "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. # [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. 1437 # 1438 # This property is mutually exclusive with the source property; you can only define one or the other, but not both. 1439 # 1440 # This property is mutually exclusive with the source property; you can only define one or the other, but not both. 1441 "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. 1442 # 1443 # 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. 1444 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 1445 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 1446 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 1447 # 1448 # The key must meet the following requirements before you can provide it to Compute Engine: 1449 # - The key is wrapped using a RSA public key certificate provided by Google. 1450 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at: 1451 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 1452 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. 1453 }, 1454 "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance. 1455 "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: 1456 # 1457 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard 1458 # 1459 # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values: 1460 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType 1461 # - projects/project/zones/zone/diskTypes/diskType 1462 # - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL. 1463 "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. 1464 "sourceImage": "A String", # The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or disks.source is required. 1465 # 1466 # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image: 1467 # 1468 # projects/debian-cloud/global/images/family/debian-8 1469 # 1470 # Alternatively, use a specific version of a public operating system image: 1471 # 1472 # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD 1473 # 1474 # To create a disk with a private image that you created, specify the image name in the following format: 1475 # 1476 # global/images/my-private-image 1477 # 1478 # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: 1479 # 1480 # global/images/family/my-private-family 1481 # 1482 # If the source image is deleted later, this field will not be set. 1483 "diskStorageType": "A String", # [Deprecated] Storage type of the disk. 1484 }, 1485 "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). 1486 "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value. 1487 "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. 1488 "diskSizeGb": "A String", # The size of the disk in base-2 GB. This supersedes disk_size_gb in InitializeParams. 1489 "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. 1490 "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. 1491 "licenses": [ # [Output Only] Any valid publicly visible licenses. 1492 "A String", 1493 ], 1494 "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. 1495 "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 disks.source is required. 1496 # 1497 # If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. 1498 # 1499 # Note that for InstanceTemplate, specify the disk name, not the URL for the disk. 1500 }, 1501 ], 1502 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 1503 } 1504 1505 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 1506 1507 Returns: 1508 An object of the form: 1509 1510 { # An Operation resource, used to manage asynchronous API requests. 1511 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1512 "clientOperationId": "A String", # [Output Only] Reserved for future use. 1513 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1514 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 1515 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 1516 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1517 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 1518 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 1519 "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. 1520 "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. 1521 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1522 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 1523 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1524 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1525 { 1526 "message": "A String", # [Output Only] A human-readable description of the warning code. 1527 "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. 1528 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 1529 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1530 { 1531 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1532 "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). 1533 }, 1534 ], 1535 }, 1536 ], 1537 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 1538 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1539 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 1540 "name": "A String", # [Output Only] Name of the resource. 1541 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 1542 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1543 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1544 { 1545 "message": "A String", # [Output Only] An optional, human-readable error message. 1546 "code": "A String", # [Output Only] The error type identifier for this error. 1547 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1548 }, 1549 ], 1550 }, 1551 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1552 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1553 "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. 1554 }</pre> 1555 </div> 1556 1557 <div class="method"> 1558 <code class="details" id="list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 1559 <pre>Retrieves the list of instances contained within the specified zone. 1560 1561 Args: 1562 project: string, Project ID for this request. (required) 1563 zone: string, The name of the zone for this request. (required) 1564 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 1565 1566 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. 1567 1568 Currently, only sorting by name or creationTimestamp desc is supported. 1569 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) 1570 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. 1571 filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. 1572 1573 The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. 1574 1575 For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. 1576 1577 You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. 1578 1579 To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. 1580 1581 Returns: 1582 An object of the form: 1583 1584 { # Contains a list of instances. 1585 "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. 1586 "items": [ # [Output Only] A list of instances. 1587 { # An Instance resource. 1588 "status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, and TERMINATED. 1589 "guestAccelerators": [ # List of the type and count of accelerator cards attached to the instance. 1590 { # A specification of the type and number of accelerator cards attached to the instance. 1591 "acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance. 1592 "acceleratorType": "A String", # Full or partial URL of the accelerator type resource to expose to this instance. 1593 }, 1594 ], 1595 "labels": { # Labels to apply to this instance. These can be later modified by the setLabels method. 1596 "a_key": "A String", 1597 }, 1598 "scheduling": { # Sets the scheduling options for an Instance. # Sets the scheduling options for this instance. 1599 "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. 1600 # 1601 # By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. 1602 "preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation, it cannot be set or changed after the instance has been created. 1603 "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. 1604 }, 1605 "minCpuPlatform": "A String", # Minimum cpu/platform to be used by this instance. We may schedule on the specified or later cpu/platform. 1606 "serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. 1607 # 1608 # 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. 1609 { # A service account. 1610 "scopes": [ # The list of scopes to be made available for this service account. 1611 "A String", 1612 ], 1613 "email": "A String", # Email address of the service account. 1614 }, 1615 ], 1616 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 1617 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 1618 "networkInterfaces": [ # An array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Only one interface is supported per instance. 1619 { # A network interface resource attached to an instance. 1620 "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. 1621 "aliasIpRanges": [ # An array of alias IP ranges for this network interface. Can only be specified for network interfaces on subnet-mode networks. 1622 { # An alias IP range attached to an instance's network interface. 1623 "subnetworkRangeName": "A String", # Optional subnetwork secondary range name specifying the secondary range from which to allocate the IP CIDR range for this alias IP range. If left unspecified, the primary range of the subnetwork will be used. 1624 "ipCidrRange": "A String", # The IP CIDR range represented by this alias IP range. 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 (e.g. 10.2.3.4), a netmask (e.g. /24) or a CIDR format string (e.g. 10.1.2.0/24). 1625 }, 1626 ], 1627 "network": "A String", # URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred. 1628 # 1629 # This field is optional when creating a firewall rule. If not specified when creating a firewall rule, the default network global/networks/default is used. 1630 # 1631 # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: 1632 # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network 1633 # - projects/project/global/networks/network 1634 # - global/networks/default 1635 "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. 1636 { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. 1637 "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. 1638 "name": "A String", # The name of this access configuration. The default and recommended name is External NAT but you can use any arbitrary string you would like. For example, My external IP or Network Access. 1639 "setPublicDns": True or False, # Specifies whether a public DNS ?A? record should be created for the external IP address of this access configuration. 1640 "publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance. 1641 "networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM , SELECT. If this field is not specified, it is assumed to be PREMIUM. 1642 "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. 1643 "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. 1644 "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT. 1645 "publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. This field can only be set when the set_public_ptr field is enabled. 1646 }, 1647 ], 1648 "networkIP": "A String", # An IPv4 internal network 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. 1649 "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. 1650 "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: 1651 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork 1652 # - regions/region/subnetworks/subnetwork 1653 "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc. 1654 }, 1655 ], 1656 "startRestricted": True or False, # [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity. 1657 "zone": "A String", # [Output Only] URL of the zone where the instance resides. 1658 "instanceEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts data for an instance with a customer-supplied encryption key. 1659 # 1660 # If you are creating a new instance, this field encrypts the local SSD and in-memory contents of the instance using a key that you provide. 1661 # 1662 # If you are restarting an instance protected with a customer-supplied encryption key, you must provide the correct key in order to successfully restart the instance. 1663 # 1664 # If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key and you do not need to provide a key to start the instance later. 1665 # 1666 # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt local SSDs and in-memory content in a managed instance group. 1667 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 1668 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 1669 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 1670 # 1671 # The key must meet the following requirements before you can provide it to Compute Engine: 1672 # - The key is wrapped using a RSA public key certificate provided by Google. 1673 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at: 1674 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 1675 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. 1676 }, 1677 "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status. 1678 "metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys. 1679 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB. 1680 { 1681 "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 32768 bytes. 1682 "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. 1683 }, 1684 ], 1685 "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata. 1686 "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. 1687 }, 1688 "cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance. 1689 "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. 1690 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 1691 "tags": { # A set of instance tags. # A list of 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. 1692 "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. 1693 "A String", 1694 ], 1695 "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. 1696 # 1697 # To see the latest fingerprint, make get() request to the instance. 1698 }, 1699 "labelFingerprint": "A String", # 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. 1700 # 1701 # To see the latest fingerprint, make get() request to the instance. 1702 "host": "A String", # Full or partial URL of the host resource that the instance should be placed on, in the format: zones/zone/hosts/host. 1703 # 1704 # Optional, Private Host (physical machine) that the instance will be placed on when it's created. The instance is guaranteed to be placed on the same machine as other instances with the same private host. 1705 # 1706 # The request will be rejected if the private host has run out of resources. 1707 "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: 1708 # 1709 # zones/us-central1-f/machineTypes/n1-standard-1 1710 # 1711 # 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): 1712 # 1713 # zones/zone/machineTypes/custom-CPUS-MEMORY 1714 # 1715 # For example: zones/us-central1-f/machineTypes/custom-4-5120 1716 # 1717 # For a full list of restrictions, read the Specifications for custom machine types. 1718 "kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances. 1719 "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. 1720 "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them. 1721 { # An instance-attached disk resource. 1722 "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key. 1723 # 1724 # 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. 1725 # 1726 # 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. 1727 # 1728 # 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. 1729 # 1730 # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group. 1731 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 1732 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 1733 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 1734 # 1735 # The key must meet the following requirements before you can provide it to Compute Engine: 1736 # - The key is wrapped using a RSA public key certificate provided by Google. 1737 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at: 1738 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 1739 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. 1740 }, 1741 "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. 1742 # 1743 # If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks. 1744 "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks. 1745 "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. # [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. 1746 # 1747 # This property is mutually exclusive with the source property; you can only define one or the other, but not both. 1748 # 1749 # This property is mutually exclusive with the source property; you can only define one or the other, but not both. 1750 "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. 1751 # 1752 # 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. 1753 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 1754 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 1755 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 1756 # 1757 # The key must meet the following requirements before you can provide it to Compute Engine: 1758 # - The key is wrapped using a RSA public key certificate provided by Google. 1759 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at: 1760 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 1761 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. 1762 }, 1763 "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance. 1764 "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: 1765 # 1766 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard 1767 # 1768 # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values: 1769 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType 1770 # - projects/project/zones/zone/diskTypes/diskType 1771 # - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL. 1772 "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. 1773 "sourceImage": "A String", # The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or disks.source is required. 1774 # 1775 # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image: 1776 # 1777 # projects/debian-cloud/global/images/family/debian-8 1778 # 1779 # Alternatively, use a specific version of a public operating system image: 1780 # 1781 # projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD 1782 # 1783 # To create a disk with a private image that you created, specify the image name in the following format: 1784 # 1785 # global/images/my-private-image 1786 # 1787 # You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: 1788 # 1789 # global/images/family/my-private-family 1790 # 1791 # If the source image is deleted later, this field will not be set. 1792 "diskStorageType": "A String", # [Deprecated] Storage type of the disk. 1793 }, 1794 "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). 1795 "index": 42, # Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value. 1796 "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. 1797 "diskSizeGb": "A String", # The size of the disk in base-2 GB. This supersedes disk_size_gb in InitializeParams. 1798 "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. 1799 "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. 1800 "licenses": [ # [Output Only] Any valid publicly visible licenses. 1801 "A String", 1802 ], 1803 "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. 1804 "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 disks.source is required. 1805 # 1806 # If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. 1807 # 1808 # Note that for InstanceTemplate, specify the disk name, not the URL for the disk. 1809 }, 1810 ], 1811 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 1812 }, 1813 ], 1814 "kind": "compute#instanceList", # [Output Only] Type of resource. Always compute#instanceList for lists of Instance resources. 1815 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 1816 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 1817 }</pre> 1818 </div> 1819 1820 <div class="method"> 1821 <code class="details" id="listReferrers">listReferrers(project, zone, instance, orderBy=None, filter=None, maxResults=None, pageToken=None)</code> 1822 <pre>Retrieves the list of referrers to instances contained within the specified zone. 1823 1824 Args: 1825 project: string, Project ID for this request. (required) 1826 zone: string, The name of the zone for this request. (required) 1827 instance: string, Name of the target instance scoping this request, or '-' if the request should span over all instances in the container. (required) 1828 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 1829 1830 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. 1831 1832 Currently, only sorting by name or creationTimestamp desc is supported. 1833 filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. 1834 1835 The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. 1836 1837 For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. 1838 1839 You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. 1840 1841 To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. 1842 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) 1843 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. 1844 1845 Returns: 1846 An object of the form: 1847 1848 { # Contains a list of instance referrers. 1849 "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. 1850 "items": [ # [Output Only] A list of referrers. 1851 { # Represents a reference to a resource. 1852 "referrer": "A String", # URL of the resource which refers to the target. 1853 "kind": "compute#reference", # [Output Only] Type of the resource. Always compute#reference for references. 1854 "referenceType": "A String", # A description of the reference type with no implied semantics. Possible values include: 1855 # - MEMBER_OF 1856 "target": "A String", # URL of the resource to which this reference points. 1857 }, 1858 ], 1859 "kind": "compute#instanceListReferrers", # [Output Only] Type of resource. Always compute#instanceListReferrers for lists of Instance referrers. 1860 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 1861 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 1862 }</pre> 1863 </div> 1864 1865 <div class="method"> 1866 <code class="details" id="listReferrers_next">listReferrers_next(previous_request, previous_response)</code> 1867 <pre>Retrieves the next page of results. 1868 1869 Args: 1870 previous_request: The request for the previous page. (required) 1871 previous_response: The response from the request for the previous page. (required) 1872 1873 Returns: 1874 A request object that you can call 'execute()' on to request the next 1875 page. Returns None if there are no more items in the collection. 1876 </pre> 1877 </div> 1878 1879 <div class="method"> 1880 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 1881 <pre>Retrieves the next page of results. 1882 1883 Args: 1884 previous_request: The request for the previous page. (required) 1885 previous_response: The response from the request for the previous page. (required) 1886 1887 Returns: 1888 A request object that you can call 'execute()' on to request the next 1889 page. Returns None if there are no more items in the collection. 1890 </pre> 1891 </div> 1892 1893 <div class="method"> 1894 <code class="details" id="reset">reset(project, zone, instance, requestId=None)</code> 1895 <pre>Performs a reset on the instance. For more information, see Resetting an instance. 1896 1897 Args: 1898 project: string, Project ID for this request. (required) 1899 zone: string, The name of the zone for this request. (required) 1900 instance: string, Name of the instance scoping this request. (required) 1901 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 1902 1903 Returns: 1904 An object of the form: 1905 1906 { # An Operation resource, used to manage asynchronous API requests. 1907 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1908 "clientOperationId": "A String", # [Output Only] Reserved for future use. 1909 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1910 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 1911 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 1912 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1913 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 1914 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 1915 "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. 1916 "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. 1917 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1918 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 1919 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1920 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1921 { 1922 "message": "A String", # [Output Only] A human-readable description of the warning code. 1923 "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. 1924 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 1925 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1926 { 1927 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1928 "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). 1929 }, 1930 ], 1931 }, 1932 ], 1933 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 1934 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1935 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 1936 "name": "A String", # [Output Only] Name of the resource. 1937 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 1938 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1939 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1940 { 1941 "message": "A String", # [Output Only] An optional, human-readable error message. 1942 "code": "A String", # [Output Only] The error type identifier for this error. 1943 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1944 }, 1945 ], 1946 }, 1947 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1948 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1949 "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. 1950 }</pre> 1951 </div> 1952 1953 <div class="method"> 1954 <code class="details" id="setDiskAutoDelete">setDiskAutoDelete(project, zone, instance, autoDelete, deviceName, requestId=None)</code> 1955 <pre>Sets the auto-delete flag for a disk attached to an instance. 1956 1957 Args: 1958 project: string, Project ID for this request. (required) 1959 zone: string, The name of the zone for this request. (required) 1960 instance: string, The instance name. (required) 1961 autoDelete: boolean, Whether to auto-delete the disk when the instance is deleted. (required) 1962 deviceName: string, The device name of the disk to modify. (required) 1963 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 1964 1965 Returns: 1966 An object of the form: 1967 1968 { # An Operation resource, used to manage asynchronous API requests. 1969 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1970 "clientOperationId": "A String", # [Output Only] Reserved for future use. 1971 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1972 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 1973 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 1974 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1975 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 1976 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 1977 "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. 1978 "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. 1979 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1980 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 1981 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1982 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1983 { 1984 "message": "A String", # [Output Only] A human-readable description of the warning code. 1985 "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. 1986 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 1987 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1988 { 1989 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1990 "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). 1991 }, 1992 ], 1993 }, 1994 ], 1995 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 1996 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1997 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 1998 "name": "A String", # [Output Only] Name of the resource. 1999 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 2000 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 2001 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 2002 { 2003 "message": "A String", # [Output Only] An optional, human-readable error message. 2004 "code": "A String", # [Output Only] The error type identifier for this error. 2005 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 2006 }, 2007 ], 2008 }, 2009 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 2010 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 2011 "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. 2012 }</pre> 2013 </div> 2014 2015 <div class="method"> 2016 <code class="details" id="setIamPolicy">setIamPolicy(project, zone, resource, body)</code> 2017 <pre>Sets the access control policy on the specified resource. Replaces any existing policy. 2018 2019 Args: 2020 project: string, Project ID for this request. (required) 2021 zone: string, The name of the zone for this request. (required) 2022 resource: string, Name of the resource for this request. (required) 2023 body: object, The request body. (required) 2024 The object takes the form of: 2025 2026 { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. 2027 # 2028 # 2029 # 2030 # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. 2031 # 2032 # **Example** 2033 # 2034 # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike (a] example.com", "group:admins (a] example.com", "domain:google.com", "serviceAccount:my-other-app (a] appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean (a] example.com"] } ] } 2035 # 2036 # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam). 2037 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 2038 { # 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. 2039 # 2040 # 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 AuditConfig are exempted. 2041 # 2042 # Example Policy with multiple AuditConfigs: 2043 # 2044 # { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo (a] gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar (a] gmail.com" ] } ] } ] } 2045 # 2046 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo (a] gmail.com from DATA_READ logging, and bar (a] gmail.com from DATA_WRITE logging. 2047 "exemptedMembers": [ 2048 "A String", 2049 ], 2050 "auditLogConfigs": [ # The configuration for logging of each type of permission. 2051 { # Provides the configuration for logging a type of permissions. Example: 2052 # 2053 # { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo (a] gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } 2054 # 2055 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo (a] gmail.com from DATA_READ logging. 2056 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][]. 2057 "A String", 2058 ], 2059 "logType": "A String", # The log type that this config enables. 2060 }, 2061 ], 2062 "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. 2063 }, 2064 ], 2065 "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied. 2066 { # A rule to be applied in a Policy. 2067 "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. 2068 { # Specifies what kind of log the caller must write 2069 "counter": { # Options for counters # Counter options. 2070 "field": "A String", # The field value to attribute. 2071 "metric": "A String", # The metric to update. 2072 }, 2073 "cloudAudit": { # Write a Cloud Audit log # Cloud audit options. 2074 "logName": "A String", # The log_name to populate in the Cloud Audit Record. 2075 }, 2076 }, 2077 ], 2078 "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. 2079 "A String", 2080 ], 2081 "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. 2082 "A String", 2083 ], 2084 "action": "A String", # Required 2085 "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs. 2086 "A String", 2087 ], 2088 "conditions": [ # Additional restrictions that must be met 2089 { # A condition to be met. 2090 "iam": "A String", # Trusted attributes supplied by the IAM system. 2091 "svc": "A String", # Trusted attributes discharged by the service. 2092 "value": "A String", # DEPRECATED. Use 'values' instead. 2093 "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. 2094 "values": [ # The objects of the condition. This is mutually exclusive with 'value'. 2095 "A String", 2096 ], 2097 "op": "A String", # An operator to apply the subject with. 2098 }, 2099 ], 2100 "description": "A String", # Human-readable description of the rule. 2101 }, 2102 ], 2103 "version": 42, # Version of the `Policy`. The default version is 0. 2104 "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. 2105 # 2106 # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. 2107 "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error. 2108 { # Associates `members` with a `role`. 2109 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 2110 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: 2111 # 2112 # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. 2113 # 2114 # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. 2115 # 2116 # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice (a] gmail.com` or `joe (a] example.com`. 2117 # 2118 # 2119 # 2120 # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app (a] appspot.gserviceaccount.com`. 2121 # 2122 # * `group:{emailid}`: An email address that represents a Google group. For example, `admins (a] example.com`. 2123 # 2124 # 2125 # 2126 # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`. 2127 "A String", 2128 ], 2129 }, 2130 ], 2131 "iamOwned": True or False, 2132 } 2133 2134 2135 Returns: 2136 An object of the form: 2137 2138 { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. 2139 # 2140 # 2141 # 2142 # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. 2143 # 2144 # **Example** 2145 # 2146 # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike (a] example.com", "group:admins (a] example.com", "domain:google.com", "serviceAccount:my-other-app (a] appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean (a] example.com"] } ] } 2147 # 2148 # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam). 2149 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 2150 { # 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. 2151 # 2152 # 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 AuditConfig are exempted. 2153 # 2154 # Example Policy with multiple AuditConfigs: 2155 # 2156 # { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo (a] gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar (a] gmail.com" ] } ] } ] } 2157 # 2158 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo (a] gmail.com from DATA_READ logging, and bar (a] gmail.com from DATA_WRITE logging. 2159 "exemptedMembers": [ 2160 "A String", 2161 ], 2162 "auditLogConfigs": [ # The configuration for logging of each type of permission. 2163 { # Provides the configuration for logging a type of permissions. Example: 2164 # 2165 # { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo (a] gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } 2166 # 2167 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo (a] gmail.com from DATA_READ logging. 2168 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][]. 2169 "A String", 2170 ], 2171 "logType": "A String", # The log type that this config enables. 2172 }, 2173 ], 2174 "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. 2175 }, 2176 ], 2177 "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied. 2178 { # A rule to be applied in a Policy. 2179 "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. 2180 { # Specifies what kind of log the caller must write 2181 "counter": { # Options for counters # Counter options. 2182 "field": "A String", # The field value to attribute. 2183 "metric": "A String", # The metric to update. 2184 }, 2185 "cloudAudit": { # Write a Cloud Audit log # Cloud audit options. 2186 "logName": "A String", # The log_name to populate in the Cloud Audit Record. 2187 }, 2188 }, 2189 ], 2190 "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. 2191 "A String", 2192 ], 2193 "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. 2194 "A String", 2195 ], 2196 "action": "A String", # Required 2197 "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs. 2198 "A String", 2199 ], 2200 "conditions": [ # Additional restrictions that must be met 2201 { # A condition to be met. 2202 "iam": "A String", # Trusted attributes supplied by the IAM system. 2203 "svc": "A String", # Trusted attributes discharged by the service. 2204 "value": "A String", # DEPRECATED. Use 'values' instead. 2205 "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. 2206 "values": [ # The objects of the condition. This is mutually exclusive with 'value'. 2207 "A String", 2208 ], 2209 "op": "A String", # An operator to apply the subject with. 2210 }, 2211 ], 2212 "description": "A String", # Human-readable description of the rule. 2213 }, 2214 ], 2215 "version": 42, # Version of the `Policy`. The default version is 0. 2216 "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. 2217 # 2218 # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. 2219 "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error. 2220 { # Associates `members` with a `role`. 2221 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 2222 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: 2223 # 2224 # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. 2225 # 2226 # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. 2227 # 2228 # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice (a] gmail.com` or `joe (a] example.com`. 2229 # 2230 # 2231 # 2232 # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app (a] appspot.gserviceaccount.com`. 2233 # 2234 # * `group:{emailid}`: An email address that represents a Google group. For example, `admins (a] example.com`. 2235 # 2236 # 2237 # 2238 # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`. 2239 "A String", 2240 ], 2241 }, 2242 ], 2243 "iamOwned": True or False, 2244 }</pre> 2245 </div> 2246 2247 <div class="method"> 2248 <code class="details" id="setLabels">setLabels(project, zone, instance, body, requestId=None)</code> 2249 <pre>Sets labels on an instance. To learn more about labels, read the Labeling or Tagging Resources documentation. 2250 2251 Args: 2252 project: string, Project ID for this request. (required) 2253 zone: string, The name of the zone for this request. (required) 2254 instance: string, Name of the instance scoping this request. (required) 2255 body: object, The request body. (required) 2256 The object takes the form of: 2257 2258 { 2259 "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. 2260 "labels": { 2261 "a_key": "A String", 2262 }, 2263 } 2264 2265 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 2266 2267 Returns: 2268 An object of the form: 2269 2270 { # An Operation resource, used to manage asynchronous API requests. 2271 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 2272 "clientOperationId": "A String", # [Output Only] Reserved for future use. 2273 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 2274 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 2275 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 2276 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 2277 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 2278 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 2279 "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. 2280 "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. 2281 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 2282 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 2283 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 2284 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 2285 { 2286 "message": "A String", # [Output Only] A human-readable description of the warning code. 2287 "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. 2288 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 2289 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 2290 { 2291 "value": "A String", # [Output Only] A warning data value corresponding to the key. 2292 "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). 2293 }, 2294 ], 2295 }, 2296 ], 2297 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 2298 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 2299 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 2300 "name": "A String", # [Output Only] Name of the resource. 2301 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 2302 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 2303 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 2304 { 2305 "message": "A String", # [Output Only] An optional, human-readable error message. 2306 "code": "A String", # [Output Only] The error type identifier for this error. 2307 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 2308 }, 2309 ], 2310 }, 2311 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 2312 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 2313 "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. 2314 }</pre> 2315 </div> 2316 2317 <div class="method"> 2318 <code class="details" id="setMachineResources">setMachineResources(project, zone, instance, body, requestId=None)</code> 2319 <pre>Changes the number and/or type of accelerator for a stopped instance to the values specified in the request. 2320 2321 Args: 2322 project: string, Project ID for this request. (required) 2323 zone: string, The name of the zone for this request. (required) 2324 instance: string, Name of the instance scoping this request. (required) 2325 body: object, The request body. (required) 2326 The object takes the form of: 2327 2328 { 2329 "guestAccelerators": [ # List of the type and count of accelerator cards attached to the instance. 2330 { # A specification of the type and number of accelerator cards attached to the instance. 2331 "acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance. 2332 "acceleratorType": "A String", # Full or partial URL of the accelerator type resource to expose to this instance. 2333 }, 2334 ], 2335 } 2336 2337 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 2338 2339 Returns: 2340 An object of the form: 2341 2342 { # An Operation resource, used to manage asynchronous API requests. 2343 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 2344 "clientOperationId": "A String", # [Output Only] Reserved for future use. 2345 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 2346 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 2347 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 2348 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 2349 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 2350 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 2351 "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. 2352 "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. 2353 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 2354 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 2355 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 2356 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 2357 { 2358 "message": "A String", # [Output Only] A human-readable description of the warning code. 2359 "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. 2360 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 2361 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 2362 { 2363 "value": "A String", # [Output Only] A warning data value corresponding to the key. 2364 "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). 2365 }, 2366 ], 2367 }, 2368 ], 2369 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 2370 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 2371 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 2372 "name": "A String", # [Output Only] Name of the resource. 2373 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 2374 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 2375 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 2376 { 2377 "message": "A String", # [Output Only] An optional, human-readable error message. 2378 "code": "A String", # [Output Only] The error type identifier for this error. 2379 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 2380 }, 2381 ], 2382 }, 2383 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 2384 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 2385 "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. 2386 }</pre> 2387 </div> 2388 2389 <div class="method"> 2390 <code class="details" id="setMachineType">setMachineType(project, zone, instance, body, requestId=None)</code> 2391 <pre>Changes the machine type for a stopped instance to the machine type specified in the request. 2392 2393 Args: 2394 project: string, Project ID for this request. (required) 2395 zone: string, The name of the zone for this request. (required) 2396 instance: string, Name of the instance scoping this request. (required) 2397 body: object, The request body. (required) 2398 The object takes the form of: 2399 2400 { 2401 "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 2402 } 2403 2404 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 2405 2406 Returns: 2407 An object of the form: 2408 2409 { # An Operation resource, used to manage asynchronous API requests. 2410 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 2411 "clientOperationId": "A String", # [Output Only] Reserved for future use. 2412 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 2413 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 2414 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 2415 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 2416 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 2417 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 2418 "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. 2419 "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. 2420 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 2421 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 2422 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 2423 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 2424 { 2425 "message": "A String", # [Output Only] A human-readable description of the warning code. 2426 "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. 2427 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 2428 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 2429 { 2430 "value": "A String", # [Output Only] A warning data value corresponding to the key. 2431 "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). 2432 }, 2433 ], 2434 }, 2435 ], 2436 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 2437 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 2438 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 2439 "name": "A String", # [Output Only] Name of the resource. 2440 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 2441 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 2442 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 2443 { 2444 "message": "A String", # [Output Only] An optional, human-readable error message. 2445 "code": "A String", # [Output Only] The error type identifier for this error. 2446 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 2447 }, 2448 ], 2449 }, 2450 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 2451 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 2452 "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. 2453 }</pre> 2454 </div> 2455 2456 <div class="method"> 2457 <code class="details" id="setMetadata">setMetadata(project, zone, instance, body, requestId=None)</code> 2458 <pre>Sets metadata for the specified instance to the data included in the request. 2459 2460 Args: 2461 project: string, Project ID for this request. (required) 2462 zone: string, The name of the zone for this request. (required) 2463 instance: string, Name of the instance scoping this request. (required) 2464 body: object, The request body. (required) 2465 The object takes the form of: 2466 2467 { # A metadata key/value entry. 2468 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB. 2469 { 2470 "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 32768 bytes. 2471 "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. 2472 }, 2473 ], 2474 "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata. 2475 "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. 2476 } 2477 2478 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 2479 2480 Returns: 2481 An object of the form: 2482 2483 { # An Operation resource, used to manage asynchronous API requests. 2484 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 2485 "clientOperationId": "A String", # [Output Only] Reserved for future use. 2486 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 2487 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 2488 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 2489 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 2490 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 2491 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 2492 "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. 2493 "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. 2494 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 2495 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 2496 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 2497 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 2498 { 2499 "message": "A String", # [Output Only] A human-readable description of the warning code. 2500 "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. 2501 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 2502 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 2503 { 2504 "value": "A String", # [Output Only] A warning data value corresponding to the key. 2505 "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). 2506 }, 2507 ], 2508 }, 2509 ], 2510 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 2511 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 2512 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 2513 "name": "A String", # [Output Only] Name of the resource. 2514 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 2515 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 2516 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 2517 { 2518 "message": "A String", # [Output Only] An optional, human-readable error message. 2519 "code": "A String", # [Output Only] The error type identifier for this error. 2520 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 2521 }, 2522 ], 2523 }, 2524 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 2525 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 2526 "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. 2527 }</pre> 2528 </div> 2529 2530 <div class="method"> 2531 <code class="details" id="setMinCpuPlatform">setMinCpuPlatform(project, zone, instance, body, requestId=None)</code> 2532 <pre>Changes the minimum cpu/platform that this instance should be started as. This is called on a stopped instance. 2533 2534 Args: 2535 project: string, Project ID for this request. (required) 2536 zone: string, The name of the zone for this request. (required) 2537 instance: string, Name of the instance scoping this request. (required) 2538 body: object, The request body. (required) 2539 The object takes the form of: 2540 2541 { 2542 "minCpuPlatform": "A String", # Minimum cpu/platform this instance should be started at. 2543 } 2544 2545 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 2546 2547 Returns: 2548 An object of the form: 2549 2550 { # An Operation resource, used to manage asynchronous API requests. 2551 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 2552 "clientOperationId": "A String", # [Output Only] Reserved for future use. 2553 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 2554 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 2555 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 2556 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 2557 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 2558 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 2559 "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. 2560 "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. 2561 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 2562 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 2563 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 2564 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 2565 { 2566 "message": "A String", # [Output Only] A human-readable description of the warning code. 2567 "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. 2568 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 2569 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 2570 { 2571 "value": "A String", # [Output Only] A warning data value corresponding to the key. 2572 "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). 2573 }, 2574 ], 2575 }, 2576 ], 2577 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 2578 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 2579 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 2580 "name": "A String", # [Output Only] Name of the resource. 2581 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 2582 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 2583 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 2584 { 2585 "message": "A String", # [Output Only] An optional, human-readable error message. 2586 "code": "A String", # [Output Only] The error type identifier for this error. 2587 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 2588 }, 2589 ], 2590 }, 2591 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 2592 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 2593 "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. 2594 }</pre> 2595 </div> 2596 2597 <div class="method"> 2598 <code class="details" id="setScheduling">setScheduling(project, zone, instance, body, requestId=None)</code> 2599 <pre>Sets an instance's scheduling options. 2600 2601 Args: 2602 project: string, Project ID for this request. (required) 2603 zone: string, The name of the zone for this request. (required) 2604 instance: string, Instance name. (required) 2605 body: object, The request body. (required) 2606 The object takes the form of: 2607 2608 { # Sets the scheduling options for an Instance. 2609 "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. 2610 # 2611 # By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. 2612 "preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation, it cannot be set or changed after the instance has been created. 2613 "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. 2614 } 2615 2616 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 2617 2618 Returns: 2619 An object of the form: 2620 2621 { # An Operation resource, used to manage asynchronous API requests. 2622 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 2623 "clientOperationId": "A String", # [Output Only] Reserved for future use. 2624 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 2625 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 2626 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 2627 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 2628 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 2629 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 2630 "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. 2631 "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. 2632 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 2633 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 2634 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 2635 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 2636 { 2637 "message": "A String", # [Output Only] A human-readable description of the warning code. 2638 "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. 2639 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 2640 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 2641 { 2642 "value": "A String", # [Output Only] A warning data value corresponding to the key. 2643 "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). 2644 }, 2645 ], 2646 }, 2647 ], 2648 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 2649 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 2650 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 2651 "name": "A String", # [Output Only] Name of the resource. 2652 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 2653 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 2654 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 2655 { 2656 "message": "A String", # [Output Only] An optional, human-readable error message. 2657 "code": "A String", # [Output Only] The error type identifier for this error. 2658 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 2659 }, 2660 ], 2661 }, 2662 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 2663 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 2664 "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. 2665 }</pre> 2666 </div> 2667 2668 <div class="method"> 2669 <code class="details" id="setServiceAccount">setServiceAccount(project, zone, instance, body, requestId=None)</code> 2670 <pre>Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance. 2671 2672 Args: 2673 project: string, Project ID for this request. (required) 2674 zone: string, The name of the zone for this request. (required) 2675 instance: string, Name of the instance resource to start. (required) 2676 body: object, The request body. (required) 2677 The object takes the form of: 2678 2679 { 2680 "scopes": [ # The list of scopes to be made available for this service account. 2681 "A String", 2682 ], 2683 "email": "A String", # Email address of the service account. 2684 } 2685 2686 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 2687 2688 Returns: 2689 An object of the form: 2690 2691 { # An Operation resource, used to manage asynchronous API requests. 2692 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 2693 "clientOperationId": "A String", # [Output Only] Reserved for future use. 2694 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 2695 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 2696 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 2697 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 2698 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 2699 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 2700 "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. 2701 "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. 2702 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 2703 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 2704 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 2705 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 2706 { 2707 "message": "A String", # [Output Only] A human-readable description of the warning code. 2708 "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. 2709 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 2710 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 2711 { 2712 "value": "A String", # [Output Only] A warning data value corresponding to the key. 2713 "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). 2714 }, 2715 ], 2716 }, 2717 ], 2718 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 2719 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 2720 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 2721 "name": "A String", # [Output Only] Name of the resource. 2722 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 2723 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 2724 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 2725 { 2726 "message": "A String", # [Output Only] An optional, human-readable error message. 2727 "code": "A String", # [Output Only] The error type identifier for this error. 2728 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 2729 }, 2730 ], 2731 }, 2732 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 2733 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 2734 "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. 2735 }</pre> 2736 </div> 2737 2738 <div class="method"> 2739 <code class="details" id="setTags">setTags(project, zone, instance, body, requestId=None)</code> 2740 <pre>Sets tags for the specified instance to the data included in the request. 2741 2742 Args: 2743 project: string, Project ID for this request. (required) 2744 zone: string, The name of the zone for this request. (required) 2745 instance: string, Name of the instance scoping this request. (required) 2746 body: object, The request body. (required) 2747 The object takes the form of: 2748 2749 { # A set of instance tags. 2750 "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. 2751 "A String", 2752 ], 2753 "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. 2754 # 2755 # To see the latest fingerprint, make get() request to the instance. 2756 } 2757 2758 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 2759 2760 Returns: 2761 An object of the form: 2762 2763 { # An Operation resource, used to manage asynchronous API requests. 2764 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 2765 "clientOperationId": "A String", # [Output Only] Reserved for future use. 2766 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 2767 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 2768 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 2769 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 2770 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 2771 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 2772 "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. 2773 "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. 2774 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 2775 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 2776 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 2777 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 2778 { 2779 "message": "A String", # [Output Only] A human-readable description of the warning code. 2780 "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. 2781 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 2782 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 2783 { 2784 "value": "A String", # [Output Only] A warning data value corresponding to the key. 2785 "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). 2786 }, 2787 ], 2788 }, 2789 ], 2790 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 2791 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 2792 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 2793 "name": "A String", # [Output Only] Name of the resource. 2794 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 2795 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 2796 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 2797 { 2798 "message": "A String", # [Output Only] An optional, human-readable error message. 2799 "code": "A String", # [Output Only] The error type identifier for this error. 2800 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 2801 }, 2802 ], 2803 }, 2804 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 2805 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 2806 "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. 2807 }</pre> 2808 </div> 2809 2810 <div class="method"> 2811 <code class="details" id="simulateMaintenanceEvent">simulateMaintenanceEvent(project, zone, instance)</code> 2812 <pre>Simulates a maintenance event on the instance. 2813 2814 Args: 2815 project: string, Project ID for this request. (required) 2816 zone: string, The name of the zone for this request. (required) 2817 instance: string, Name of the instance scoping this request. (required) 2818 2819 Returns: 2820 An object of the form: 2821 2822 { # An Operation resource, used to manage asynchronous API requests. 2823 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 2824 "clientOperationId": "A String", # [Output Only] Reserved for future use. 2825 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 2826 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 2827 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 2828 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 2829 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 2830 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 2831 "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. 2832 "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. 2833 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 2834 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 2835 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 2836 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 2837 { 2838 "message": "A String", # [Output Only] A human-readable description of the warning code. 2839 "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. 2840 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 2841 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 2842 { 2843 "value": "A String", # [Output Only] A warning data value corresponding to the key. 2844 "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). 2845 }, 2846 ], 2847 }, 2848 ], 2849 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 2850 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 2851 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 2852 "name": "A String", # [Output Only] Name of the resource. 2853 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 2854 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 2855 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 2856 { 2857 "message": "A String", # [Output Only] An optional, human-readable error message. 2858 "code": "A String", # [Output Only] The error type identifier for this error. 2859 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 2860 }, 2861 ], 2862 }, 2863 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 2864 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 2865 "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. 2866 }</pre> 2867 </div> 2868 2869 <div class="method"> 2870 <code class="details" id="start">start(project, zone, instance, requestId=None)</code> 2871 <pre>Starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance. 2872 2873 Args: 2874 project: string, Project ID for this request. (required) 2875 zone: string, The name of the zone for this request. (required) 2876 instance: string, Name of the instance resource to start. (required) 2877 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 2878 2879 Returns: 2880 An object of the form: 2881 2882 { # An Operation resource, used to manage asynchronous API requests. 2883 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 2884 "clientOperationId": "A String", # [Output Only] Reserved for future use. 2885 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 2886 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 2887 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 2888 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 2889 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 2890 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 2891 "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. 2892 "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. 2893 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 2894 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 2895 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 2896 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 2897 { 2898 "message": "A String", # [Output Only] A human-readable description of the warning code. 2899 "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. 2900 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 2901 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 2902 { 2903 "value": "A String", # [Output Only] A warning data value corresponding to the key. 2904 "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). 2905 }, 2906 ], 2907 }, 2908 ], 2909 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 2910 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 2911 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 2912 "name": "A String", # [Output Only] Name of the resource. 2913 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 2914 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 2915 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 2916 { 2917 "message": "A String", # [Output Only] An optional, human-readable error message. 2918 "code": "A String", # [Output Only] The error type identifier for this error. 2919 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 2920 }, 2921 ], 2922 }, 2923 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 2924 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 2925 "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. 2926 }</pre> 2927 </div> 2928 2929 <div class="method"> 2930 <code class="details" id="startWithEncryptionKey">startWithEncryptionKey(project, zone, instance, body, requestId=None)</code> 2931 <pre>Starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance. 2932 2933 Args: 2934 project: string, Project ID for this request. (required) 2935 zone: string, The name of the zone for this request. (required) 2936 instance: string, Name of the instance resource to start. (required) 2937 body: object, The request body. (required) 2938 The object takes the form of: 2939 2940 { 2941 "instanceEncryptionKey": { # Represents a customer-supplied encryption key # Decrypts data associated with an instance that is protected with a customer-supplied encryption key. 2942 # 2943 # If the instance you are starting is protected with a customer-supplied encryption key, the correct key must be provided otherwise the instance start will not succeed. 2944 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 2945 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 2946 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 2947 # 2948 # The key must meet the following requirements before you can provide it to Compute Engine: 2949 # - The key is wrapped using a RSA public key certificate provided by Google. 2950 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at: 2951 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 2952 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. 2953 }, 2954 "disks": [ # Array of disks associated with this instance that are protected with a customer-supplied encryption key. 2955 # 2956 # In order to start the instance, the disk url and its corresponding key must be provided. 2957 # 2958 # If the disk is not protected with a customer-supplied encryption key it should not be specified. 2959 { 2960 "diskEncryptionKey": { # Represents a customer-supplied encryption key # Decrypts data associated with the disk with a customer-supplied encryption key. 2961 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. 2962 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. 2963 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. 2964 # 2965 # The key must meet the following requirements before you can provide it to Compute Engine: 2966 # - The key is wrapped using a RSA public key certificate provided by Google. 2967 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at: 2968 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem 2969 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. 2970 }, 2971 "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. 2972 }, 2973 ], 2974 } 2975 2976 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 2977 2978 Returns: 2979 An object of the form: 2980 2981 { # An Operation resource, used to manage asynchronous API requests. 2982 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 2983 "clientOperationId": "A String", # [Output Only] Reserved for future use. 2984 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 2985 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 2986 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 2987 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 2988 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 2989 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 2990 "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. 2991 "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. 2992 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 2993 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 2994 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 2995 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 2996 { 2997 "message": "A String", # [Output Only] A human-readable description of the warning code. 2998 "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. 2999 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 3000 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 3001 { 3002 "value": "A String", # [Output Only] A warning data value corresponding to the key. 3003 "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). 3004 }, 3005 ], 3006 }, 3007 ], 3008 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 3009 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 3010 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 3011 "name": "A String", # [Output Only] Name of the resource. 3012 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 3013 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 3014 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 3015 { 3016 "message": "A String", # [Output Only] An optional, human-readable error message. 3017 "code": "A String", # [Output Only] The error type identifier for this error. 3018 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 3019 }, 3020 ], 3021 }, 3022 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 3023 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 3024 "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. 3025 }</pre> 3026 </div> 3027 3028 <div class="method"> 3029 <code class="details" id="stop">stop(project, zone, instance, discardLocalSsd=None, requestId=None)</code> 3030 <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 per-minute, virtual machine usage charges while they are stopped, but any resources that the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance. 3031 3032 Args: 3033 project: string, Project ID for this request. (required) 3034 zone: string, The name of the zone for this request. (required) 3035 instance: string, Name of the instance resource to stop. (required) 3036 discardLocalSsd: boolean, If true, discard the contents of any attached localSSD partitions. Default value is false (== preserve localSSD data). 3037 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 3038 3039 Returns: 3040 An object of the form: 3041 3042 { # An Operation resource, used to manage asynchronous API requests. 3043 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 3044 "clientOperationId": "A String", # [Output Only] Reserved for future use. 3045 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 3046 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 3047 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 3048 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 3049 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 3050 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 3051 "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. 3052 "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. 3053 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 3054 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 3055 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 3056 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 3057 { 3058 "message": "A String", # [Output Only] A human-readable description of the warning code. 3059 "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. 3060 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 3061 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 3062 { 3063 "value": "A String", # [Output Only] A warning data value corresponding to the key. 3064 "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). 3065 }, 3066 ], 3067 }, 3068 ], 3069 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 3070 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 3071 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 3072 "name": "A String", # [Output Only] Name of the resource. 3073 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 3074 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 3075 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 3076 { 3077 "message": "A String", # [Output Only] An optional, human-readable error message. 3078 "code": "A String", # [Output Only] The error type identifier for this error. 3079 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 3080 }, 3081 ], 3082 }, 3083 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 3084 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 3085 "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. 3086 }</pre> 3087 </div> 3088 3089 <div class="method"> 3090 <code class="details" id="suspend">suspend(project, zone, instance, discardLocalSsd=None, requestId=None)</code> 3091 <pre>This method suspends a running instance, saving its state to persistent storage, and allows you to resume the instance at a later time. Suspended instances incur reduced per-minute, virtual machine usage charges while they are suspended. Any resources the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. 3092 3093 Args: 3094 project: string, Project ID for this request. (required) 3095 zone: string, The name of the zone for this request. (required) 3096 instance: string, Name of the instance resource to suspend. (required) 3097 discardLocalSsd: boolean, If true, discard the contents of any attached localSSD partitions. Default value is false (== preserve localSSD data). 3098 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 3099 3100 Returns: 3101 An object of the form: 3102 3103 { # An Operation resource, used to manage asynchronous API requests. 3104 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 3105 "clientOperationId": "A String", # [Output Only] Reserved for future use. 3106 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 3107 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 3108 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 3109 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 3110 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 3111 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 3112 "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. 3113 "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. 3114 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 3115 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 3116 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 3117 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 3118 { 3119 "message": "A String", # [Output Only] A human-readable description of the warning code. 3120 "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. 3121 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 3122 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 3123 { 3124 "value": "A String", # [Output Only] A warning data value corresponding to the key. 3125 "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). 3126 }, 3127 ], 3128 }, 3129 ], 3130 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 3131 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 3132 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 3133 "name": "A String", # [Output Only] Name of the resource. 3134 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 3135 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 3136 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 3137 { 3138 "message": "A String", # [Output Only] An optional, human-readable error message. 3139 "code": "A String", # [Output Only] The error type identifier for this error. 3140 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 3141 }, 3142 ], 3143 }, 3144 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 3145 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 3146 "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. 3147 }</pre> 3148 </div> 3149 3150 <div class="method"> 3151 <code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body)</code> 3152 <pre>Returns permissions that a caller has on the specified resource. 3153 3154 Args: 3155 project: string, Project ID for this request. (required) 3156 zone: string, The name of the zone for this request. (required) 3157 resource: string, Name of the resource for this request. (required) 3158 body: object, The request body. (required) 3159 The object takes the form of: 3160 3161 { 3162 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 3163 "A String", 3164 ], 3165 } 3166 3167 3168 Returns: 3169 An object of the form: 3170 3171 { 3172 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 3173 "A String", 3174 ], 3175 }</pre> 3176 </div> 3177 3178 <div class="method"> 3179 <code class="details" id="updateAccessConfig">updateAccessConfig(project, zone, instance, networkInterface, body, requestId=None)</code> 3180 <pre>Updates the specified access config from an instance's network interface with the data included in the request. 3181 3182 Args: 3183 project: string, Project ID for this request. (required) 3184 zone: string, The name of the zone for this request. (required) 3185 instance: string, The instance name for this request. (required) 3186 networkInterface: string, The name of the network interface where the access config is attached. (required) 3187 body: object, The request body. (required) 3188 The object takes the form of: 3189 3190 { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. 3191 "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. 3192 "name": "A String", # The name of this access configuration. The default and recommended name is External NAT but you can use any arbitrary string you would like. For example, My external IP or Network Access. 3193 "setPublicDns": True or False, # Specifies whether a public DNS ?A? record should be created for the external IP address of this access configuration. 3194 "publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance. 3195 "networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM , SELECT. If this field is not specified, it is assumed to be PREMIUM. 3196 "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. 3197 "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. 3198 "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT. 3199 "publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. This field can only be set when the set_public_ptr field is enabled. 3200 } 3201 3202 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 3203 3204 Returns: 3205 An object of the form: 3206 3207 { # An Operation resource, used to manage asynchronous API requests. 3208 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 3209 "clientOperationId": "A String", # [Output Only] Reserved for future use. 3210 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 3211 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 3212 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 3213 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 3214 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 3215 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 3216 "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. 3217 "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. 3218 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 3219 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 3220 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 3221 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 3222 { 3223 "message": "A String", # [Output Only] A human-readable description of the warning code. 3224 "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. 3225 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 3226 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 3227 { 3228 "value": "A String", # [Output Only] A warning data value corresponding to the key. 3229 "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). 3230 }, 3231 ], 3232 }, 3233 ], 3234 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 3235 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 3236 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 3237 "name": "A String", # [Output Only] Name of the resource. 3238 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 3239 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 3240 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 3241 { 3242 "message": "A String", # [Output Only] An optional, human-readable error message. 3243 "code": "A String", # [Output Only] The error type identifier for this error. 3244 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 3245 }, 3246 ], 3247 }, 3248 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 3249 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 3250 "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. 3251 }</pre> 3252 </div> 3253 3254 <div class="method"> 3255 <code class="details" id="updateNetworkInterface">updateNetworkInterface(project, zone, instance, networkInterface, body, requestId=None)</code> 3256 <pre>Updates an instance's network interface. This method follows PATCH semantics. 3257 3258 Args: 3259 project: string, Project ID for this request. (required) 3260 zone: string, The name of the zone for this request. (required) 3261 instance: string, The instance name for this request. (required) 3262 networkInterface: string, The name of the network interface to update. (required) 3263 body: object, The request body. (required) 3264 The object takes the form of: 3265 3266 { # A network interface resource attached to an instance. 3267 "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. 3268 "aliasIpRanges": [ # An array of alias IP ranges for this network interface. Can only be specified for network interfaces on subnet-mode networks. 3269 { # An alias IP range attached to an instance's network interface. 3270 "subnetworkRangeName": "A String", # Optional subnetwork secondary range name specifying the secondary range from which to allocate the IP CIDR range for this alias IP range. If left unspecified, the primary range of the subnetwork will be used. 3271 "ipCidrRange": "A String", # The IP CIDR range represented by this alias IP range. 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 (e.g. 10.2.3.4), a netmask (e.g. /24) or a CIDR format string (e.g. 10.1.2.0/24). 3272 }, 3273 ], 3274 "network": "A String", # URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred. 3275 # 3276 # This field is optional when creating a firewall rule. If not specified when creating a firewall rule, the default network global/networks/default is used. 3277 # 3278 # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: 3279 # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network 3280 # - projects/project/global/networks/network 3281 # - global/networks/default 3282 "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. 3283 { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. 3284 "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. 3285 "name": "A String", # The name of this access configuration. The default and recommended name is External NAT but you can use any arbitrary string you would like. For example, My external IP or Network Access. 3286 "setPublicDns": True or False, # Specifies whether a public DNS ?A? record should be created for the external IP address of this access configuration. 3287 "publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance. 3288 "networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM , SELECT. If this field is not specified, it is assumed to be PREMIUM. 3289 "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. 3290 "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. 3291 "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT. 3292 "publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. This field can only be set when the set_public_ptr field is enabled. 3293 }, 3294 ], 3295 "networkIP": "A String", # An IPv4 internal network 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. 3296 "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. 3297 "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: 3298 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork 3299 # - regions/region/subnetworks/subnetwork 3300 "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc. 3301 } 3302 3303 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 3304 3305 Returns: 3306 An object of the form: 3307 3308 { # An Operation resource, used to manage asynchronous API requests. 3309 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 3310 "clientOperationId": "A String", # [Output Only] Reserved for future use. 3311 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 3312 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 3313 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 3314 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 3315 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 3316 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 3317 "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. 3318 "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. 3319 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 3320 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 3321 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 3322 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 3323 { 3324 "message": "A String", # [Output Only] A human-readable description of the warning code. 3325 "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. 3326 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 3327 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 3328 { 3329 "value": "A String", # [Output Only] A warning data value corresponding to the key. 3330 "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). 3331 }, 3332 ], 3333 }, 3334 ], 3335 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 3336 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 3337 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 3338 "name": "A String", # [Output Only] Name of the resource. 3339 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 3340 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 3341 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 3342 { 3343 "message": "A String", # [Output Only] An optional, human-readable error message. 3344 "code": "A String", # [Output Only] The error type identifier for this error. 3345 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 3346 }, 3347 ], 3348 }, 3349 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 3350 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 3351 "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. 3352 }</pre> 3353 </div> 3354 3355 </body></html>
