Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 692617a6eea5e47e71e221c9e73f5f2d5534e3bf / . / docs / dyn / compute_beta.images.html
blob: 1f3efe38102db5e3ee60b158f0572df42b760c8b [file] [log] [blame]
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[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_beta.html">Compute Engine API</a> . <a href="compute_beta.images.html">images</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(project, image)</a></code></p>
79<p class="firstline">Deletes the specified image.</p>
80<p class="toc_element">
81 <code><a href="#deprecate">deprecate(project, image, body)</a></code></p>
82<p class="firstline">Sets the deprecation status of an image.</p>
83<p class="toc_element">
84 <code><a href="#get">get(project, image)</a></code></p>
85<p class="firstline">Returns the specified image. 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>
89<p class="toc_element">
90 <code><a href="#insert">insert(project, body)</a></code></p>
91<p class="firstline">Creates an image in the specified project using the data included in the request.</p>
92<p class="toc_element">
93 <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
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>
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<p class="toc_element">
99 <code><a href="#setLabels">setLabels(project, resource, body)</a></code></p>
100<p class="firstline">Sets the labels on an image. To learn more about labels, read the Labeling or Tagging Resources documentation.</p>
101<p class="toc_element">
102 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
103<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
104<h3>Method Details</h3>
105<div class="method">
106 <code class="details" id="delete">delete(project, image)</code>
107 <pre>Deletes the specified image.
108
109Args:
110 project: string, Project ID for this request. (required)
111 image: string, Name of the image resource to delete. (required)
112
113Returns:
114 An object of the form:
115
116 { # An Operation resource, used to manage asynchronous API requests.
117 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
118 "clientOperationId": "A String", # [Output Only] Reserved for future use.
119 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
120 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
121 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
122 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
123 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
124 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
125 "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.
126 "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.
127 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
128 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
129 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
130 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
131 {
132 "message": "A String", # [Output Only] A human-readable description of the warning code.
133 "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.
134 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
135 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
136 {
137 "value": "A String", # [Output Only] A warning data value corresponding to the key.
138 "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).
139 },
140 ],
141 },
142 ],
143 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
144 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
145 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
146 "name": "A String", # [Output Only] Name of the resource.
147 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
148 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
149 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
150 {
151 "message": "A String", # [Output Only] An optional, human-readable error message.
152 "code": "A String", # [Output Only] The error type identifier for this error.
153 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
154 },
155 ],
156 },
157 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
158 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]159 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]160 }</pre>
161</div>
162
163<div class="method">
164 <code class="details" id="deprecate">deprecate(project, image, body)</code>
165 <pre>Sets the deprecation status of an image.
166
167If an empty request body is given, clears the deprecation status instead.
168
169Args:
170 project: string, Project ID for this request. (required)
171 image: string, Image name. (required)
172 body: object, The request body. (required)
173 The object takes the form of:
174
175{ # Deprecation status for a public resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]176 "deleted": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it.
177 "deprecated": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]178 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]179 "obsolete": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]180 "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.
181}
182
183
184Returns:
185 An object of the form:
186
187 { # An Operation resource, used to manage asynchronous API requests.
188 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
189 "clientOperationId": "A String", # [Output Only] Reserved for future use.
190 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
191 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
192 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
193 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
194 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
195 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
196 "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.
197 "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.
198 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
199 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
200 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
201 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
202 {
203 "message": "A String", # [Output Only] A human-readable description of the warning code.
204 "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.
205 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
206 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
207 {
208 "value": "A String", # [Output Only] A warning data value corresponding to the key.
209 "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).
210 },
211 ],
212 },
213 ],
214 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
215 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
216 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
217 "name": "A String", # [Output Only] Name of the resource.
218 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
219 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
220 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
221 {
222 "message": "A String", # [Output Only] An optional, human-readable error message.
223 "code": "A String", # [Output Only] The error type identifier for this error.
224 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
225 },
226 ],
227 },
228 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
229 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]230 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]231 }</pre>
232</div>
233
234<div class="method">
235 <code class="details" id="get">get(project, image)</code>
236 <pre>Returns the specified image. Get a list of available images by making a list() request.
237
238Args:
239 project: string, Project ID for this request. (required)
240 image: string, Name of the image resource to return. (required)
241
242Returns:
243 An object of the form:
244
245 { # An Image resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]246 "sourceDisk": "A String", # URL of 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:
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]247 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
248 # - projects/project/zones/zone/disks/disk
249 # - zones/zone/disks/disk
250 "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.
251 "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images.
252 "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.
253 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
254 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
255 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
256 #
257 # The key must meet the following requirements before you can provide it to Compute Engine:
258 # - The key is wrapped using a RSA public key certificate provided by Google.
259 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
260 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
261 },
262 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
263 "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.
264 "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this image.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]265 "deleted": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it.
266 "deprecated": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]267 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]268 "obsolete": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]269 "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.
270 },
271 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
272 #
273 # To see the latest fingerprint, make a get() request to retrieve an image.
274 "labels": { # Labels to apply to this image. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
275 "a_key": "A String",
276 },
277 "archiveSizeBytes": "A String", # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
278 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]279 "guestOsFeatures": [ # A list of features to enable on the guest OS. Applicable for bootable images only. Currently, only one feature can be enabled, VIRTIO_SCSCI_MULTIQUEUE, which allows each virtual CPU to have its own queue. For Windows images, you can only enable VIRTIO_SCSCI_MULTIQUEUE on images with driver version 1.2.0.1621 or higher. Linux images with kernel versions 3.17 and higher will support VIRTIO_SCSCI_MULTIQUEUE.
280 #
281 # For new Windows images, the server might also populate this field with the value WINDOWS, to indicate that this is a Windows image. This value is purely informational and does not enable or disable any features.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]282 { # Guest OS features.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]283 "type": "A String", # The type of supported feature. Currenty only VIRTIO_SCSI_MULTIQUEUE is supported. For newer Windows images, the server might also populate this property with the value WINDOWS to indicate that this is a Windows image. This value is purely informational and does not enable or disable any features.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]284 },
285 ],
286 "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB).
287 "imageEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the image using a customer-supplied encryption key.
288 #
289 # 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).
290 #
291 # Customer-supplied encryption keys do not protect access to metadata of the disk.
292 #
293 # 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.
294 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
295 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
296 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
297 #
298 # The key must meet the following requirements before you can provide it to Compute Engine:
299 # - The key is wrapped using a RSA public key certificate provided by Google.
300 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
301 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
302 },
303 "rawDisk": { # The parameters of the raw disk image.
304 "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.
305 "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.
306 "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
307 },
308 "licenses": [ # Any applicable license URI.
309 "A String",
310 ],
311 "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW
312 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
313 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
314 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
315 "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.
316 }</pre>
317</div>
318
319<div class="method">
320 <code class="details" id="getFromFamily">getFromFamily(project, family)</code>
321 <pre>Returns the latest image that is part of an image family and is not deprecated.
322
323Args:
324 project: string, Project ID for this request. (required)
325 family: string, Name of the image family to search for. (required)
326
327Returns:
328 An object of the form:
329
330 { # An Image resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]331 "sourceDisk": "A String", # URL of 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:
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]332 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
333 # - projects/project/zones/zone/disks/disk
334 # - zones/zone/disks/disk
335 "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.
336 "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images.
337 "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.
338 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
339 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
340 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
341 #
342 # The key must meet the following requirements before you can provide it to Compute Engine:
343 # - The key is wrapped using a RSA public key certificate provided by Google.
344 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
345 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
346 },
347 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
348 "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.
349 "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this image.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]350 "deleted": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it.
351 "deprecated": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]352 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]353 "obsolete": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]354 "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.
355 },
356 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
357 #
358 # To see the latest fingerprint, make a get() request to retrieve an image.
359 "labels": { # Labels to apply to this image. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
360 "a_key": "A String",
361 },
362 "archiveSizeBytes": "A String", # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
363 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]364 "guestOsFeatures": [ # A list of features to enable on the guest OS. Applicable for bootable images only. Currently, only one feature can be enabled, VIRTIO_SCSCI_MULTIQUEUE, which allows each virtual CPU to have its own queue. For Windows images, you can only enable VIRTIO_SCSCI_MULTIQUEUE on images with driver version 1.2.0.1621 or higher. Linux images with kernel versions 3.17 and higher will support VIRTIO_SCSCI_MULTIQUEUE.
365 #
366 # For new Windows images, the server might also populate this field with the value WINDOWS, to indicate that this is a Windows image. This value is purely informational and does not enable or disable any features.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]367 { # Guest OS features.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]368 "type": "A String", # The type of supported feature. Currenty only VIRTIO_SCSI_MULTIQUEUE is supported. For newer Windows images, the server might also populate this property with the value WINDOWS to indicate that this is a Windows image. This value is purely informational and does not enable or disable any features.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]369 },
370 ],
371 "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB).
372 "imageEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the image using a customer-supplied encryption key.
373 #
374 # 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).
375 #
376 # Customer-supplied encryption keys do not protect access to metadata of the disk.
377 #
378 # 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.
379 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
380 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
381 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
382 #
383 # The key must meet the following requirements before you can provide it to Compute Engine:
384 # - The key is wrapped using a RSA public key certificate provided by Google.
385 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
386 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
387 },
388 "rawDisk": { # The parameters of the raw disk image.
389 "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.
390 "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.
391 "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
392 },
393 "licenses": [ # Any applicable license URI.
394 "A String",
395 ],
396 "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW
397 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
398 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
399 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
400 "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.
401 }</pre>
402</div>
403
404<div class="method">
405 <code class="details" id="insert">insert(project, body)</code>
406 <pre>Creates an image in the specified project using the data included in the request.
407
408Args:
409 project: string, Project ID for this request. (required)
410 body: object, The request body. (required)
411 The object takes the form of:
412
413{ # An Image resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]414 "sourceDisk": "A String", # URL of 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:
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]415 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
416 # - projects/project/zones/zone/disks/disk
417 # - zones/zone/disks/disk
418 "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.
419 "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images.
420 "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.
421 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
422 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
423 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
424 #
425 # The key must meet the following requirements before you can provide it to Compute Engine:
426 # - The key is wrapped using a RSA public key certificate provided by Google.
427 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
428 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
429 },
430 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
431 "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.
432 "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this image.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]433 "deleted": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it.
434 "deprecated": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]435 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]436 "obsolete": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]437 "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.
438 },
439 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
440 #
441 # To see the latest fingerprint, make a get() request to retrieve an image.
442 "labels": { # Labels to apply to this image. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
443 "a_key": "A String",
444 },
445 "archiveSizeBytes": "A String", # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
446 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]447 "guestOsFeatures": [ # A list of features to enable on the guest OS. Applicable for bootable images only. Currently, only one feature can be enabled, VIRTIO_SCSCI_MULTIQUEUE, which allows each virtual CPU to have its own queue. For Windows images, you can only enable VIRTIO_SCSCI_MULTIQUEUE on images with driver version 1.2.0.1621 or higher. Linux images with kernel versions 3.17 and higher will support VIRTIO_SCSCI_MULTIQUEUE.
448 #
449 # For new Windows images, the server might also populate this field with the value WINDOWS, to indicate that this is a Windows image. This value is purely informational and does not enable or disable any features.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]450 { # Guest OS features.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]451 "type": "A String", # The type of supported feature. Currenty only VIRTIO_SCSI_MULTIQUEUE is supported. For newer Windows images, the server might also populate this property with the value WINDOWS to indicate that this is a Windows image. This value is purely informational and does not enable or disable any features.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]452 },
453 ],
454 "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB).
455 "imageEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the image using a customer-supplied encryption key.
456 #
457 # 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).
458 #
459 # Customer-supplied encryption keys do not protect access to metadata of the disk.
460 #
461 # 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.
462 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
463 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
464 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
465 #
466 # The key must meet the following requirements before you can provide it to Compute Engine:
467 # - The key is wrapped using a RSA public key certificate provided by Google.
468 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
469 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
470 },
471 "rawDisk": { # The parameters of the raw disk image.
472 "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.
473 "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.
474 "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
475 },
476 "licenses": [ # Any applicable license URI.
477 "A String",
478 ],
479 "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW
480 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
481 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
482 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
483 "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.
484 }
485
486
487Returns:
488 An object of the form:
489
490 { # An Operation resource, used to manage asynchronous API requests.
491 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
492 "clientOperationId": "A String", # [Output Only] Reserved for future use.
493 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
494 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
495 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
496 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
497 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
498 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
499 "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.
500 "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.
501 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
502 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
503 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
504 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
505 {
506 "message": "A String", # [Output Only] A human-readable description of the warning code.
507 "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.
508 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
509 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
510 {
511 "value": "A String", # [Output Only] A warning data value corresponding to the key.
512 "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).
513 },
514 ],
515 },
516 ],
517 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
518 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
519 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
520 "name": "A String", # [Output Only] Name of the resource.
521 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
522 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
523 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
524 {
525 "message": "A String", # [Output Only] An optional, human-readable error message.
526 "code": "A String", # [Output Only] The error type identifier for this error.
527 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
528 },
529 ],
530 },
531 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
532 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]533 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]534 }</pre>
535</div>
536
537<div class="method">
538 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
539 <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.
540
541Args:
542 project: string, Project ID for this request. (required)
543 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
544
545You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
546
547Currently, only sorting by name or creationTimestamp desc is supported.
548 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.
549 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.
550 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.
551
552The 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.
553
554For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
555
556You 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.
557
558To 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.
559
560Returns:
561 An object of the form:
562
563 { # Contains a list of images.
564 "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.
565 "items": [ # [Output Only] A list of Image resources.
566 { # An Image resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]567 "sourceDisk": "A String", # URL of 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:
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]568 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
569 # - projects/project/zones/zone/disks/disk
570 # - zones/zone/disks/disk
571 "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.
572 "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images.
573 "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.
574 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
575 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
576 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
577 #
578 # The key must meet the following requirements before you can provide it to Compute Engine:
579 # - The key is wrapped using a RSA public key certificate provided by Google.
580 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
581 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
582 },
583 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
584 "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.
585 "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this image.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]586 "deleted": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it.
587 "deprecated": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]588 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]589 "obsolete": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]590 "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.
591 },
592 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
593 #
594 # To see the latest fingerprint, make a get() request to retrieve an image.
595 "labels": { # Labels to apply to this image. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
596 "a_key": "A String",
597 },
598 "archiveSizeBytes": "A String", # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
599 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]600 "guestOsFeatures": [ # A list of features to enable on the guest OS. Applicable for bootable images only. Currently, only one feature can be enabled, VIRTIO_SCSCI_MULTIQUEUE, which allows each virtual CPU to have its own queue. For Windows images, you can only enable VIRTIO_SCSCI_MULTIQUEUE on images with driver version 1.2.0.1621 or higher. Linux images with kernel versions 3.17 and higher will support VIRTIO_SCSCI_MULTIQUEUE.
601 #
602 # For new Windows images, the server might also populate this field with the value WINDOWS, to indicate that this is a Windows image. This value is purely informational and does not enable or disable any features.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]603 { # Guest OS features.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]604 "type": "A String", # The type of supported feature. Currenty only VIRTIO_SCSI_MULTIQUEUE is supported. For newer Windows images, the server might also populate this property with the value WINDOWS to indicate that this is a Windows image. This value is purely informational and does not enable or disable any features.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]605 },
606 ],
607 "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB).
608 "imageEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the image using a customer-supplied encryption key.
609 #
610 # 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).
611 #
612 # Customer-supplied encryption keys do not protect access to metadata of the disk.
613 #
614 # 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.
615 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
616 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
617 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
618 #
619 # The key must meet the following requirements before you can provide it to Compute Engine:
620 # - The key is wrapped using a RSA public key certificate provided by Google.
621 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at:
622 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
623 },
624 "rawDisk": { # The parameters of the raw disk image.
625 "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.
626 "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.
627 "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
628 },
629 "licenses": [ # Any applicable license URI.
630 "A String",
631 ],
632 "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW
633 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
634 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
635 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
636 "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.
637 },
638 ],
639 "kind": "compute#imageList", # Type of resource.
640 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
641 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
642 }</pre>
643</div>
644
645<div class="method">
646 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
647 <pre>Retrieves the next page of results.
648
649Args:
650 previous_request: The request for the previous page. (required)
651 previous_response: The response from the request for the previous page. (required)
652
653Returns:
654 A request object that you can call 'execute()' on to request the next
655 page. Returns None if there are no more items in the collection.
656 </pre>
657</div>
658
659<div class="method">
660 <code class="details" id="setLabels">setLabels(project, resource, body)</code>
661 <pre>Sets the labels on an image. To learn more about labels, read the Labeling or Tagging Resources documentation.
662
663Args:
664 project: string, Project ID for this request. (required)
665 resource: string, Name of the resource for this request. (required)
666 body: object, The request body. (required)
667 The object takes the form of:
668
669{
670 "labelFingerprint": "A String", # The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels. Make a get() request to the resource to get the latest fingerprint.
671 "labels": { # A list of labels to apply for this resource. Each label key & value must 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. For example, "webserver-frontend": "images". A label value can also be empty (e.g. "my-label": "").
672 "a_key": "A String",
673 },
674 }
675
676
677Returns:
678 An object of the form:
679
680 { # An Operation resource, used to manage asynchronous API requests.
681 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
682 "clientOperationId": "A String", # [Output Only] Reserved for future use.
683 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
684 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
685 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
686 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
687 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
688 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
689 "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.
690 "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.
691 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
692 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
693 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
694 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
695 {
696 "message": "A String", # [Output Only] A human-readable description of the warning code.
697 "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.
698 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
699 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
700 {
701 "value": "A String", # [Output Only] A warning data value corresponding to the key.
702 "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).
703 },
704 ],
705 },
706 ],
707 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
708 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
709 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
710 "name": "A String", # [Output Only] Name of the resource.
711 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
712 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
713 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
714 {
715 "message": "A String", # [Output Only] An optional, human-readable error message.
716 "code": "A String", # [Output Only] The error type identifier for this error.
717 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
718 },
719 ],
720 },
721 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
722 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]723 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]724 }</pre>
725</div>
726
727<div class="method">
728 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code>
729 <pre>Returns permissions that a caller has on the specified resource.
730
731Args:
732 project: string, Project ID for this request. (required)
733 resource: string, Name of the resource for this request. (required)
734 body: object, The request body. (required)
735 The object takes the form of:
736
737{
738 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
739 "A String",
740 ],
741 }
742
743
744Returns:
745 An object of the form:
746
747 {
748 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
749 "A String",
750 ],
751 }</pre>
752</div>
753
754</body></html>