Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 7d5badbac4f925c1867e20b50cf0a1a70a5fb573 / . / docs / dyn / compute_v1.images.html
blob: 6896f0827f49b7887a8dbbc928b10cd29152e57b [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 Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]85<p class="firstline">Returns the specified image. Get a list of available images by making a list() request.</p>
86<p class="toc_element">
87 <code><a href="#getFromFamily">getFromFamily(project, family)</a></code></p>
88<p class="firstline">Returns the latest image that is part of an image family and is not deprecated.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]89<p class="toc_element">
90 <code><a href="#insert">insert(project, body)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]91<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]92<p class="toc_element">
93 <code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]94<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 8. 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]95<p class="toc_element">
96 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
97<p class="firstline">Retrieves the next page of results.</p>
98<h3>Method Details</h3>
99<div class="method">
100 <code class="details" id="delete">delete(project, image)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]101 <pre>Deletes the specified image.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]102
103Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]104 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]105 image: string, Name of the image resource to delete. (required)
106
107Returns:
108 An object of the form:
109
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]110 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]111 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
112 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]113 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]114 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
115 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
116 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
117 "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]118 "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]119 "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.
120 "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]121 "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]122 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
123 "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]124 "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]125 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]126 "message": "A String", # [Output Only] A human-readable description of the warning code.
127 "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.
128 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
129 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]130 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]131 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]132 "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]133 },
134 ],
135 },
136 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]137 "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]138 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
139 "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]140 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]141 "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]142 "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]143 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]144 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]145 "message": "A String", # [Output Only] An optional, human-readable error message.
146 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]147 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]148 },
149 ],
150 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]151 "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]152 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]153 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]154 }</pre>
155</div>
156
157<div class="method">
158 <code class="details" id="deprecate">deprecate(project, image, body)</code>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]159 <pre>Sets the deprecation status of an image.
160
161If an empty request body is given, clears the deprecation status instead.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]162
163Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]164 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]165 image: string, Image name. (required)
166 body: object, The request body. (required)
167 The object takes the form of:
168
169{ # Deprecation status for a public resource.
170 "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
171 "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]172 "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]173 "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]174 "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]175}
176
177
178Returns:
179 An object of the form:
180
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]181 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]182 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
183 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]184 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]185 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
186 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
187 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
188 "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]189 "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]190 "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.
191 "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]192 "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]193 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
194 "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]195 "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]196 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]197 "message": "A String", # [Output Only] A human-readable description of the warning code.
198 "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.
199 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
200 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]201 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]202 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]203 "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]204 },
205 ],
206 },
207 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]208 "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]209 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
210 "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]211 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]212 "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]213 "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]214 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]215 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]216 "message": "A String", # [Output Only] An optional, human-readable error message.
217 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]218 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]219 },
220 ],
221 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]222 "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]223 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]224 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]225 }</pre>
226</div>
227
228<div class="method">
229 <code class="details" id="get">get(project, image)</code>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]230 <pre>Returns the specified image. Get a list of available images by making a list() request.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]231
232Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]233 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]234 image: string, Name of the image resource to return. (required)
235
236Returns:
237 An object of the form:
238
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]239 { # An Image resource.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]240 "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:
241 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disk/disk
242 # - projects/project/zones/zone/disk/disk
243 # - zones/zone/disks/disk
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]244 "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.
245 "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]246 "sourceDiskEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
247 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
248 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
249 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]250 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]251 "family": "A String", # The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]252 "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this image.
253 "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
254 "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]255 "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]256 "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]257 "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]258 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]259 "rawDisk": { # The parameters of the raw disk image.
260 "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.
261 "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.
262 "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
263 },
264 "archiveSizeBytes": "A String", # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
265 "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.
266 "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB).
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]267 "imageEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the image using a customer-supplied encryption key.
268 #
269 # After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image).
270 #
271 # Customer-supplied encryption keys do not protect access to metadata of the disk.
272 #
273 # If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later.
274 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
275 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
276 },
277 "licenses": [ # Any applicable license URI.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]278 "A String",
279 ],
280 "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW
281 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
282 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
283 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
284 "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.
285 }</pre>
286</div>
287
288<div class="method">
289 <code class="details" id="getFromFamily">getFromFamily(project, family)</code>
290 <pre>Returns the latest image that is part of an image family and is not deprecated.
291
292Args:
293 project: string, Project ID for this request. (required)
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]294 family: string, Name of the image family to search for. (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]295
296Returns:
297 An object of the form:
298
299 { # An Image resource.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]300 "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:
301 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disk/disk
302 # - projects/project/zones/zone/disk/disk
303 # - zones/zone/disks/disk
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]304 "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.
305 "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]306 "sourceDiskEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
307 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
308 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
309 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]310 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]311 "family": "A String", # The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]312 "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this image.
313 "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
314 "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
315 "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.
316 "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
317 "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.
318 },
319 "rawDisk": { # The parameters of the raw disk image.
320 "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.
321 "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.
322 "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
323 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]324 "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]325 "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.
326 "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB).
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]327 "imageEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the image using a customer-supplied encryption key.
328 #
329 # After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image).
330 #
331 # Customer-supplied encryption keys do not protect access to metadata of the disk.
332 #
333 # If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later.
334 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
335 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
336 },
337 "licenses": [ # Any applicable license URI.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]338 "A String",
339 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]340 "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW
341 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]342 "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]343 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]344 "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]345 }</pre>
346</div>
347
348<div class="method">
349 <code class="details" id="insert">insert(project, body)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]350 <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]351
352Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]353 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]354 body: object, The request body. (required)
355 The object takes the form of:
356
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]357{ # An Image resource.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]358 "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:
359 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disk/disk
360 # - projects/project/zones/zone/disk/disk
361 # - zones/zone/disks/disk
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]362 "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.
363 "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]364 "sourceDiskEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
365 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
366 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
367 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]368 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]369 "family": "A String", # The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]370 "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this image.
371 "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
372 "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]373 "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]374 "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]375 "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]376 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]377 "rawDisk": { # The parameters of the raw disk image.
378 "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.
379 "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.
380 "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
381 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]382 "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]383 "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.
384 "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB).
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]385 "imageEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the image using a customer-supplied encryption key.
386 #
387 # After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image).
388 #
389 # Customer-supplied encryption keys do not protect access to metadata of the disk.
390 #
391 # If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later.
392 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
393 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
394 },
395 "licenses": [ # Any applicable license URI.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]396 "A String",
397 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]398 "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW
399 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]400 "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]401 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]402 "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]403 }
404
405
406Returns:
407 An object of the form:
408
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]409 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]410 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
411 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]412 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]413 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
414 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
415 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
416 "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]417 "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]418 "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.
419 "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]420 "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]421 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
422 "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]423 "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]424 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]425 "message": "A String", # [Output Only] A human-readable description of the warning code.
426 "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.
427 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
428 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]429 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]430 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]431 "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]432 },
433 ],
434 },
435 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]436 "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]437 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
438 "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]439 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]440 "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]441 "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]442 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]443 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]444 "message": "A String", # [Output Only] An optional, human-readable error message.
445 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]446 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]447 },
448 ],
449 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]450 "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]451 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]452 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]453 }</pre>
454</div>
455
456<div class="method">
457 <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]458 <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 8. 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]459
460Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]461 project: string, Project ID for this request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]462 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.
463 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.
464 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]465
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]466The 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]467
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]468For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]469
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]470You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]471
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]472To filter on multiple expressions, provide 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]473
474Returns:
475 An object of the form:
476
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]477 { # Contains a list of images.
478 "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.
479 "items": [ # [Output Only] A list of Image resources.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]480 { # An Image resource.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]481 "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:
482 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disk/disk
483 # - projects/project/zones/zone/disk/disk
484 # - zones/zone/disks/disk
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]485 "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.
486 "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]487 "sourceDiskEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
488 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
489 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
490 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]491 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]492 "family": "A String", # The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]493 "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this image.
494 "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
495 "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]496 "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]497 "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]498 "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]499 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]500 "rawDisk": { # The parameters of the raw disk image.
501 "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.
502 "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.
503 "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
504 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]505 "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]506 "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.
507 "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB).
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]508 "imageEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the image using a customer-supplied encryption key.
509 #
510 # After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image).
511 #
512 # Customer-supplied encryption keys do not protect access to metadata of the disk.
513 #
514 # If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later.
515 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
516 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
517 },
518 "licenses": [ # Any applicable license URI.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]519 "A String",
520 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]521 "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW
522 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]523 "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]524 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]525 "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]526 },
527 ],
528 "kind": "compute#imageList", # Type of resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]529 "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]530 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]531 }</pre>
532</div>
533
534<div class="method">
535 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
536 <pre>Retrieves the next page of results.
537
538Args:
539 previous_request: The request for the previous page. (required)
540 previous_response: The response from the request for the previous page. (required)
541
542Returns:
543 A request object that you can call 'execute()' on to request the next
544 page. Returns None if there are no more items in the collection.
545 </pre>
546</div>
547
548</body></html>