blob: 18b068aa84c42691907dadeb731a1404005dabe5 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -04001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.instances.html">instances</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#addAccessConfig">addAccessConfig(project, zone, instance, networkInterface, body)</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, maxResults=None, pageToken=None, filter=None)</a></code></p>
82<p class="firstline">A description of how to use this function</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)</a></code></p>
88<p class="firstline">Attaches a disk resource to an instance.</p>
89<p class="toc_element">
90 <code><a href="#delete">delete(project, zone, instance)</a></code></p>
91<p class="firstline">Deletes the specified instance resource.</p>
92<p class="toc_element">
93 <code><a href="#deleteAccessConfig">deleteAccessConfig(project, zone, instance, accessConfig, networkInterface)</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)</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.</p>
101<p class="toc_element">
102 <code><a href="#getSerialPortOutput">getSerialPortOutput(project, zone, instance)</a></code></p>
103<p class="firstline">Returns the specified instance's serial port output.</p>
104<p class="toc_element">
105 <code><a href="#insert">insert(project, zone, body)</a></code></p>
106<p class="firstline">Creates an instance resource in the specified project using the data included in the request.</p>
107<p class="toc_element">
108 <code><a href="#list">list(project, zone, maxResults=None, pageToken=None, filter=None)</a></code></p>
109<p class="firstline">Retrieves the list of instance resources contained within the specified zone.</p>
110<p class="toc_element">
111 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
112<p class="firstline">Retrieves the next page of results.</p>
113<p class="toc_element">
114 <code><a href="#reset">reset(project, zone, instance)</a></code></p>
115<p class="firstline">Performs a hard reset on the instance.</p>
116<p class="toc_element">
117 <code><a href="#setDiskAutoDelete">setDiskAutoDelete(project, zone, instance, autoDelete, deviceName)</a></code></p>
118<p class="firstline">Sets the auto-delete flag for a disk attached to an instance</p>
119<p class="toc_element">
120 <code><a href="#setMetadata">setMetadata(project, zone, instance, body)</a></code></p>
121<p class="firstline">Sets metadata for the specified instance to the data included in the request.</p>
122<p class="toc_element">
123 <code><a href="#setScheduling">setScheduling(project, zone, instance, body)</a></code></p>
124<p class="firstline">Sets an instance's scheduling options.</p>
125<p class="toc_element">
126 <code><a href="#setTags">setTags(project, zone, instance, body)</a></code></p>
127<p class="firstline">Sets tags for the specified instance to the data included in the request.</p>
128<h3>Method Details</h3>
129<div class="method">
130 <code class="details" id="addAccessConfig">addAccessConfig(project, zone, instance, networkInterface, body)</code>
131 <pre>Adds an access config to an instance's network interface.
132
133Args:
134 project: string, Project name. (required)
135 zone: string, Name of the zone scoping this request. (required)
136 instance: string, Instance name. (required)
137 networkInterface: string, Network interface name. (required)
138 body: object, The request body. (required)
139 The object takes the form of:
140
141{ # An access configuration attached to an instance's network interface.
142 "kind": "compute#accessConfig", # Type of the resource.
143 "type": "ONE_TO_ONE_NAT", # Type of configuration. Must be set to "ONE_TO_ONE_NAT". This configures port-for-port NAT to the internet.
144 "name": "A String", # Name of this access configuration.
145 "natIP": "A String", # An external IP address associated with this instance. Specify an unused static IP address available to the project. If not specified, the external IP will be drawn from a shared ephemeral pool.
146}
147
148
149Returns:
150 An object of the form:
151
152 { # An operation resource, used to manage asynchronous API requests.
153 "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
154 "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
155 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
156 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
157 "zone": "A String", # URL of the zone where the operation resides (output only).
158 "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
159 "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
160 "progress": 42, # 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 at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
161 "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
162 "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
163 "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
164 "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
165 "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
166 {
167 "message": "A String", # Optional human-readable details for this warning.
168 "code": "A String", # The warning type identifier for this warning.
169 "data": [ # Metadata for this warning in 'key: value' format.
170 {
171 "value": "A String", # A warning data value corresponding to the key.
172 "key": "A String", # A key for the warning data.
173 },
174 ],
175 },
176 ],
177 "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
178 "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
179 "kind": "compute#operation", # Type of the resource.
180 "name": "A String", # Name of the resource (output only).
181 "region": "A String", # URL of the region where the operation resides (output only).
182 "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
183 "errors": [ # The array of errors encountered while processing this operation.
184 {
185 "message": "A String", # An optional, human-readable error message.
186 "code": "A String", # The error type identifier for this error.
187 "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
188 },
189 ],
190 },
191 "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
192 "selfLink": "A String", # Server defined URL for the resource (output only).
193 "targetLink": "A String", # URL of the resource the operation is mutating (output only).
194 }</pre>
195</div>
196
197<div class="method">
198 <code class="details" id="aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</code>
199 <pre>A description of how to use this function
200
201Args:
202 project: string, Name of the project scoping this request. (required)
203 maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
204 pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
205 filter: string, Optional. Filter expression for filtering listed resources.
206
207Returns:
208 An object of the form:
209
210 {
211 "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
212 "items": { # A map of scoped instance lists.
213 "a_key": { # Name of the scope containing this set of instances.
214 "instances": [ # List of instances contained in this scope.
215 { # An instance resource.
216 "status": "A String", # Instance status. One of the following values: "PROVISIONING", "STAGING", "RUNNING", "STOPPING", "STOPPED", "TERMINATED" (output only).
217 "kind": "compute#instance", # Type of the resource.
218 "canIpForward": True or False, # Allows this instance to send packets with source IP addresses other than its own and receive packets with destination IP addresses other than its own. If this instance will be used as an IP gateway or it will be set as the next-hop in a Route resource, say true. If unsure, leave this set to false.
219 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
220 "zone": "A String", # URL of the zone where the instance resides (output only).
221 "tags": { # A set of instance tags. # A list of tags to be applied to this instance. Used to identify valid sources or targets for network firewalls. Provided by the client on instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
222 "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
223 "A String",
224 ],
225 "fingerprint": "A String", # Fingerprint of this resource. A hash of the tags stored in this object. This field is used optimistic locking. An up-to-date tags fingerprint must be provided in order to modify tags.
226 },
227 "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
228 { # An instance-attached disk resource.
229 "deviceName": "A String", # Persistent disk only; must be unique within the instance when specified. This represents a unique device name that is reflected into the /dev/ tree of a Linux operating system running within the instance. If not specified, a default will be chosen by the system.
230 "kind": "compute#attachedDisk", # Type of the resource.
Craig Citro065b5302014-08-14 00:47:23 -0700231 "initializeParams": { # Initialization parameters for the new disk (input-only). Can only be specified on the boot disk or local SSDs. Mutually exclusive with 'source'. # Initialization parameters.
John Asmuth614db982014-04-24 15:46:26 -0400232 "diskSizeGb": "A String", # Size of the disk in base-2 GB.
233 "diskName": "A String", # Name of the disk (when not provided defaults to the name of the instance).
234 "sourceImage": "A String", # The source image used to create this disk.
Craig Citro065b5302014-08-14 00:47:23 -0700235 "diskType": "A String", # URL of the disk type resource describing which disk type to use to create the disk; provided by the client when the disk is created.
John Asmuth614db982014-04-24 15:46:26 -0400236 },
237 "autoDelete": True or False, # Whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
238 "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, the server will choose an appropriate value (output only).
239 "boot": True or False, # Indicates that this is a boot disk. VM will use the first partition of the disk for its root filesystem.
240 "source": "A String", # Persistent disk only; the URL of the persistent disk resource.
241 "mode": "A String", # The mode in which to attach this disk, either "READ_WRITE" or "READ_ONLY".
Craig Citro065b5302014-08-14 00:47:23 -0700242 "licenses": [ # Public visible licenses.
243 "A String",
244 ],
John Asmuth614db982014-04-24 15:46:26 -0400245 "type": "A String", # Type of the disk, either "SCRATCH" or "PERSISTENT". Note that persistent disks must be created before you can specify them here.
246 },
247 ],
248 "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
249 "statusMessage": "A String", # An optional, human-readable explanation of the status (output only).
250 "scheduling": { # Scheduling options for an Instance. # Scheduling options for this instance.
251 "automaticRestart": True or False, # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user).
252 "onHostMaintenance": "A String", # How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance.
253 },
254 "machineType": "A String", # URL of the machine type resource describing which machine type to use to host the instance; provided by the client when the instance is created.
255 "serviceAccounts": [ # A list of service accounts each with specified scopes, for which access tokens are to be made available to the instance through metadata queries.
256 { # A service account.
257 "scopes": [ # The list of scopes to be made available for this service account.
258 "A String",
259 ],
260 "email": "A String", # Email address of the service account.
261 },
262 ],
263 "networkInterfaces": [ # 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. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
264 { # A network interface resource attached to an instance.
265 "accessConfigs": [ # 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. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
266 { # An access configuration attached to an instance's network interface.
267 "kind": "compute#accessConfig", # Type of the resource.
268 "type": "ONE_TO_ONE_NAT", # Type of configuration. Must be set to "ONE_TO_ONE_NAT". This configures port-for-port NAT to the internet.
269 "name": "A String", # Name of this access configuration.
270 "natIP": "A String", # An external IP address associated with this instance. Specify an unused static IP address available to the project. If not specified, the external IP will be drawn from a shared ephemeral pool.
271 },
272 ],
273 "networkIP": "A String", # An optional IPV4 internal network address assigned to the instance for this network interface (output only).
274 "name": "A String", # Name of the network interface, determined by the server; for network devices, these are e.g. eth0, eth1, etc. (output only).
275 "network": "A String", # URL of the network resource attached to this interface.
276 },
277 ],
278 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
279 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
280 "selfLink": "A String", # Server defined URL for this resource (output only).
281 "metadata": { # A metadata key/value entry. # Metadata key/value pairs assigned to this instance. Consists of custom metadata or predefined keys; see Instance documentation for more information.
282 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
283 {
284 "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.
285 "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.
286 },
287 ],
288 "kind": "compute#metadata", # Type of the resource.
289 "fingerprint": "A String", # Fingerprint of this resource. A hash of the metadata's contents. This field is used for optimistic locking. An up-to-date metadata fingerprint must be provided in order to modify metadata.
290 },
291 },
292 ],
293 "warning": { # Informational warning which replaces the list of instances when the list is empty.
294 "message": "A String", # Optional human-readable details for this warning.
295 "code": "A String", # The warning type identifier for this warning.
296 "data": [ # Metadata for this warning in 'key: value' format.
297 {
298 "value": "A String", # A warning data value corresponding to the key.
299 "key": "A String", # A key for the warning data.
300 },
301 ],
302 },
303 },
304 },
305 "kind": "compute#instanceAggregatedList", # Type of resource.
306 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
307 "selfLink": "A String", # Server defined URL for this resource (output only).
308 }</pre>
309</div>
310
311<div class="method">
312 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
313 <pre>Retrieves the next page of results.
314
315Args:
316 previous_request: The request for the previous page. (required)
317 previous_response: The response from the request for the previous page. (required)
318
319Returns:
320 A request object that you can call 'execute()' on to request the next
321 page. Returns None if there are no more items in the collection.
322 </pre>
323</div>
324
325<div class="method">
326 <code class="details" id="attachDisk">attachDisk(project, zone, instance, body)</code>
327 <pre>Attaches a disk resource to an instance.
328
329Args:
330 project: string, Project name. (required)
331 zone: string, Name of the zone scoping this request. (required)
332 instance: string, Instance name. (required)
333 body: object, The request body. (required)
334 The object takes the form of:
335
336{ # An instance-attached disk resource.
337 "deviceName": "A String", # Persistent disk only; must be unique within the instance when specified. This represents a unique device name that is reflected into the /dev/ tree of a Linux operating system running within the instance. If not specified, a default will be chosen by the system.
338 "kind": "compute#attachedDisk", # Type of the resource.
Craig Citro065b5302014-08-14 00:47:23 -0700339 "initializeParams": { # Initialization parameters for the new disk (input-only). Can only be specified on the boot disk or local SSDs. Mutually exclusive with 'source'. # Initialization parameters.
John Asmuth614db982014-04-24 15:46:26 -0400340 "diskSizeGb": "A String", # Size of the disk in base-2 GB.
341 "diskName": "A String", # Name of the disk (when not provided defaults to the name of the instance).
342 "sourceImage": "A String", # The source image used to create this disk.
Craig Citro065b5302014-08-14 00:47:23 -0700343 "diskType": "A String", # URL of the disk type resource describing which disk type to use to create the disk; provided by the client when the disk is created.
John Asmuth614db982014-04-24 15:46:26 -0400344 },
345 "autoDelete": True or False, # Whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
346 "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, the server will choose an appropriate value (output only).
347 "boot": True or False, # Indicates that this is a boot disk. VM will use the first partition of the disk for its root filesystem.
348 "source": "A String", # Persistent disk only; the URL of the persistent disk resource.
349 "mode": "A String", # The mode in which to attach this disk, either "READ_WRITE" or "READ_ONLY".
Craig Citro065b5302014-08-14 00:47:23 -0700350 "licenses": [ # Public visible licenses.
351 "A String",
352 ],
John Asmuth614db982014-04-24 15:46:26 -0400353 "type": "A String", # Type of the disk, either "SCRATCH" or "PERSISTENT". Note that persistent disks must be created before you can specify them here.
354 }
355
356
357Returns:
358 An object of the form:
359
360 { # An operation resource, used to manage asynchronous API requests.
361 "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
362 "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
363 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
364 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
365 "zone": "A String", # URL of the zone where the operation resides (output only).
366 "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
367 "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
368 "progress": 42, # 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 at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
369 "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
370 "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
371 "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
372 "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
373 "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
374 {
375 "message": "A String", # Optional human-readable details for this warning.
376 "code": "A String", # The warning type identifier for this warning.
377 "data": [ # Metadata for this warning in 'key: value' format.
378 {
379 "value": "A String", # A warning data value corresponding to the key.
380 "key": "A String", # A key for the warning data.
381 },
382 ],
383 },
384 ],
385 "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
386 "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
387 "kind": "compute#operation", # Type of the resource.
388 "name": "A String", # Name of the resource (output only).
389 "region": "A String", # URL of the region where the operation resides (output only).
390 "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
391 "errors": [ # The array of errors encountered while processing this operation.
392 {
393 "message": "A String", # An optional, human-readable error message.
394 "code": "A String", # The error type identifier for this error.
395 "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
396 },
397 ],
398 },
399 "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
400 "selfLink": "A String", # Server defined URL for the resource (output only).
401 "targetLink": "A String", # URL of the resource the operation is mutating (output only).
402 }</pre>
403</div>
404
405<div class="method">
406 <code class="details" id="delete">delete(project, zone, instance)</code>
407 <pre>Deletes the specified instance resource.
408
409Args:
410 project: string, Name of the project scoping this request. (required)
411 zone: string, Name of the zone scoping this request. (required)
412 instance: string, Name of the instance resource to delete. (required)
413
414Returns:
415 An object of the form:
416
417 { # An operation resource, used to manage asynchronous API requests.
418 "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
419 "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
420 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
421 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
422 "zone": "A String", # URL of the zone where the operation resides (output only).
423 "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
424 "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
425 "progress": 42, # 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 at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
426 "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
427 "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
428 "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
429 "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
430 "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
431 {
432 "message": "A String", # Optional human-readable details for this warning.
433 "code": "A String", # The warning type identifier for this warning.
434 "data": [ # Metadata for this warning in 'key: value' format.
435 {
436 "value": "A String", # A warning data value corresponding to the key.
437 "key": "A String", # A key for the warning data.
438 },
439 ],
440 },
441 ],
442 "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
443 "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
444 "kind": "compute#operation", # Type of the resource.
445 "name": "A String", # Name of the resource (output only).
446 "region": "A String", # URL of the region where the operation resides (output only).
447 "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
448 "errors": [ # The array of errors encountered while processing this operation.
449 {
450 "message": "A String", # An optional, human-readable error message.
451 "code": "A String", # The error type identifier for this error.
452 "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
453 },
454 ],
455 },
456 "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
457 "selfLink": "A String", # Server defined URL for the resource (output only).
458 "targetLink": "A String", # URL of the resource the operation is mutating (output only).
459 }</pre>
460</div>
461
462<div class="method">
463 <code class="details" id="deleteAccessConfig">deleteAccessConfig(project, zone, instance, accessConfig, networkInterface)</code>
464 <pre>Deletes an access config from an instance's network interface.
465
466Args:
467 project: string, Project name. (required)
468 zone: string, Name of the zone scoping this request. (required)
469 instance: string, Instance name. (required)
470 accessConfig: string, Access config name. (required)
471 networkInterface: string, Network interface name. (required)
472
473Returns:
474 An object of the form:
475
476 { # An operation resource, used to manage asynchronous API requests.
477 "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
478 "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
479 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
480 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
481 "zone": "A String", # URL of the zone where the operation resides (output only).
482 "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
483 "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
484 "progress": 42, # 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 at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
485 "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
486 "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
487 "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
488 "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
489 "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
490 {
491 "message": "A String", # Optional human-readable details for this warning.
492 "code": "A String", # The warning type identifier for this warning.
493 "data": [ # Metadata for this warning in 'key: value' format.
494 {
495 "value": "A String", # A warning data value corresponding to the key.
496 "key": "A String", # A key for the warning data.
497 },
498 ],
499 },
500 ],
501 "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
502 "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
503 "kind": "compute#operation", # Type of the resource.
504 "name": "A String", # Name of the resource (output only).
505 "region": "A String", # URL of the region where the operation resides (output only).
506 "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
507 "errors": [ # The array of errors encountered while processing this operation.
508 {
509 "message": "A String", # An optional, human-readable error message.
510 "code": "A String", # The error type identifier for this error.
511 "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
512 },
513 ],
514 },
515 "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
516 "selfLink": "A String", # Server defined URL for the resource (output only).
517 "targetLink": "A String", # URL of the resource the operation is mutating (output only).
518 }</pre>
519</div>
520
521<div class="method">
522 <code class="details" id="detachDisk">detachDisk(project, zone, instance, deviceName)</code>
523 <pre>Detaches a disk from an instance.
524
525Args:
526 project: string, Project name. (required)
527 zone: string, Name of the zone scoping this request. (required)
528 instance: string, Instance name. (required)
529 deviceName: string, Disk device name to detach. (required)
530
531Returns:
532 An object of the form:
533
534 { # An operation resource, used to manage asynchronous API requests.
535 "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
536 "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
537 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
538 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
539 "zone": "A String", # URL of the zone where the operation resides (output only).
540 "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
541 "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
542 "progress": 42, # 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 at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
543 "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
544 "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
545 "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
546 "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
547 "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
548 {
549 "message": "A String", # Optional human-readable details for this warning.
550 "code": "A String", # The warning type identifier for this warning.
551 "data": [ # Metadata for this warning in 'key: value' format.
552 {
553 "value": "A String", # A warning data value corresponding to the key.
554 "key": "A String", # A key for the warning data.
555 },
556 ],
557 },
558 ],
559 "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
560 "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
561 "kind": "compute#operation", # Type of the resource.
562 "name": "A String", # Name of the resource (output only).
563 "region": "A String", # URL of the region where the operation resides (output only).
564 "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
565 "errors": [ # The array of errors encountered while processing this operation.
566 {
567 "message": "A String", # An optional, human-readable error message.
568 "code": "A String", # The error type identifier for this error.
569 "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
570 },
571 ],
572 },
573 "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
574 "selfLink": "A String", # Server defined URL for the resource (output only).
575 "targetLink": "A String", # URL of the resource the operation is mutating (output only).
576 }</pre>
577</div>
578
579<div class="method">
580 <code class="details" id="get">get(project, zone, instance)</code>
581 <pre>Returns the specified instance resource.
582
583Args:
584 project: string, Name of the project scoping this request. (required)
585 zone: string, Name of the zone scoping this request. (required)
586 instance: string, Name of the instance resource to return. (required)
587
588Returns:
589 An object of the form:
590
591 { # An instance resource.
592 "status": "A String", # Instance status. One of the following values: "PROVISIONING", "STAGING", "RUNNING", "STOPPING", "STOPPED", "TERMINATED" (output only).
593 "kind": "compute#instance", # Type of the resource.
594 "canIpForward": True or False, # Allows this instance to send packets with source IP addresses other than its own and receive packets with destination IP addresses other than its own. If this instance will be used as an IP gateway or it will be set as the next-hop in a Route resource, say true. If unsure, leave this set to false.
595 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
596 "zone": "A String", # URL of the zone where the instance resides (output only).
597 "tags": { # A set of instance tags. # A list of tags to be applied to this instance. Used to identify valid sources or targets for network firewalls. Provided by the client on instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
598 "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
599 "A String",
600 ],
601 "fingerprint": "A String", # Fingerprint of this resource. A hash of the tags stored in this object. This field is used optimistic locking. An up-to-date tags fingerprint must be provided in order to modify tags.
602 },
603 "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
604 { # An instance-attached disk resource.
605 "deviceName": "A String", # Persistent disk only; must be unique within the instance when specified. This represents a unique device name that is reflected into the /dev/ tree of a Linux operating system running within the instance. If not specified, a default will be chosen by the system.
606 "kind": "compute#attachedDisk", # Type of the resource.
Craig Citro065b5302014-08-14 00:47:23 -0700607 "initializeParams": { # Initialization parameters for the new disk (input-only). Can only be specified on the boot disk or local SSDs. Mutually exclusive with 'source'. # Initialization parameters.
John Asmuth614db982014-04-24 15:46:26 -0400608 "diskSizeGb": "A String", # Size of the disk in base-2 GB.
609 "diskName": "A String", # Name of the disk (when not provided defaults to the name of the instance).
610 "sourceImage": "A String", # The source image used to create this disk.
Craig Citro065b5302014-08-14 00:47:23 -0700611 "diskType": "A String", # URL of the disk type resource describing which disk type to use to create the disk; provided by the client when the disk is created.
John Asmuth614db982014-04-24 15:46:26 -0400612 },
613 "autoDelete": True or False, # Whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
614 "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, the server will choose an appropriate value (output only).
615 "boot": True or False, # Indicates that this is a boot disk. VM will use the first partition of the disk for its root filesystem.
616 "source": "A String", # Persistent disk only; the URL of the persistent disk resource.
617 "mode": "A String", # The mode in which to attach this disk, either "READ_WRITE" or "READ_ONLY".
Craig Citro065b5302014-08-14 00:47:23 -0700618 "licenses": [ # Public visible licenses.
619 "A String",
620 ],
John Asmuth614db982014-04-24 15:46:26 -0400621 "type": "A String", # Type of the disk, either "SCRATCH" or "PERSISTENT". Note that persistent disks must be created before you can specify them here.
622 },
623 ],
624 "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
625 "statusMessage": "A String", # An optional, human-readable explanation of the status (output only).
626 "scheduling": { # Scheduling options for an Instance. # Scheduling options for this instance.
627 "automaticRestart": True or False, # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user).
628 "onHostMaintenance": "A String", # How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance.
629 },
630 "machineType": "A String", # URL of the machine type resource describing which machine type to use to host the instance; provided by the client when the instance is created.
631 "serviceAccounts": [ # A list of service accounts each with specified scopes, for which access tokens are to be made available to the instance through metadata queries.
632 { # A service account.
633 "scopes": [ # The list of scopes to be made available for this service account.
634 "A String",
635 ],
636 "email": "A String", # Email address of the service account.
637 },
638 ],
639 "networkInterfaces": [ # 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. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
640 { # A network interface resource attached to an instance.
641 "accessConfigs": [ # 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. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
642 { # An access configuration attached to an instance's network interface.
643 "kind": "compute#accessConfig", # Type of the resource.
644 "type": "ONE_TO_ONE_NAT", # Type of configuration. Must be set to "ONE_TO_ONE_NAT". This configures port-for-port NAT to the internet.
645 "name": "A String", # Name of this access configuration.
646 "natIP": "A String", # An external IP address associated with this instance. Specify an unused static IP address available to the project. If not specified, the external IP will be drawn from a shared ephemeral pool.
647 },
648 ],
649 "networkIP": "A String", # An optional IPV4 internal network address assigned to the instance for this network interface (output only).
650 "name": "A String", # Name of the network interface, determined by the server; for network devices, these are e.g. eth0, eth1, etc. (output only).
651 "network": "A String", # URL of the network resource attached to this interface.
652 },
653 ],
654 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
655 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
656 "selfLink": "A String", # Server defined URL for this resource (output only).
657 "metadata": { # A metadata key/value entry. # Metadata key/value pairs assigned to this instance. Consists of custom metadata or predefined keys; see Instance documentation for more information.
658 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
659 {
660 "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.
661 "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.
662 },
663 ],
664 "kind": "compute#metadata", # Type of the resource.
665 "fingerprint": "A String", # Fingerprint of this resource. A hash of the metadata's contents. This field is used for optimistic locking. An up-to-date metadata fingerprint must be provided in order to modify metadata.
666 },
667 }</pre>
668</div>
669
670<div class="method">
671 <code class="details" id="getSerialPortOutput">getSerialPortOutput(project, zone, instance)</code>
672 <pre>Returns the specified instance's serial port output.
673
674Args:
675 project: string, Name of the project scoping this request. (required)
676 zone: string, Name of the zone scoping this request. (required)
677 instance: string, Name of the instance scoping this request. (required)
678
679Returns:
680 An object of the form:
681
682 { # An instance serial console output.
683 "kind": "compute#serialPortOutput", # Type of the resource.
684 "selfLink": "A String", # Server defined URL for the resource (output only).
685 "contents": "A String", # The contents of the console output.
686 }</pre>
687</div>
688
689<div class="method">
690 <code class="details" id="insert">insert(project, zone, body)</code>
691 <pre>Creates an instance resource in the specified project using the data included in the request.
692
693Args:
694 project: string, Name of the project scoping this request. (required)
695 zone: string, Name of the zone scoping this request. (required)
696 body: object, The request body. (required)
697 The object takes the form of:
698
699{ # An instance resource.
700 "status": "A String", # Instance status. One of the following values: "PROVISIONING", "STAGING", "RUNNING", "STOPPING", "STOPPED", "TERMINATED" (output only).
701 "kind": "compute#instance", # Type of the resource.
702 "canIpForward": True or False, # Allows this instance to send packets with source IP addresses other than its own and receive packets with destination IP addresses other than its own. If this instance will be used as an IP gateway or it will be set as the next-hop in a Route resource, say true. If unsure, leave this set to false.
703 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
704 "zone": "A String", # URL of the zone where the instance resides (output only).
705 "tags": { # A set of instance tags. # A list of tags to be applied to this instance. Used to identify valid sources or targets for network firewalls. Provided by the client on instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
706 "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
707 "A String",
708 ],
709 "fingerprint": "A String", # Fingerprint of this resource. A hash of the tags stored in this object. This field is used optimistic locking. An up-to-date tags fingerprint must be provided in order to modify tags.
710 },
711 "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
712 { # An instance-attached disk resource.
713 "deviceName": "A String", # Persistent disk only; must be unique within the instance when specified. This represents a unique device name that is reflected into the /dev/ tree of a Linux operating system running within the instance. If not specified, a default will be chosen by the system.
714 "kind": "compute#attachedDisk", # Type of the resource.
Craig Citro065b5302014-08-14 00:47:23 -0700715 "initializeParams": { # Initialization parameters for the new disk (input-only). Can only be specified on the boot disk or local SSDs. Mutually exclusive with 'source'. # Initialization parameters.
John Asmuth614db982014-04-24 15:46:26 -0400716 "diskSizeGb": "A String", # Size of the disk in base-2 GB.
717 "diskName": "A String", # Name of the disk (when not provided defaults to the name of the instance).
718 "sourceImage": "A String", # The source image used to create this disk.
Craig Citro065b5302014-08-14 00:47:23 -0700719 "diskType": "A String", # URL of the disk type resource describing which disk type to use to create the disk; provided by the client when the disk is created.
John Asmuth614db982014-04-24 15:46:26 -0400720 },
721 "autoDelete": True or False, # Whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
722 "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, the server will choose an appropriate value (output only).
723 "boot": True or False, # Indicates that this is a boot disk. VM will use the first partition of the disk for its root filesystem.
724 "source": "A String", # Persistent disk only; the URL of the persistent disk resource.
725 "mode": "A String", # The mode in which to attach this disk, either "READ_WRITE" or "READ_ONLY".
Craig Citro065b5302014-08-14 00:47:23 -0700726 "licenses": [ # Public visible licenses.
727 "A String",
728 ],
John Asmuth614db982014-04-24 15:46:26 -0400729 "type": "A String", # Type of the disk, either "SCRATCH" or "PERSISTENT". Note that persistent disks must be created before you can specify them here.
730 },
731 ],
732 "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
733 "statusMessage": "A String", # An optional, human-readable explanation of the status (output only).
734 "scheduling": { # Scheduling options for an Instance. # Scheduling options for this instance.
735 "automaticRestart": True or False, # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user).
736 "onHostMaintenance": "A String", # How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance.
737 },
738 "machineType": "A String", # URL of the machine type resource describing which machine type to use to host the instance; provided by the client when the instance is created.
739 "serviceAccounts": [ # A list of service accounts each with specified scopes, for which access tokens are to be made available to the instance through metadata queries.
740 { # A service account.
741 "scopes": [ # The list of scopes to be made available for this service account.
742 "A String",
743 ],
744 "email": "A String", # Email address of the service account.
745 },
746 ],
747 "networkInterfaces": [ # 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. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
748 { # A network interface resource attached to an instance.
749 "accessConfigs": [ # 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. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
750 { # An access configuration attached to an instance's network interface.
751 "kind": "compute#accessConfig", # Type of the resource.
752 "type": "ONE_TO_ONE_NAT", # Type of configuration. Must be set to "ONE_TO_ONE_NAT". This configures port-for-port NAT to the internet.
753 "name": "A String", # Name of this access configuration.
754 "natIP": "A String", # An external IP address associated with this instance. Specify an unused static IP address available to the project. If not specified, the external IP will be drawn from a shared ephemeral pool.
755 },
756 ],
757 "networkIP": "A String", # An optional IPV4 internal network address assigned to the instance for this network interface (output only).
758 "name": "A String", # Name of the network interface, determined by the server; for network devices, these are e.g. eth0, eth1, etc. (output only).
759 "network": "A String", # URL of the network resource attached to this interface.
760 },
761 ],
762 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
763 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
764 "selfLink": "A String", # Server defined URL for this resource (output only).
765 "metadata": { # A metadata key/value entry. # Metadata key/value pairs assigned to this instance. Consists of custom metadata or predefined keys; see Instance documentation for more information.
766 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
767 {
768 "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.
769 "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.
770 },
771 ],
772 "kind": "compute#metadata", # Type of the resource.
773 "fingerprint": "A String", # Fingerprint of this resource. A hash of the metadata's contents. This field is used for optimistic locking. An up-to-date metadata fingerprint must be provided in order to modify metadata.
774 },
775}
776
777
778Returns:
779 An object of the form:
780
781 { # An operation resource, used to manage asynchronous API requests.
782 "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
783 "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
784 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
785 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
786 "zone": "A String", # URL of the zone where the operation resides (output only).
787 "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
788 "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
789 "progress": 42, # 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 at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
790 "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
791 "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
792 "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
793 "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
794 "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
795 {
796 "message": "A String", # Optional human-readable details for this warning.
797 "code": "A String", # The warning type identifier for this warning.
798 "data": [ # Metadata for this warning in 'key: value' format.
799 {
800 "value": "A String", # A warning data value corresponding to the key.
801 "key": "A String", # A key for the warning data.
802 },
803 ],
804 },
805 ],
806 "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
807 "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
808 "kind": "compute#operation", # Type of the resource.
809 "name": "A String", # Name of the resource (output only).
810 "region": "A String", # URL of the region where the operation resides (output only).
811 "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
812 "errors": [ # The array of errors encountered while processing this operation.
813 {
814 "message": "A String", # An optional, human-readable error message.
815 "code": "A String", # The error type identifier for this error.
816 "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
817 },
818 ],
819 },
820 "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
821 "selfLink": "A String", # Server defined URL for the resource (output only).
822 "targetLink": "A String", # URL of the resource the operation is mutating (output only).
823 }</pre>
824</div>
825
826<div class="method">
827 <code class="details" id="list">list(project, zone, maxResults=None, pageToken=None, filter=None)</code>
828 <pre>Retrieves the list of instance resources contained within the specified zone.
829
830Args:
831 project: string, Name of the project scoping this request. (required)
832 zone: string, Name of the zone scoping this request. (required)
833 maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
834 pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
835 filter: string, Optional. Filter expression for filtering listed resources.
836
837Returns:
838 An object of the form:
839
840 { # Contains a list of instance resources.
841 "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
842 "items": [ # A list of instance resources.
843 { # An instance resource.
844 "status": "A String", # Instance status. One of the following values: "PROVISIONING", "STAGING", "RUNNING", "STOPPING", "STOPPED", "TERMINATED" (output only).
845 "kind": "compute#instance", # Type of the resource.
846 "canIpForward": True or False, # Allows this instance to send packets with source IP addresses other than its own and receive packets with destination IP addresses other than its own. If this instance will be used as an IP gateway or it will be set as the next-hop in a Route resource, say true. If unsure, leave this set to false.
847 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
848 "zone": "A String", # URL of the zone where the instance resides (output only).
849 "tags": { # A set of instance tags. # A list of tags to be applied to this instance. Used to identify valid sources or targets for network firewalls. Provided by the client on instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
850 "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
851 "A String",
852 ],
853 "fingerprint": "A String", # Fingerprint of this resource. A hash of the tags stored in this object. This field is used optimistic locking. An up-to-date tags fingerprint must be provided in order to modify tags.
854 },
855 "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
856 { # An instance-attached disk resource.
857 "deviceName": "A String", # Persistent disk only; must be unique within the instance when specified. This represents a unique device name that is reflected into the /dev/ tree of a Linux operating system running within the instance. If not specified, a default will be chosen by the system.
858 "kind": "compute#attachedDisk", # Type of the resource.
Craig Citro065b5302014-08-14 00:47:23 -0700859 "initializeParams": { # Initialization parameters for the new disk (input-only). Can only be specified on the boot disk or local SSDs. Mutually exclusive with 'source'. # Initialization parameters.
John Asmuth614db982014-04-24 15:46:26 -0400860 "diskSizeGb": "A String", # Size of the disk in base-2 GB.
861 "diskName": "A String", # Name of the disk (when not provided defaults to the name of the instance).
862 "sourceImage": "A String", # The source image used to create this disk.
Craig Citro065b5302014-08-14 00:47:23 -0700863 "diskType": "A String", # URL of the disk type resource describing which disk type to use to create the disk; provided by the client when the disk is created.
John Asmuth614db982014-04-24 15:46:26 -0400864 },
865 "autoDelete": True or False, # Whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
866 "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, the server will choose an appropriate value (output only).
867 "boot": True or False, # Indicates that this is a boot disk. VM will use the first partition of the disk for its root filesystem.
868 "source": "A String", # Persistent disk only; the URL of the persistent disk resource.
869 "mode": "A String", # The mode in which to attach this disk, either "READ_WRITE" or "READ_ONLY".
Craig Citro065b5302014-08-14 00:47:23 -0700870 "licenses": [ # Public visible licenses.
871 "A String",
872 ],
John Asmuth614db982014-04-24 15:46:26 -0400873 "type": "A String", # Type of the disk, either "SCRATCH" or "PERSISTENT". Note that persistent disks must be created before you can specify them here.
874 },
875 ],
876 "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
877 "statusMessage": "A String", # An optional, human-readable explanation of the status (output only).
878 "scheduling": { # Scheduling options for an Instance. # Scheduling options for this instance.
879 "automaticRestart": True or False, # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user).
880 "onHostMaintenance": "A String", # How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance.
881 },
882 "machineType": "A String", # URL of the machine type resource describing which machine type to use to host the instance; provided by the client when the instance is created.
883 "serviceAccounts": [ # A list of service accounts each with specified scopes, for which access tokens are to be made available to the instance through metadata queries.
884 { # A service account.
885 "scopes": [ # The list of scopes to be made available for this service account.
886 "A String",
887 ],
888 "email": "A String", # Email address of the service account.
889 },
890 ],
891 "networkInterfaces": [ # 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. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
892 { # A network interface resource attached to an instance.
893 "accessConfigs": [ # 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. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
894 { # An access configuration attached to an instance's network interface.
895 "kind": "compute#accessConfig", # Type of the resource.
896 "type": "ONE_TO_ONE_NAT", # Type of configuration. Must be set to "ONE_TO_ONE_NAT". This configures port-for-port NAT to the internet.
897 "name": "A String", # Name of this access configuration.
898 "natIP": "A String", # An external IP address associated with this instance. Specify an unused static IP address available to the project. If not specified, the external IP will be drawn from a shared ephemeral pool.
899 },
900 ],
901 "networkIP": "A String", # An optional IPV4 internal network address assigned to the instance for this network interface (output only).
902 "name": "A String", # Name of the network interface, determined by the server; for network devices, these are e.g. eth0, eth1, etc. (output only).
903 "network": "A String", # URL of the network resource attached to this interface.
904 },
905 ],
906 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
907 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
908 "selfLink": "A String", # Server defined URL for this resource (output only).
909 "metadata": { # A metadata key/value entry. # Metadata key/value pairs assigned to this instance. Consists of custom metadata or predefined keys; see Instance documentation for more information.
910 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
911 {
912 "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.
913 "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.
914 },
915 ],
916 "kind": "compute#metadata", # Type of the resource.
917 "fingerprint": "A String", # Fingerprint of this resource. A hash of the metadata's contents. This field is used for optimistic locking. An up-to-date metadata fingerprint must be provided in order to modify metadata.
918 },
919 },
920 ],
921 "kind": "compute#instanceList", # Type of resource.
922 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
923 "selfLink": "A String", # Server defined URL for this resource (output only).
924 }</pre>
925</div>
926
927<div class="method">
928 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
929 <pre>Retrieves the next page of results.
930
931Args:
932 previous_request: The request for the previous page. (required)
933 previous_response: The response from the request for the previous page. (required)
934
935Returns:
936 A request object that you can call 'execute()' on to request the next
937 page. Returns None if there are no more items in the collection.
938 </pre>
939</div>
940
941<div class="method">
942 <code class="details" id="reset">reset(project, zone, instance)</code>
943 <pre>Performs a hard reset on the instance.
944
945Args:
946 project: string, Name of the project scoping this request. (required)
947 zone: string, Name of the zone scoping this request. (required)
948 instance: string, Name of the instance scoping this request. (required)
949
950Returns:
951 An object of the form:
952
953 { # An operation resource, used to manage asynchronous API requests.
954 "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
955 "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
956 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
957 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
958 "zone": "A String", # URL of the zone where the operation resides (output only).
959 "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
960 "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
961 "progress": 42, # 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 at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
962 "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
963 "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
964 "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
965 "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
966 "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
967 {
968 "message": "A String", # Optional human-readable details for this warning.
969 "code": "A String", # The warning type identifier for this warning.
970 "data": [ # Metadata for this warning in 'key: value' format.
971 {
972 "value": "A String", # A warning data value corresponding to the key.
973 "key": "A String", # A key for the warning data.
974 },
975 ],
976 },
977 ],
978 "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
979 "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
980 "kind": "compute#operation", # Type of the resource.
981 "name": "A String", # Name of the resource (output only).
982 "region": "A String", # URL of the region where the operation resides (output only).
983 "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
984 "errors": [ # The array of errors encountered while processing this operation.
985 {
986 "message": "A String", # An optional, human-readable error message.
987 "code": "A String", # The error type identifier for this error.
988 "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
989 },
990 ],
991 },
992 "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
993 "selfLink": "A String", # Server defined URL for the resource (output only).
994 "targetLink": "A String", # URL of the resource the operation is mutating (output only).
995 }</pre>
996</div>
997
998<div class="method">
999 <code class="details" id="setDiskAutoDelete">setDiskAutoDelete(project, zone, instance, autoDelete, deviceName)</code>
1000 <pre>Sets the auto-delete flag for a disk attached to an instance
1001
1002Args:
1003 project: string, Project name. (required)
1004 zone: string, Name of the zone scoping this request. (required)
1005 instance: string, Instance name. (required)
1006 autoDelete: boolean, Whether to auto-delete the disk when the instance is deleted. (required)
1007 deviceName: string, Disk device name to modify. (required)
1008
1009Returns:
1010 An object of the form:
1011
1012 { # An operation resource, used to manage asynchronous API requests.
1013 "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
1014 "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
1015 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
1016 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
1017 "zone": "A String", # URL of the zone where the operation resides (output only).
1018 "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
1019 "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
1020 "progress": 42, # 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 at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
1021 "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
1022 "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
1023 "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
1024 "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
1025 "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
1026 {
1027 "message": "A String", # Optional human-readable details for this warning.
1028 "code": "A String", # The warning type identifier for this warning.
1029 "data": [ # Metadata for this warning in 'key: value' format.
1030 {
1031 "value": "A String", # A warning data value corresponding to the key.
1032 "key": "A String", # A key for the warning data.
1033 },
1034 ],
1035 },
1036 ],
1037 "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
1038 "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
1039 "kind": "compute#operation", # Type of the resource.
1040 "name": "A String", # Name of the resource (output only).
1041 "region": "A String", # URL of the region where the operation resides (output only).
1042 "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
1043 "errors": [ # The array of errors encountered while processing this operation.
1044 {
1045 "message": "A String", # An optional, human-readable error message.
1046 "code": "A String", # The error type identifier for this error.
1047 "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
1048 },
1049 ],
1050 },
1051 "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
1052 "selfLink": "A String", # Server defined URL for the resource (output only).
1053 "targetLink": "A String", # URL of the resource the operation is mutating (output only).
1054 }</pre>
1055</div>
1056
1057<div class="method">
1058 <code class="details" id="setMetadata">setMetadata(project, zone, instance, body)</code>
1059 <pre>Sets metadata for the specified instance to the data included in the request.
1060
1061Args:
1062 project: string, Name of the project scoping this request. (required)
1063 zone: string, Name of the zone scoping this request. (required)
1064 instance: string, Name of the instance scoping this request. (required)
1065 body: object, The request body. (required)
1066 The object takes the form of:
1067
1068{ # A metadata key/value entry.
1069 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
1070 {
1071 "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.
1072 "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.
1073 },
1074 ],
1075 "kind": "compute#metadata", # Type of the resource.
1076 "fingerprint": "A String", # Fingerprint of this resource. A hash of the metadata's contents. This field is used for optimistic locking. An up-to-date metadata fingerprint must be provided in order to modify metadata.
1077}
1078
1079
1080Returns:
1081 An object of the form:
1082
1083 { # An operation resource, used to manage asynchronous API requests.
1084 "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
1085 "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
1086 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
1087 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
1088 "zone": "A String", # URL of the zone where the operation resides (output only).
1089 "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
1090 "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
1091 "progress": 42, # 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 at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
1092 "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
1093 "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
1094 "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
1095 "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
1096 "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
1097 {
1098 "message": "A String", # Optional human-readable details for this warning.
1099 "code": "A String", # The warning type identifier for this warning.
1100 "data": [ # Metadata for this warning in 'key: value' format.
1101 {
1102 "value": "A String", # A warning data value corresponding to the key.
1103 "key": "A String", # A key for the warning data.
1104 },
1105 ],
1106 },
1107 ],
1108 "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
1109 "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
1110 "kind": "compute#operation", # Type of the resource.
1111 "name": "A String", # Name of the resource (output only).
1112 "region": "A String", # URL of the region where the operation resides (output only).
1113 "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
1114 "errors": [ # The array of errors encountered while processing this operation.
1115 {
1116 "message": "A String", # An optional, human-readable error message.
1117 "code": "A String", # The error type identifier for this error.
1118 "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
1119 },
1120 ],
1121 },
1122 "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
1123 "selfLink": "A String", # Server defined URL for the resource (output only).
1124 "targetLink": "A String", # URL of the resource the operation is mutating (output only).
1125 }</pre>
1126</div>
1127
1128<div class="method">
1129 <code class="details" id="setScheduling">setScheduling(project, zone, instance, body)</code>
1130 <pre>Sets an instance's scheduling options.
1131
1132Args:
1133 project: string, Project name. (required)
1134 zone: string, Name of the zone scoping this request. (required)
1135 instance: string, Instance name. (required)
1136 body: object, The request body. (required)
1137 The object takes the form of:
1138
1139{ # Scheduling options for an Instance.
1140 "automaticRestart": True or False, # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user).
1141 "onHostMaintenance": "A String", # How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance.
1142}
1143
1144
1145Returns:
1146 An object of the form:
1147
1148 { # An operation resource, used to manage asynchronous API requests.
1149 "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
1150 "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
1151 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
1152 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
1153 "zone": "A String", # URL of the zone where the operation resides (output only).
1154 "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
1155 "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
1156 "progress": 42, # 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 at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
1157 "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
1158 "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
1159 "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
1160 "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
1161 "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
1162 {
1163 "message": "A String", # Optional human-readable details for this warning.
1164 "code": "A String", # The warning type identifier for this warning.
1165 "data": [ # Metadata for this warning in 'key: value' format.
1166 {
1167 "value": "A String", # A warning data value corresponding to the key.
1168 "key": "A String", # A key for the warning data.
1169 },
1170 ],
1171 },
1172 ],
1173 "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
1174 "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
1175 "kind": "compute#operation", # Type of the resource.
1176 "name": "A String", # Name of the resource (output only).
1177 "region": "A String", # URL of the region where the operation resides (output only).
1178 "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
1179 "errors": [ # The array of errors encountered while processing this operation.
1180 {
1181 "message": "A String", # An optional, human-readable error message.
1182 "code": "A String", # The error type identifier for this error.
1183 "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
1184 },
1185 ],
1186 },
1187 "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
1188 "selfLink": "A String", # Server defined URL for the resource (output only).
1189 "targetLink": "A String", # URL of the resource the operation is mutating (output only).
1190 }</pre>
1191</div>
1192
1193<div class="method">
1194 <code class="details" id="setTags">setTags(project, zone, instance, body)</code>
1195 <pre>Sets tags for the specified instance to the data included in the request.
1196
1197Args:
1198 project: string, Name of the project scoping this request. (required)
1199 zone: string, Name of the zone scoping this request. (required)
1200 instance: string, Name of the instance scoping this request. (required)
1201 body: object, The request body. (required)
1202 The object takes the form of:
1203
1204{ # A set of instance tags.
1205 "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
1206 "A String",
1207 ],
1208 "fingerprint": "A String", # Fingerprint of this resource. A hash of the tags stored in this object. This field is used optimistic locking. An up-to-date tags fingerprint must be provided in order to modify tags.
1209 }
1210
1211
1212Returns:
1213 An object of the form:
1214
1215 { # An operation resource, used to manage asynchronous API requests.
1216 "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
1217 "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
1218 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
1219 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
1220 "zone": "A String", # URL of the zone where the operation resides (output only).
1221 "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
1222 "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
1223 "progress": 42, # 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 at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
1224 "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
1225 "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
1226 "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
1227 "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
1228 "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
1229 {
1230 "message": "A String", # Optional human-readable details for this warning.
1231 "code": "A String", # The warning type identifier for this warning.
1232 "data": [ # Metadata for this warning in 'key: value' format.
1233 {
1234 "value": "A String", # A warning data value corresponding to the key.
1235 "key": "A String", # A key for the warning data.
1236 },
1237 ],
1238 },
1239 ],
1240 "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
1241 "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
1242 "kind": "compute#operation", # Type of the resource.
1243 "name": "A String", # Name of the resource (output only).
1244 "region": "A String", # URL of the region where the operation resides (output only).
1245 "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
1246 "errors": [ # The array of errors encountered while processing this operation.
1247 {
1248 "message": "A String", # An optional, human-readable error message.
1249 "code": "A String", # The error type identifier for this error.
1250 "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
1251 },
1252 ],
1253 },
1254 "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
1255 "selfLink": "A String", # Server defined URL for the resource (output only).
1256 "targetLink": "A String", # URL of the resource the operation is mutating (output only).
1257 }</pre>
1258</div>
1259
1260</body></html>