Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 36e41bc9e5f0c6e6d5920ae4a5c9802ca63554e2 / . / docs / dyn / compute_v1.images.html
blob: 24181fcf3df116aa9a5801132ad215400a7cf062 [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>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]79<p class="firstline">Deletes the specified image.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]85<p class="firstline">Returns the specified image.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]86<p class="toc_element">
87 <code><a href="#insert">insert(project, body)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]88<p class="firstline">Creates an image in the specified project using the data included in the request.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]89<p class="toc_element">
90 <code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]91<p class="firstline">Retrieves the list of private images available to the specified project. Private images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 7. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]98 <pre>Deletes the specified image.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]108 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
109 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]110 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]111 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
112 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
113 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
114 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]115 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]116 "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 when the operation will be complete. This number should monotonically increase as the operation progresses.
117 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]118 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]119 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
120 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]121 "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]122 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]123 "message": "A String", # [Output Only] A human-readable description of the warning code.
124 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
125 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
126 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]127 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]128 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]129 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]130 },
131 ],
132 },
133 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]134 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]135 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
136 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]137 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]138 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]139 "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]140 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]141 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]142 "message": "A String", # [Output Only] An optional, human-readable error message.
143 "code": "A String", # [Output Only] The error type identifier for this error.
144 "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]145 },
146 ],
147 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]148 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]149 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]150 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]151 }</pre>
152</div>
153
154<div class="method">
155 <code class="details" id="deprecate">deprecate(project, image, body)</code>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]156 <pre>Sets the deprecation status of an image.
157
158If an empty request body is given, clears the deprecation status instead.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]159
160Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]161 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]162 image: string, Image name. (required)
163 body: object, The request body. (required)
164 The object takes the form of:
165
166{ # Deprecation status for a public resource.
167 "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
168 "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]169 "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]170 "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]171 "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]172}
173
174
175Returns:
176 An object of the form:
177
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]178 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]179 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
180 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]181 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]182 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
183 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
184 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
185 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]186 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]187 "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 when the operation will be complete. This number should monotonically increase as the operation progresses.
188 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]189 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]190 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
191 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]192 "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]193 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]194 "message": "A String", # [Output Only] A human-readable description of the warning code.
195 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
196 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
197 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]198 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]199 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]200 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]201 },
202 ],
203 },
204 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]205 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]206 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
207 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]208 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]209 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]210 "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]211 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]212 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]213 "message": "A String", # [Output Only] An optional, human-readable error message.
214 "code": "A String", # [Output Only] The error type identifier for this error.
215 "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]216 },
217 ],
218 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]219 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]220 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]221 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]222 }</pre>
223</div>
224
225<div class="method">
226 <code class="details" id="get">get(project, image)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]227 <pre>Returns the specified image.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]228
229Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]230 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]231 image: string, Name of the image resource to return. (required)
232
233Returns:
234 An object of the form:
235
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]236 { # An Image resource.
237 "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.
238 "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]239 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]240 "rawDisk": { # The parameters of the raw disk image.
241 "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.
242 "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]243 "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
244 },
245 "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this image.
246 "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
247 "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]248 "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]249 "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]250 "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]251 },
252 "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]253 "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.
254 "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB).
255 "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:
256 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disk/disk
257 # - projects/project/zones/zone/disk/disk
258 # - zones/zone/disks/disk
259 "licenses": [ # Any applicable publicly visible licenses.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]260 "A String",
261 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]262 "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW
263 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]264 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]265 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]266 "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]267 }</pre>
268</div>
269
270<div class="method">
271 <code class="details" id="insert">insert(project, body)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]272 <pre>Creates an image in the specified project using the data included in the request.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]273
274Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]275 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]276 body: object, The request body. (required)
277 The object takes the form of:
278
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]279{ # An Image resource.
280 "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.
281 "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]282 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]283 "rawDisk": { # The parameters of the raw disk image.
284 "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.
285 "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]286 "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
287 },
288 "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this image.
289 "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
290 "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]291 "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]292 "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]293 "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]294 },
295 "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]296 "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.
297 "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB).
298 "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:
299 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disk/disk
300 # - projects/project/zones/zone/disk/disk
301 # - zones/zone/disks/disk
302 "licenses": [ # Any applicable publicly visible licenses.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]303 "A String",
304 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]305 "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW
306 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]307 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]308 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]309 "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]310 }
311
312
313Returns:
314 An object of the form:
315
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]316 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]317 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
318 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]319 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]320 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
321 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
322 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
323 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]324 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]325 "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 when the operation will be complete. This number should monotonically increase as the operation progresses.
326 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]327 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]328 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
329 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]330 "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]331 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]332 "message": "A String", # [Output Only] A human-readable description of the warning code.
333 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
334 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
335 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]336 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]337 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]338 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource, and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]339 },
340 ],
341 },
342 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]343 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]344 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
345 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]346 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]347 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]348 "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]349 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]350 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]351 "message": "A String", # [Output Only] An optional, human-readable error message.
352 "code": "A String", # [Output Only] The error type identifier for this error.
353 "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]354 },
355 ],
356 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]357 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]358 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]359 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]360 }</pre>
361</div>
362
363<div class="method">
364 <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]365 <pre>Retrieves the list of private images available to the specified project. Private images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 7. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud.
366
367See Accessing images for more information.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]368
369Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]370 project: string, Project ID for this request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]371 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
372 pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
373 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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]374
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]375The 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 you are filtering by (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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]376
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]377For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
378
379Compute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.
380
381The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions meaning that resources must match all expressions to pass the filters.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]382
383Returns:
384 An object of the form:
385
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]386 { # Contains a list of images.
387 "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
388 "items": [ # [Output Only] A list of Image resources.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]389 { # An Image resource.
390 "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.
391 "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]392 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]393 "rawDisk": { # The parameters of the raw disk image.
394 "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.
395 "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]396 "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
397 },
398 "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this image.
399 "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
400 "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]401 "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]402 "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]403 "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]404 },
405 "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]406 "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.
407 "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB).
408 "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:
409 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disk/disk
410 # - projects/project/zones/zone/disk/disk
411 # - zones/zone/disks/disk
412 "licenses": [ # Any applicable publicly visible licenses.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]413 "A String",
414 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]415 "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW
416 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]417 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]418 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]419 "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]420 },
421 ],
422 "kind": "compute#imageList", # Type of resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]423 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]424 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]425 }</pre>
426</div>
427
428<div class="method">
429 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
430 <pre>Retrieves the next page of results.
431
432Args:
433 previous_request: The request for the previous page. (required)
434 previous_response: The response from the request for the previous page. (required)
435
436Returns:
437 A request object that you can call 'execute()' on to request the next
438 page. Returns None if there are no more items in the collection.
439 </pre>
440</div>
441
442</body></html>