Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 386cc8b06b57c3d4a564fe0ab0d1e51fc34270a8 / . / docs / dyn / compute_v1.images.html
blob: a2593deb88551da3dc84dacc772a0ffd69fba244 [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>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]82<p class="firstline">Sets the deprecation status of an image.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]101 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]102 image: string, Name of the image resource to delete. (required)
103
104Returns:
105 An object of the form:
106
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]107 { # An Operation resource, used to manage asynchronous API requests.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]108 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]109 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]110 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]111 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]112 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
113 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
114 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]115 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should monotonically increase as the operation progresses.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]116 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]117 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]118 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
119 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
120 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]121 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]122 "message": "A String", # [Output Only] Optional human-readable details for this warning.
123 "code": "A String", # [Output Only] The warning type identifier for this warning.
124 "data": [ # [Output Only] Metadata for this warning in key: value format.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]125 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]126 "value": "A String", # [Output Only] A warning data value corresponding to the key.
127 "key": "A String", # [Output Only] A key for the warning data.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]128 },
129 ],
130 },
131 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]132 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
133 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
134 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
135 "name": "A String", # [Output Only] Name of the resource.
136 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
137 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]138 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]139 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]140 "message": "A String", # [Output Only] An optional, human-readable error message.
141 "code": "A String", # [Output Only] The error type identifier for this error.
142 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]143 },
144 ],
145 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]146 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]147 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]148 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]149 }</pre>
150</div>
151
152<div class="method">
153 <code class="details" id="deprecate">deprecate(project, image, body)</code>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]154 <pre>Sets the deprecation status of an image.
155
156If an empty request body is given, clears the deprecation status instead.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]157
158Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]159 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]160 image: string, Image name. (required)
161 body: object, The request body. (required)
162 The object takes the form of:
163
164{ # Deprecation status for a public resource.
165 "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
166 "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]167 "state": "A String", # The deprecation state of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]168 "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]169 "replacement": "A String", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]170}
171
172
173Returns:
174 An object of the form:
175
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]176 { # An Operation resource, used to manage asynchronous API requests.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]177 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]178 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]179 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]180 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]181 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
182 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
183 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]184 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should monotonically increase as the operation progresses.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]185 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]186 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]187 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
188 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
189 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]190 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]191 "message": "A String", # [Output Only] Optional human-readable details for this warning.
192 "code": "A String", # [Output Only] The warning type identifier for this warning.
193 "data": [ # [Output Only] Metadata for this warning in key: value format.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]194 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]195 "value": "A String", # [Output Only] A warning data value corresponding to the key.
196 "key": "A String", # [Output Only] A key for the warning data.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]197 },
198 ],
199 },
200 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]201 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
202 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
203 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
204 "name": "A String", # [Output Only] Name of the resource.
205 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
206 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]207 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]208 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]209 "message": "A String", # [Output Only] An optional, human-readable error message.
210 "code": "A String", # [Output Only] The error type identifier for this error.
211 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]212 },
213 ],
214 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]215 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]216 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]217 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]218 }</pre>
219</div>
220
221<div class="method">
222 <code class="details" id="get">get(project, image)</code>
223 <pre>Returns the specified image resource.
224
225Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]226 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]227 image: string, Name of the image resource to return. (required)
228
229Returns:
230 An object of the form:
231
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]232 { # An Image resource.
233 "status": "A String", # [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.
234 "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]235 "description": "A String", # Textual description of the resource; provided by the client when the resource is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]236 "rawDisk": { # The parameters of the raw disk image.
237 "containerType": "A String", # The format used to encode and transmit the block device, which 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.
238 "source": "A String", # The full Google Cloud Storage URL where the disk image is stored. You must provide either this property or the sourceDisk property but not both.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]239 "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
240 },
241 "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this image.
242 "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
243 "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]244 "state": "A String", # The deprecation state of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]245 "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]246 "replacement": "A String", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]247 },
248 "archiveSizeBytes": "A String", # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]249 "sourceDiskId": "A String", # The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.
250 "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB).
251 "sourceDisk": "A String", # URL of the The source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values:
252 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disk/disk
253 # - projects/project/zones/zone/disk/disk
254 # - zones/zone/disks/disk
255 "licenses": [ # Any applicable publicly visible licenses.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]256 "A String",
257 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]258 "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW
259 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
260 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]261 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]262 "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]263 }</pre>
264</div>
265
266<div class="method">
267 <code class="details" id="insert">insert(project, body)</code>
268 <pre>Creates an image resource in the specified project using the data included in the request.
269
270Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]271 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]272 body: object, The request body. (required)
273 The object takes the form of:
274
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]275{ # An Image resource.
276 "status": "A String", # [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.
277 "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]278 "description": "A String", # Textual description of the resource; provided by the client when the resource is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]279 "rawDisk": { # The parameters of the raw disk image.
280 "containerType": "A String", # The format used to encode and transmit the block device, which 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.
281 "source": "A String", # The full Google Cloud Storage URL where the disk image is stored. You must provide either this property or the sourceDisk property but not both.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]282 "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
283 },
284 "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this image.
285 "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
286 "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]287 "state": "A String", # The deprecation state of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]288 "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]289 "replacement": "A String", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]290 },
291 "archiveSizeBytes": "A String", # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]292 "sourceDiskId": "A String", # The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.
293 "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB).
294 "sourceDisk": "A String", # URL of the The source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values:
295 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disk/disk
296 # - projects/project/zones/zone/disk/disk
297 # - zones/zone/disks/disk
298 "licenses": [ # Any applicable publicly visible licenses.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]299 "A String",
300 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]301 "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW
302 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
303 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]304 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]305 "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]306 }
307
308
309Returns:
310 An object of the form:
311
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]312 { # An Operation resource, used to manage asynchronous API requests.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]313 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]314 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]315 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]316 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]317 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
318 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
319 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]320 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should monotonically increase as the operation progresses.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]321 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]322 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]323 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
324 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
325 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]326 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]327 "message": "A String", # [Output Only] Optional human-readable details for this warning.
328 "code": "A String", # [Output Only] The warning type identifier for this warning.
329 "data": [ # [Output Only] Metadata for this warning in key: value format.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]330 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]331 "value": "A String", # [Output Only] A warning data value corresponding to the key.
332 "key": "A String", # [Output Only] A key for the warning data.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]333 },
334 ],
335 },
336 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]337 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
338 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
339 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
340 "name": "A String", # [Output Only] Name of the resource.
341 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
342 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]343 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]344 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]345 "message": "A String", # [Output Only] An optional, human-readable error message.
346 "code": "A String", # [Output Only] The error type identifier for this error.
347 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]348 },
349 ],
350 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]351 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]352 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]353 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]354 }</pre>
355</div>
356
357<div class="method">
358 <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
359 <pre>Retrieves the list of image resources available to the specified project.
360
361Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]362 project: string, Project ID for this request. (required)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]363 maxResults: integer, Maximum count of results to be returned.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]364 pageToken: string, Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.
365 filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.
366
367The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
368
369For example, filter=name ne example-instance.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]370
371Returns:
372 An object of the form:
373
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]374 { # Contains a list of Image resources.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]375 "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]376 "items": [ # A list of Image resources.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]377 { # An Image resource.
378 "status": "A String", # [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.
379 "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]380 "description": "A String", # Textual description of the resource; provided by the client when the resource is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]381 "rawDisk": { # The parameters of the raw disk image.
382 "containerType": "A String", # The format used to encode and transmit the block device, which 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.
383 "source": "A String", # The full Google Cloud Storage URL where the disk image is stored. You must provide either this property or the sourceDisk property but not both.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]384 "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
385 },
386 "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this image.
387 "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
388 "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]389 "state": "A String", # The deprecation state of this resource. This 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. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]390 "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]391 "replacement": "A String", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]392 },
393 "archiveSizeBytes": "A String", # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]394 "sourceDiskId": "A String", # The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.
395 "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB).
396 "sourceDisk": "A String", # URL of the The source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values:
397 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disk/disk
398 # - projects/project/zones/zone/disk/disk
399 # - zones/zone/disks/disk
400 "licenses": [ # Any applicable publicly visible licenses.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]401 "A String",
402 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]403 "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW
404 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
405 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]406 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]407 "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]408 },
409 ],
410 "kind": "compute#imageList", # Type of resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]411 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
412 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]413 }</pre>
414</div>
415
416<div class="method">
417 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
418 <pre>Retrieves the next page of results.
419
420Args:
421 previous_request: The request for the previous page. (required)
422 previous_response: The response from the request for the previous page. (required)
423
424Returns:
425 A request object that you can call 'execute()' on to request the next
426 page. Returns None if there are no more items in the collection.
427 </pre>
428</div>
429
430</body></html>