Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / f7b648f5281e17dfee86fe8eb048d5ff0a19ca81 / . / docs / dyn / compute_v1beta12.images.html
blob: 976550c603ef8b51854300b94718d05ad83a2f67 [file] [log] [blame]
Joe Gregorio075572b2012-07-09 16:53:09 -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_v1beta12.html">Compute Engine API</a> . <a href="compute_v1beta12.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="#get">get(project, image)</a></code></p>
82<p class="firstline">Returns the specified image resource.</p>
83<p class="toc_element">
84 <code><a href="#insert">insert(project, body)</a></code></p>
85<p class="firstline">Creates an image resource in the specified project using the data included in the request.</p>
86<p class="toc_element">
87 <code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
88<p class="firstline">Retrieves the list of image resources available to the specified project.</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="delete">delete(project, image)</code>
95 <pre>Deletes the specified image resource.
96
97Args:
98 project: string, Name of the project scoping this request. (required)
99 image: string, Name of the image resource to delete. (required)
100
101Returns:
102 An object of the form:
103
104 {
105 "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
106 "kind": "compute#operation", # Type of the resource.
107 "name": "A String", # Name of the resource.
108 "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
109 "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
110 "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
111 "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
112 "errors": [ # The array of errors encountered while processing this operation.
113 {
114 "message": "A String", # An optional, human-readable error message.
115 "code": "A String", # The error type identifier for this error.
116 "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
117 },
118 ],
119 },
120 "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
121 "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
122 "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
123 "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
124 "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
125 "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).
126 "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).
127 "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
128 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
129 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
130 "selfLink": "A String", # Server defined URL for the resource (output only).
131 "targetLink": "A String", # URL of the resource the operation is mutating (output only).
132 }</pre>
133</div>
134
135<div class="method">
136 <code class="details" id="get">get(project, image)</code>
137 <pre>Returns the specified image resource.
138
139Args:
140 project: string, Name of the project scoping this request. (required)
141 image: string, Name of the image resource to return. (required)
142
143Returns:
144 An object of the form:
145
146 {
147 "kind": "compute#image", # Type of the resource.
148 "description": "A String", # Textual description of the resource; provided by the client when the resource is created.
149 "rawDisk": { # The raw disk image parameters.
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]150 "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.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]151 "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.
152 "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
153 },
154 "preferredKernel": "A String", # An optional URL of the preferred kernel for use with this disk image. If not specified, a server defined default kernel will be used.
155 "diskSnapshot": { # Not yet implemented.
156 "source": "A String", # URL of the disk snapshot.
157 },
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]158 "sourceType": "RAW", # Must be "RAW"; provided by the client when the disk image is created.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]159 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
160 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
161 "selfLink": "A String", # Server defined URL for the resource (output only).
162 "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.
163 }</pre>
164</div>
165
166<div class="method">
167 <code class="details" id="insert">insert(project, body)</code>
168 <pre>Creates an image resource in the specified project using the data included in the request.
169
170Args:
171 project: string, Name of the project scoping this request. (required)
172 body: object, The request body. (required)
173 The object takes the form of:
174
175{
176 "kind": "compute#image", # Type of the resource.
177 "description": "A String", # Textual description of the resource; provided by the client when the resource is created.
178 "rawDisk": { # The raw disk image parameters.
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]179 "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.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]180 "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.
181 "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
182 },
183 "preferredKernel": "A String", # An optional URL of the preferred kernel for use with this disk image. If not specified, a server defined default kernel will be used.
184 "diskSnapshot": { # Not yet implemented.
185 "source": "A String", # URL of the disk snapshot.
186 },
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]187 "sourceType": "RAW", # Must be "RAW"; provided by the client when the disk image is created.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]188 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
189 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
190 "selfLink": "A String", # Server defined URL for the resource (output only).
191 "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.
192 }
193
194
195Returns:
196 An object of the form:
197
198 {
199 "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
200 "kind": "compute#operation", # Type of the resource.
201 "name": "A String", # Name of the resource.
202 "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
203 "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
204 "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
205 "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
206 "errors": [ # The array of errors encountered while processing this operation.
207 {
208 "message": "A String", # An optional, human-readable error message.
209 "code": "A String", # The error type identifier for this error.
210 "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
211 },
212 ],
213 },
214 "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
215 "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
216 "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
217 "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
218 "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
219 "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).
220 "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).
221 "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
222 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
223 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
224 "selfLink": "A String", # Server defined URL for the resource (output only).
225 "targetLink": "A String", # URL of the resource the operation is mutating (output only).
226 }</pre>
227</div>
228
229<div class="method">
230 <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
231 <pre>Retrieves the list of image resources available to the specified project.
232
233Args:
234 project: string, Name of the project scoping this request. (required)
235 maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
236 pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
237 filter: string, Optional. Filter expression for filtering listed resources.
238
239Returns:
240 An object of the form:
241
242 {
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]243 "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]244 "items": [ # The disk image resources.
245 {
246 "kind": "compute#image", # Type of the resource.
247 "description": "A String", # Textual description of the resource; provided by the client when the resource is created.
248 "rawDisk": { # The raw disk image parameters.
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]249 "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.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]250 "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.
251 "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
252 },
253 "preferredKernel": "A String", # An optional URL of the preferred kernel for use with this disk image. If not specified, a server defined default kernel will be used.
254 "diskSnapshot": { # Not yet implemented.
255 "source": "A String", # URL of the disk snapshot.
256 },
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]257 "sourceType": "RAW", # Must be "RAW"; provided by the client when the disk image is created.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]258 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
259 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
260 "selfLink": "A String", # Server defined URL for the resource (output only).
261 "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.
262 },
263 ],
264 "kind": "compute#imageList", # Type of resource.
265 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
266 "selfLink": "A String", # Server defined URL for this resource (output only).
267 }</pre>
268</div>
269
270<div class="method">
271 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
272 <pre>Retrieves the next page of results.
273
274Args:
275 previous_request: The request for the previous page. (required)
276 previous_response: The response from the request for the previous page. (required)
277
278Returns:
279 A request object that you can call 'execute()' on to request the next
280 page. Returns None if there are no more items in the collection.
281 </pre>
282</div>
283
284</body></html>