Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 614db98bf45b9da1f29c35a9d942536111e99d41 / . / docs / dyn / compute_v1.images.html
blob: 31674e34a1c558d5e675cdaf5909123b349bcbd6 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[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_v1.html">Compute Engine API</a> . <a href="compute_v1.images.html">images</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(project, image)</a></code></p>
79<p class="firstline">Deletes the specified image resource.</p>
80<p class="toc_element">
81 <code><a href="#deprecate">deprecate(project, image, body)</a></code></p>
82<p class="firstline">Sets the deprecation status of an image. If no message body is given, clears the deprecation status instead.</p>
83<p class="toc_element">
84 <code><a href="#get">get(project, image)</a></code></p>
85<p class="firstline">Returns the specified image resource.</p>
86<p class="toc_element">
87 <code><a href="#insert">insert(project, body)</a></code></p>
88<p class="firstline">Creates an image resource in the specified project using the data included in the request.</p>
89<p class="toc_element">
90 <code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
91<p class="firstline">Retrieves the list of image resources available to the specified project.</p>
92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<h3>Method Details</h3>
96<div class="method">
97 <code class="details" id="delete">delete(project, image)</code>
98 <pre>Deletes the specified image resource.
99
100Args:
101 project: string, Name of the project scoping this request. (required)
102 image: string, Name of the image resource to delete. (required)
103
104Returns:
105 An object of the form:
106
107 { # An operation resource, used to manage asynchronous API requests.
108 "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
109 "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).
110 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
111 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
112 "zone": "A String", # URL of the zone where the operation resides (output only).
113 "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
114 "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
115 "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).
116 "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
117 "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
118 "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
119 "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
120 "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
121 {
122 "message": "A String", # Optional human-readable details for this warning.
123 "code": "A String", # The warning type identifier for this warning.
124 "data": [ # Metadata for this warning in 'key: value' format.
125 {
126 "value": "A String", # A warning data value corresponding to the key.
127 "key": "A String", # A key for the warning data.
128 },
129 ],
130 },
131 ],
132 "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
133 "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
134 "kind": "compute#operation", # Type of the resource.
135 "name": "A String", # Name of the resource (output only).
136 "region": "A String", # URL of the region where the operation resides (output only).
137 "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
138 "errors": [ # The array of errors encountered while processing this operation.
139 {
140 "message": "A String", # An optional, human-readable error message.
141 "code": "A String", # The error type identifier for this error.
142 "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
143 },
144 ],
145 },
146 "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
147 "selfLink": "A String", # Server defined URL for the resource (output only).
148 "targetLink": "A String", # URL of the resource the operation is mutating (output only).
149 }</pre>
150</div>
151
152<div class="method">
153 <code class="details" id="deprecate">deprecate(project, image, body)</code>
154 <pre>Sets the deprecation status of an image. If no message body is given, clears the deprecation status instead.
155
156Args:
157 project: string, Name of the project scoping this request. (required)
158 image: string, Image name. (required)
159 body: object, The request body. (required)
160 The object takes the form of:
161
162{ # Deprecation status for a public resource.
163 "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
164 "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
165 "state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
166 "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
167 "replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
168}
169
170
171Returns:
172 An object of the form:
173
174 { # An operation resource, used to manage asynchronous API requests.
175 "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
176 "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).
177 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
178 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
179 "zone": "A String", # URL of the zone where the operation resides (output only).
180 "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
181 "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
182 "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).
183 "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
184 "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
185 "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
186 "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
187 "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
188 {
189 "message": "A String", # Optional human-readable details for this warning.
190 "code": "A String", # The warning type identifier for this warning.
191 "data": [ # Metadata for this warning in 'key: value' format.
192 {
193 "value": "A String", # A warning data value corresponding to the key.
194 "key": "A String", # A key for the warning data.
195 },
196 ],
197 },
198 ],
199 "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
200 "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
201 "kind": "compute#operation", # Type of the resource.
202 "name": "A String", # Name of the resource (output only).
203 "region": "A String", # URL of the region where the operation resides (output only).
204 "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
205 "errors": [ # The array of errors encountered while processing this operation.
206 {
207 "message": "A String", # An optional, human-readable error message.
208 "code": "A String", # The error type identifier for this error.
209 "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
210 },
211 ],
212 },
213 "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
214 "selfLink": "A String", # Server defined URL for the resource (output only).
215 "targetLink": "A String", # URL of the resource the operation is mutating (output only).
216 }</pre>
217</div>
218
219<div class="method">
220 <code class="details" id="get">get(project, image)</code>
221 <pre>Returns the specified image resource.
222
223Args:
224 project: string, Name of the project scoping this request. (required)
225 image: string, Name of the image resource to return. (required)
226
227Returns:
228 An object of the form:
229
230 { # A disk image resource.
231 "status": "A String", # Status of the image (output only). It will be one of the following READY - after image has been successfully created and is ready for use FAILED - if creating the image fails for some reason PENDING - the image creation is in progress An image can be used to create other resources suck as instances only after the image has been successfully created and the status is set to READY.
232 "kind": "compute#image", # Type of the resource.
233 "description": "A String", # Textual description of the resource; provided by the client when the resource is created.
234 "rawDisk": { # The raw disk image parameters.
235 "containerType": "TAR", # The format used to encode and transmit the block device. Should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.
236 "source": "A String", # The full Google Cloud Storage URL where the disk image is stored; provided by the client when the disk image is created.
237 "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
238 },
239 "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this image.
240 "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
241 "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
242 "state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
243 "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
244 "replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
245 },
246 "archiveSizeBytes": "A String", # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
247 "sourceType": "RAW", # Must be "RAW"; provided by the client when the disk image is created.
248 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
249 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
250 "selfLink": "A String", # Server defined URL for the resource (output only).
251 "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.
252 }</pre>
253</div>
254
255<div class="method">
256 <code class="details" id="insert">insert(project, body)</code>
257 <pre>Creates an image resource in the specified project using the data included in the request.
258
259Args:
260 project: string, Name of the project scoping this request. (required)
261 body: object, The request body. (required)
262 The object takes the form of:
263
264{ # A disk image resource.
265 "status": "A String", # Status of the image (output only). It will be one of the following READY - after image has been successfully created and is ready for use FAILED - if creating the image fails for some reason PENDING - the image creation is in progress An image can be used to create other resources suck as instances only after the image has been successfully created and the status is set to READY.
266 "kind": "compute#image", # Type of the resource.
267 "description": "A String", # Textual description of the resource; provided by the client when the resource is created.
268 "rawDisk": { # The raw disk image parameters.
269 "containerType": "TAR", # The format used to encode and transmit the block device. Should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.
270 "source": "A String", # The full Google Cloud Storage URL where the disk image is stored; provided by the client when the disk image is created.
271 "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
272 },
273 "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this image.
274 "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
275 "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
276 "state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
277 "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
278 "replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
279 },
280 "archiveSizeBytes": "A String", # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
281 "sourceType": "RAW", # Must be "RAW"; provided by the client when the disk image is created.
282 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
283 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
284 "selfLink": "A String", # Server defined URL for the resource (output only).
285 "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.
286 }
287
288
289Returns:
290 An object of the form:
291
292 { # An operation resource, used to manage asynchronous API requests.
293 "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
294 "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).
295 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
296 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
297 "zone": "A String", # URL of the zone where the operation resides (output only).
298 "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
299 "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
300 "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).
301 "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
302 "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
303 "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
304 "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
305 "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
306 {
307 "message": "A String", # Optional human-readable details for this warning.
308 "code": "A String", # The warning type identifier for this warning.
309 "data": [ # Metadata for this warning in 'key: value' format.
310 {
311 "value": "A String", # A warning data value corresponding to the key.
312 "key": "A String", # A key for the warning data.
313 },
314 ],
315 },
316 ],
317 "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
318 "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
319 "kind": "compute#operation", # Type of the resource.
320 "name": "A String", # Name of the resource (output only).
321 "region": "A String", # URL of the region where the operation resides (output only).
322 "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
323 "errors": [ # The array of errors encountered while processing this operation.
324 {
325 "message": "A String", # An optional, human-readable error message.
326 "code": "A String", # The error type identifier for this error.
327 "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
328 },
329 ],
330 },
331 "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
332 "selfLink": "A String", # Server defined URL for the resource (output only).
333 "targetLink": "A String", # URL of the resource the operation is mutating (output only).
334 }</pre>
335</div>
336
337<div class="method">
338 <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
339 <pre>Retrieves the list of image resources available to the specified project.
340
341Args:
342 project: string, Name of the project scoping this request. (required)
343 maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
344 pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
345 filter: string, Optional. Filter expression for filtering listed resources.
346
347Returns:
348 An object of the form:
349
350 { # Contains a list of disk image resources.
351 "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
352 "items": [ # The disk image resources.
353 { # A disk image resource.
354 "status": "A String", # Status of the image (output only). It will be one of the following READY - after image has been successfully created and is ready for use FAILED - if creating the image fails for some reason PENDING - the image creation is in progress An image can be used to create other resources suck as instances only after the image has been successfully created and the status is set to READY.
355 "kind": "compute#image", # Type of the resource.
356 "description": "A String", # Textual description of the resource; provided by the client when the resource is created.
357 "rawDisk": { # The raw disk image parameters.
358 "containerType": "TAR", # The format used to encode and transmit the block device. Should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.
359 "source": "A String", # The full Google Cloud Storage URL where the disk image is stored; provided by the client when the disk image is created.
360 "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
361 },
362 "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this image.
363 "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
364 "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
365 "state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
366 "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
367 "replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
368 },
369 "archiveSizeBytes": "A String", # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
370 "sourceType": "RAW", # Must be "RAW"; provided by the client when the disk image is created.
371 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
372 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
373 "selfLink": "A String", # Server defined URL for the resource (output only).
374 "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.
375 },
376 ],
377 "kind": "compute#imageList", # Type of resource.
378 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
379 "selfLink": "A String", # Server defined URL for this resource (output only).
380 }</pre>
381</div>
382
383<div class="method">
384 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
385 <pre>Retrieves the next page of results.
386
387Args:
388 previous_request: The request for the previous page. (required)
389 previous_response: The response from the request for the previous page. (required)
390
391Returns:
392 A request object that you can call 'execute()' on to request the next
393 page. Returns None if there are no more items in the collection.
394 </pre>
395</div>
396
397</body></html>