Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / e912d185eef03392f095881d407c0c78f7633d5e / . / docs / dyn / compute_v1beta14.instances.html
blob: 9542441c3fc7d4f03580cc11599bb44abbe01f8f [file] [log] [blame]
Joe Gregoriob8006ce2013-03-07 10:33:19 -0500[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="compute_v1beta14.html">Compute Engine API</a> . <a href="compute_v1beta14.instances.html">instances</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#addAccessConfig">addAccessConfig(project, zone, instance, network_interface, 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="#attachDisk">attachDisk(project, zone, instance, body)</a></code></p>
82<p class="firstline">Attaches a disk resource to an instance.</p>
83<p class="toc_element">
84 <code><a href="#delete">delete(project, zone, instance)</a></code></p>
85<p class="firstline">Deletes the specified instance resource.</p>
86<p class="toc_element">
87 <code><a href="#deleteAccessConfig">deleteAccessConfig(project, zone, instance, access_config, network_interface)</a></code></p>
88<p class="firstline">Deletes an access config from an instance's network interface.</p>
89<p class="toc_element">
90 <code><a href="#detachDisk">detachDisk(project, zone, instance, deviceName)</a></code></p>
91<p class="firstline">Detaches a disk from an instance.</p>
92<p class="toc_element">
93 <code><a href="#get">get(project, zone, instance)</a></code></p>
94<p class="firstline">Returns the specified instance resource.</p>
95<p class="toc_element">
96 <code><a href="#getSerialPortOutput">getSerialPortOutput(project, zone, instance)</a></code></p>
97<p class="firstline">Returns the specified instance's serial port output.</p>
98<p class="toc_element">
99 <code><a href="#insert">insert(project, zone, body)</a></code></p>
100<p class="firstline">Creates an instance resource in the specified project using the data included in the request.</p>
101<p class="toc_element">
102 <code><a href="#list">list(project, zone, maxResults=None, pageToken=None, filter=None)</a></code></p>
103<p class="firstline">Retrieves the list of instance resources contained within the specified zone.</p>
104<p class="toc_element">
105 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
106<p class="firstline">Retrieves the next page of results.</p>
107<p class="toc_element">
108 <code><a href="#setMetadata">setMetadata(project, zone, instance, body)</a></code></p>
109<p class="firstline">Sets metadata for the specified instance to the data included in the request.</p>
110<p class="toc_element">
111 <code><a href="#setTags">setTags(project, zone, instance, body)</a></code></p>
112<p class="firstline">Sets tags for the specified instance to the data included in the request.</p>
113<h3>Method Details</h3>
114<div class="method">
115 <code class="details" id="addAccessConfig">addAccessConfig(project, zone, instance, network_interface, body)</code>
116 <pre>Adds an access config to an instance's network interface.
117
118Args:
119 project: string, Project name. (required)
120 zone: string, Name of the zone scoping this request. (required)
121 instance: string, Instance name. (required)
122 network_interface: string, Network interface name. (required)
123 body: object, The request body. (required)
124 The object takes the form of:
125
126{ # An access configuration attached to an instance's network interface.
127 "kind": "compute#accessConfig", # Type of the resource.
128 "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.
129 "name": "A String", # Name of this access configuration.
130 "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.
131}
132
133
134Returns:
135 An object of the form:
136
137 { # An operation resource, used to manage asynchronous API requests.
138 "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
139 "kind": "compute#operation", # Type of the resource.
140 "name": "A String", # Name of the resource (output only).
141 "zone": "A String", # URL of the zone where the operation resides (output only).
142 "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
143 {
144 "message": "A String", # Optional human-readable details for this warning.
145 "code": "A String", # The warning type identifier for this warning.
146 "data": [ # Metadata for this warning in 'key: value' format.
147 {
148 "value": "A String", # A warning data value corresponding to the key.
149 "key": "A String", # A key for the warning data.
150 },
151 ],
152 },
153 ],
154 "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
155 "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
156 "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
157 "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
158 "errors": [ # The array of errors encountered while processing this operation.
159 {
160 "message": "A String", # An optional, human-readable error message.
161 "code": "A String", # The error type identifier for this error.
162 "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
163 },
164 ],
165 },
166 "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
167 "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
168 "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
169 "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
170 "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
171 "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).
172 "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).
173 "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
174 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
175 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
176 "selfLink": "A String", # Server defined URL for the resource (output only).
177 "targetLink": "A String", # URL of the resource the operation is mutating (output only).
178 }</pre>
179</div>
180
181<div class="method">
182 <code class="details" id="attachDisk">attachDisk(project, zone, instance, body)</code>
183 <pre>Attaches a disk resource to an instance.
184
185Args:
186 project: string, Project name. (required)
187 zone: string, Name of the zone scoping this request. (required)
188 instance: string, Instance name. (required)
189 body: object, The request body. (required)
190 The object takes the form of:
191
192{ # An instance-attached disk resource.
193 "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.
194 "kind": "compute#attachedDisk", # Type of the resource.
195 "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.
196 "boot": True or False, # Indicates that this is a boot disk. VM will use the first partition of the disk for its root filesystem.
197 "source": "A String", # Persistent disk only; the URL of the persistent disk resource.
198 "mode": "A String", # The mode in which to attach this disk, either "READ_WRITE" or "READ_ONLY".
199 "type": "A String", # Type of the disk, either "EPHEMERAL" or "PERSISTENT". Note that persistent disks must be created before you can specify them here.
200 }
201
202
203Returns:
204 An object of the form:
205
206 { # An operation resource, used to manage asynchronous API requests.
207 "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
208 "kind": "compute#operation", # Type of the resource.
209 "name": "A String", # Name of the resource (output only).
210 "zone": "A String", # URL of the zone where the operation resides (output only).
211 "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
212 {
213 "message": "A String", # Optional human-readable details for this warning.
214 "code": "A String", # The warning type identifier for this warning.
215 "data": [ # Metadata for this warning in 'key: value' format.
216 {
217 "value": "A String", # A warning data value corresponding to the key.
218 "key": "A String", # A key for the warning data.
219 },
220 ],
221 },
222 ],
223 "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
224 "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
225 "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
226 "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
227 "errors": [ # The array of errors encountered while processing this operation.
228 {
229 "message": "A String", # An optional, human-readable error message.
230 "code": "A String", # The error type identifier for this error.
231 "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
232 },
233 ],
234 },
235 "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
236 "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
237 "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
238 "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
239 "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
240 "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).
241 "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).
242 "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
243 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
244 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
245 "selfLink": "A String", # Server defined URL for the resource (output only).
246 "targetLink": "A String", # URL of the resource the operation is mutating (output only).
247 }</pre>
248</div>
249
250<div class="method">
251 <code class="details" id="delete">delete(project, zone, instance)</code>
252 <pre>Deletes the specified instance resource.
253
254Args:
255 project: string, Name of the project scoping this request. (required)
256 zone: string, Name of the zone scoping this request. (required)
257 instance: string, Name of the instance resource to delete. (required)
258
259Returns:
260 An object of the form:
261
262 { # An operation resource, used to manage asynchronous API requests.
263 "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
264 "kind": "compute#operation", # Type of the resource.
265 "name": "A String", # Name of the resource (output only).
266 "zone": "A String", # URL of the zone where the operation resides (output only).
267 "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
268 {
269 "message": "A String", # Optional human-readable details for this warning.
270 "code": "A String", # The warning type identifier for this warning.
271 "data": [ # Metadata for this warning in 'key: value' format.
272 {
273 "value": "A String", # A warning data value corresponding to the key.
274 "key": "A String", # A key for the warning data.
275 },
276 ],
277 },
278 ],
279 "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
280 "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
281 "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
282 "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
283 "errors": [ # The array of errors encountered while processing this operation.
284 {
285 "message": "A String", # An optional, human-readable error message.
286 "code": "A String", # The error type identifier for this error.
287 "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
288 },
289 ],
290 },
291 "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
292 "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
293 "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
294 "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
295 "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
296 "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).
297 "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).
298 "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
299 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
300 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
301 "selfLink": "A String", # Server defined URL for the resource (output only).
302 "targetLink": "A String", # URL of the resource the operation is mutating (output only).
303 }</pre>
304</div>
305
306<div class="method">
307 <code class="details" id="deleteAccessConfig">deleteAccessConfig(project, zone, instance, access_config, network_interface)</code>
308 <pre>Deletes an access config from an instance's network interface.
309
310Args:
311 project: string, Project name. (required)
312 zone: string, Name of the zone scoping this request. (required)
313 instance: string, Instance name. (required)
314 access_config: string, Access config name. (required)
315 network_interface: string, Network interface name. (required)
316
317Returns:
318 An object of the form:
319
320 { # An operation resource, used to manage asynchronous API requests.
321 "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
322 "kind": "compute#operation", # Type of the resource.
323 "name": "A String", # Name of the resource (output only).
324 "zone": "A String", # URL of the zone where the operation resides (output only).
325 "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
326 {
327 "message": "A String", # Optional human-readable details for this warning.
328 "code": "A String", # The warning type identifier for this warning.
329 "data": [ # Metadata for this warning in 'key: value' format.
330 {
331 "value": "A String", # A warning data value corresponding to the key.
332 "key": "A String", # A key for the warning data.
333 },
334 ],
335 },
336 ],
337 "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
338 "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
339 "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
340 "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
341 "errors": [ # The array of errors encountered while processing this operation.
342 {
343 "message": "A String", # An optional, human-readable error message.
344 "code": "A String", # The error type identifier for this error.
345 "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
346 },
347 ],
348 },
349 "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
350 "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
351 "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
352 "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
353 "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
354 "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).
355 "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).
356 "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
357 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
358 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
359 "selfLink": "A String", # Server defined URL for the resource (output only).
360 "targetLink": "A String", # URL of the resource the operation is mutating (output only).
361 }</pre>
362</div>
363
364<div class="method">
365 <code class="details" id="detachDisk">detachDisk(project, zone, instance, deviceName)</code>
366 <pre>Detaches a disk from an instance.
367
368Args:
369 project: string, Project name. (required)
370 zone: string, Name of the zone scoping this request. (required)
371 instance: string, Instance name. (required)
372 deviceName: string, Disk device name to detach. (required)
373
374Returns:
375 An object of the form:
376
377 { # An operation resource, used to manage asynchronous API requests.
378 "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
379 "kind": "compute#operation", # Type of the resource.
380 "name": "A String", # Name of the resource (output only).
381 "zone": "A String", # URL of the zone where the operation resides (output only).
382 "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
383 {
384 "message": "A String", # Optional human-readable details for this warning.
385 "code": "A String", # The warning type identifier for this warning.
386 "data": [ # Metadata for this warning in 'key: value' format.
387 {
388 "value": "A String", # A warning data value corresponding to the key.
389 "key": "A String", # A key for the warning data.
390 },
391 ],
392 },
393 ],
394 "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
395 "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
396 "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
397 "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
398 "errors": [ # The array of errors encountered while processing this operation.
399 {
400 "message": "A String", # An optional, human-readable error message.
401 "code": "A String", # The error type identifier for this error.
402 "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
403 },
404 ],
405 },
406 "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
407 "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
408 "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
409 "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
410 "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
411 "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).
412 "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).
413 "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
414 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
415 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
416 "selfLink": "A String", # Server defined URL for the resource (output only).
417 "targetLink": "A String", # URL of the resource the operation is mutating (output only).
418 }</pre>
419</div>
420
421<div class="method">
422 <code class="details" id="get">get(project, zone, instance)</code>
423 <pre>Returns the specified instance resource.
424
425Args:
426 project: string, Name of the project scoping this request. (required)
427 zone: string, Name of the zone scoping this request. (required)
428 instance: string, Name of the instance resource to return. (required)
429
430Returns:
431 An object of the form:
432
433 { # An instance resource.
434 "status": "A String", # Instance status. One of the following values: "PROVISIONING", "STAGING", "RUNNING", "STOPPING", "STOPPED", "TERMINATED" (output only).
435 "kernel": "A String", # URL of the kernel resource to use when booting. In case of booting from persistent disk, this parameter is required. When booting from a disk image, it is optional, but may be provided to use a different kernel than the one associated with the image.
436 "kind": "compute#instance", # Type of the resource.
437 "canIpForward": True or False, # Reserved for future use.
438 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
439 "zone": "A String", # URL of the zone where the instance resides (output only).
440 "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.
441 "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
442 "A String",
443 ],
444 "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.
445 },
446 "image": "A String", # An optional URL of the disk image resource to be installed on this instance; provided by the client when the instance is created. Alternatively to passing the image, the client may choose to boot from a persistent disk, by setting boot=true flag on one of the entries in disks[] collection.
447 "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
448 { # An instance-attached disk resource.
449 "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.
450 "kind": "compute#attachedDisk", # Type of the resource.
451 "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.
452 "boot": True or False, # Indicates that this is a boot disk. VM will use the first partition of the disk for its root filesystem.
453 "source": "A String", # Persistent disk only; the URL of the persistent disk resource.
454 "mode": "A String", # The mode in which to attach this disk, either "READ_WRITE" or "READ_ONLY".
455 "type": "A String", # Type of the disk, either "EPHEMERAL" or "PERSISTENT". Note that persistent disks must be created before you can specify them here.
456 },
457 ],
458 "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.
459 "statusMessage": "A String", # An optional, human-readable explanation of the status (output only).
460 "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.
461 "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.
462 { # A service account.
463 "scopes": [ # The list of scopes to be made available for this service account.
464 "A String",
465 ],
466 "email": "A String", # Email address of the service account.
467 },
468 ],
469 "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.
470 { # A network interface resource attached to an instance.
471 "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.
472 { # An access configuration attached to an instance's network interface.
473 "kind": "compute#accessConfig", # Type of the resource.
474 "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.
475 "name": "A String", # Name of this access configuration.
476 "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.
477 },
478 ],
479 "networkIP": "A String", # An optional IPV4 internal network address to assign to the instance for this network interface. If not specified, one will be assigned from the available range.
480 "name": "A String", # Name of the network interface, determined by the server; for network devices, these are e.g. eth0, eth1, etc. (output only).
481 "network": "A String", # URL of the network resource attached to this interface.
482 },
483 ],
484 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
485 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
486 "selfLink": "A String", # Server defined URL for the resource (output only).
487 "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.
488 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
489 {
490 "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.
491 "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.
492 },
493 ],
494 "kind": "compute#metadata", # Type of the resource.
495 "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.
496 },
497 }</pre>
498</div>
499
500<div class="method">
501 <code class="details" id="getSerialPortOutput">getSerialPortOutput(project, zone, instance)</code>
502 <pre>Returns the specified instance's serial port output.
503
504Args:
505 project: string, Name of the project scoping this request. (required)
506 zone: string, Name of the zone scoping this request. (required)
507 instance: string, Name of the instance scoping this request. (required)
508
509Returns:
510 An object of the form:
511
512 { # An instance serial console output.
513 "kind": "compute#serialPortOutput", # Type of the resource.
514 "selfLink": "A String", # Server defined URL for the resource (output only).
515 "contents": "A String", # The contents of the console output.
516 }</pre>
517</div>
518
519<div class="method">
520 <code class="details" id="insert">insert(project, zone, body)</code>
521 <pre>Creates an instance resource in the specified project using the data included in the request.
522
523Args:
524 project: string, Name of the project scoping this request. (required)
525 zone: string, Name of the zone scoping this request. (required)
526 body: object, The request body. (required)
527 The object takes the form of:
528
529{ # An instance resource.
530 "status": "A String", # Instance status. One of the following values: "PROVISIONING", "STAGING", "RUNNING", "STOPPING", "STOPPED", "TERMINATED" (output only).
531 "kernel": "A String", # URL of the kernel resource to use when booting. In case of booting from persistent disk, this parameter is required. When booting from a disk image, it is optional, but may be provided to use a different kernel than the one associated with the image.
532 "kind": "compute#instance", # Type of the resource.
533 "canIpForward": True or False, # Reserved for future use.
534 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
535 "zone": "A String", # URL of the zone where the instance resides (output only).
536 "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.
537 "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
538 "A String",
539 ],
540 "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.
541 },
542 "image": "A String", # An optional URL of the disk image resource to be installed on this instance; provided by the client when the instance is created. Alternatively to passing the image, the client may choose to boot from a persistent disk, by setting boot=true flag on one of the entries in disks[] collection.
543 "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
544 { # An instance-attached disk resource.
545 "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.
546 "kind": "compute#attachedDisk", # Type of the resource.
547 "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.
548 "boot": True or False, # Indicates that this is a boot disk. VM will use the first partition of the disk for its root filesystem.
549 "source": "A String", # Persistent disk only; the URL of the persistent disk resource.
550 "mode": "A String", # The mode in which to attach this disk, either "READ_WRITE" or "READ_ONLY".
551 "type": "A String", # Type of the disk, either "EPHEMERAL" or "PERSISTENT". Note that persistent disks must be created before you can specify them here.
552 },
553 ],
554 "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.
555 "statusMessage": "A String", # An optional, human-readable explanation of the status (output only).
556 "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.
557 "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.
558 { # A service account.
559 "scopes": [ # The list of scopes to be made available for this service account.
560 "A String",
561 ],
562 "email": "A String", # Email address of the service account.
563 },
564 ],
565 "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.
566 { # A network interface resource attached to an instance.
567 "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.
568 { # An access configuration attached to an instance's network interface.
569 "kind": "compute#accessConfig", # Type of the resource.
570 "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.
571 "name": "A String", # Name of this access configuration.
572 "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.
573 },
574 ],
575 "networkIP": "A String", # An optional IPV4 internal network address to assign to the instance for this network interface. If not specified, one will be assigned from the available range.
576 "name": "A String", # Name of the network interface, determined by the server; for network devices, these are e.g. eth0, eth1, etc. (output only).
577 "network": "A String", # URL of the network resource attached to this interface.
578 },
579 ],
580 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
581 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
582 "selfLink": "A String", # Server defined URL for the resource (output only).
583 "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.
584 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
585 {
586 "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.
587 "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.
588 },
589 ],
590 "kind": "compute#metadata", # Type of the resource.
591 "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.
592 },
593}
594
595
596Returns:
597 An object of the form:
598
599 { # An operation resource, used to manage asynchronous API requests.
600 "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
601 "kind": "compute#operation", # Type of the resource.
602 "name": "A String", # Name of the resource (output only).
603 "zone": "A String", # URL of the zone where the operation resides (output only).
604 "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
605 {
606 "message": "A String", # Optional human-readable details for this warning.
607 "code": "A String", # The warning type identifier for this warning.
608 "data": [ # Metadata for this warning in 'key: value' format.
609 {
610 "value": "A String", # A warning data value corresponding to the key.
611 "key": "A String", # A key for the warning data.
612 },
613 ],
614 },
615 ],
616 "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
617 "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
618 "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
619 "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
620 "errors": [ # The array of errors encountered while processing this operation.
621 {
622 "message": "A String", # An optional, human-readable error message.
623 "code": "A String", # The error type identifier for this error.
624 "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
625 },
626 ],
627 },
628 "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
629 "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
630 "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
631 "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
632 "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
633 "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).
634 "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).
635 "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
636 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
637 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
638 "selfLink": "A String", # Server defined URL for the resource (output only).
639 "targetLink": "A String", # URL of the resource the operation is mutating (output only).
640 }</pre>
641</div>
642
643<div class="method">
644 <code class="details" id="list">list(project, zone, maxResults=None, pageToken=None, filter=None)</code>
645 <pre>Retrieves the list of instance resources contained within the specified zone.
646
647Args:
648 project: string, Name of the project scoping this request. (required)
649 zone: string, Name of the zone scoping this request. (required)
650 maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
651 pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
652 filter: string, Optional. Filter expression for filtering listed resources.
653
654Returns:
655 An object of the form:
656
657 { # Contains a list of instance resources.
658 "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
659 "items": [ # A list of instance resources.
660 { # An instance resource.
661 "status": "A String", # Instance status. One of the following values: "PROVISIONING", "STAGING", "RUNNING", "STOPPING", "STOPPED", "TERMINATED" (output only).
662 "kernel": "A String", # URL of the kernel resource to use when booting. In case of booting from persistent disk, this parameter is required. When booting from a disk image, it is optional, but may be provided to use a different kernel than the one associated with the image.
663 "kind": "compute#instance", # Type of the resource.
664 "canIpForward": True or False, # Reserved for future use.
665 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
666 "zone": "A String", # URL of the zone where the instance resides (output only).
667 "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.
668 "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
669 "A String",
670 ],
671 "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.
672 },
673 "image": "A String", # An optional URL of the disk image resource to be installed on this instance; provided by the client when the instance is created. Alternatively to passing the image, the client may choose to boot from a persistent disk, by setting boot=true flag on one of the entries in disks[] collection.
674 "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
675 { # An instance-attached disk resource.
676 "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.
677 "kind": "compute#attachedDisk", # Type of the resource.
678 "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.
679 "boot": True or False, # Indicates that this is a boot disk. VM will use the first partition of the disk for its root filesystem.
680 "source": "A String", # Persistent disk only; the URL of the persistent disk resource.
681 "mode": "A String", # The mode in which to attach this disk, either "READ_WRITE" or "READ_ONLY".
682 "type": "A String", # Type of the disk, either "EPHEMERAL" or "PERSISTENT". Note that persistent disks must be created before you can specify them here.
683 },
684 ],
685 "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.
686 "statusMessage": "A String", # An optional, human-readable explanation of the status (output only).
687 "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.
688 "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.
689 { # A service account.
690 "scopes": [ # The list of scopes to be made available for this service account.
691 "A String",
692 ],
693 "email": "A String", # Email address of the service account.
694 },
695 ],
696 "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.
697 { # A network interface resource attached to an instance.
698 "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.
699 { # An access configuration attached to an instance's network interface.
700 "kind": "compute#accessConfig", # Type of the resource.
701 "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.
702 "name": "A String", # Name of this access configuration.
703 "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.
704 },
705 ],
706 "networkIP": "A String", # An optional IPV4 internal network address to assign to the instance for this network interface. If not specified, one will be assigned from the available range.
707 "name": "A String", # Name of the network interface, determined by the server; for network devices, these are e.g. eth0, eth1, etc. (output only).
708 "network": "A String", # URL of the network resource attached to this interface.
709 },
710 ],
711 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
712 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
713 "selfLink": "A String", # Server defined URL for the resource (output only).
714 "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.
715 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
716 {
717 "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.
718 "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.
719 },
720 ],
721 "kind": "compute#metadata", # Type of the resource.
722 "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.
723 },
724 },
725 ],
726 "kind": "compute#instanceList", # Type of resource.
727 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
728 "selfLink": "A String", # Server defined URL for this resource (output only).
729 }</pre>
730</div>
731
732<div class="method">
733 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
734 <pre>Retrieves the next page of results.
735
736Args:
737 previous_request: The request for the previous page. (required)
738 previous_response: The response from the request for the previous page. (required)
739
740Returns:
741 A request object that you can call 'execute()' on to request the next
742 page. Returns None if there are no more items in the collection.
743 </pre>
744</div>
745
746<div class="method">
747 <code class="details" id="setMetadata">setMetadata(project, zone, instance, body)</code>
748 <pre>Sets metadata for the specified instance to the data included in the request.
749
750Args:
751 project: string, Name of the project scoping this request. (required)
752 zone: string, Name of the zone scoping this request. (required)
753 instance: string, Name of the instance scoping this request. (required)
754 body: object, The request body. (required)
755 The object takes the form of:
756
757{ # A metadata key/value entry.
758 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
759 {
760 "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.
761 "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.
762 },
763 ],
764 "kind": "compute#metadata", # Type of the resource.
765 "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.
766}
767
768
769Returns:
770 An object of the form:
771
772 { # An operation resource, used to manage asynchronous API requests.
773 "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
774 "kind": "compute#operation", # Type of the resource.
775 "name": "A String", # Name of the resource (output only).
776 "zone": "A String", # URL of the zone where the operation resides (output only).
777 "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
778 {
779 "message": "A String", # Optional human-readable details for this warning.
780 "code": "A String", # The warning type identifier for this warning.
781 "data": [ # Metadata for this warning in 'key: value' format.
782 {
783 "value": "A String", # A warning data value corresponding to the key.
784 "key": "A String", # A key for the warning data.
785 },
786 ],
787 },
788 ],
789 "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
790 "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
791 "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
792 "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
793 "errors": [ # The array of errors encountered while processing this operation.
794 {
795 "message": "A String", # An optional, human-readable error message.
796 "code": "A String", # The error type identifier for this error.
797 "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
798 },
799 ],
800 },
801 "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
802 "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
803 "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
804 "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
805 "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
806 "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).
807 "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).
808 "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
809 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
810 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
811 "selfLink": "A String", # Server defined URL for the resource (output only).
812 "targetLink": "A String", # URL of the resource the operation is mutating (output only).
813 }</pre>
814</div>
815
816<div class="method">
817 <code class="details" id="setTags">setTags(project, zone, instance, body)</code>
818 <pre>Sets tags for the specified instance to the data included in the request.
819
820Args:
821 project: string, Name of the project scoping this request. (required)
822 zone: string, Name of the zone scoping this request. (required)
823 instance: string, Name of the instance scoping this request. (required)
824 body: object, The request body. (required)
825 The object takes the form of:
826
827{ # A set of instance tags.
828 "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
829 "A String",
830 ],
831 "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.
832 }
833
834
835Returns:
836 An object of the form:
837
838 { # An operation resource, used to manage asynchronous API requests.
839 "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
840 "kind": "compute#operation", # Type of the resource.
841 "name": "A String", # Name of the resource (output only).
842 "zone": "A String", # URL of the zone where the operation resides (output only).
843 "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
844 {
845 "message": "A String", # Optional human-readable details for this warning.
846 "code": "A String", # The warning type identifier for this warning.
847 "data": [ # Metadata for this warning in 'key: value' format.
848 {
849 "value": "A String", # A warning data value corresponding to the key.
850 "key": "A String", # A key for the warning data.
851 },
852 ],
853 },
854 ],
855 "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
856 "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
857 "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
858 "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
859 "errors": [ # The array of errors encountered while processing this operation.
860 {
861 "message": "A String", # An optional, human-readable error message.
862 "code": "A String", # The error type identifier for this error.
863 "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
864 },
865 ],
866 },
867 "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
868 "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
869 "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
870 "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
871 "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
872 "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).
873 "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).
874 "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
875 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
876 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
877 "selfLink": "A String", # Server defined URL for the resource (output only).
878 "targetLink": "A String", # URL of the resource the operation is mutating (output only).
879 }</pre>
880</div>
881
882</body></html>