Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 4ba8c235185d73c50911d3e1ef511904b474fee2 / . / docs / dyn / compute_v1.snapshots.html
blob: 2a3903e0721048dd0a14d5e6e9e057f6b6c07f6e [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.snapshots.html">snapshots</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(project, snapshot)</a></code></p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]79<p class="firstline">Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]80<p class="toc_element">
81 <code><a href="#get">get(project, snapshot)</a></code></p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]82<p class="firstline">Returns the specified Snapshot resource. Get a list of available snapshots by making a list() request.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]83<p class="toc_element">
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]84 <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]85<p class="firstline">Retrieves the list of Snapshot resources contained within the specified project.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]86<p class="toc_element">
87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]89<p class="toc_element">
90 <code><a href="#setLabels">setLabels(project, resource, body)</a></code></p>
91<p class="firstline">Sets the labels on a snapshot. To learn more about labels, read the Labeling or Tagging Resources documentation.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]92<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="delete">delete(project, snapshot)</code>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]95 <pre>Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot.
96
97For more information, see Deleting snaphots.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]98
99Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]100 project: string, Project ID for this request. (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]101 snapshot: string, Name of the Snapshot resource to delete. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]102
103Returns:
104 An object of the form:
105
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]106 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]107 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
108 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]109 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]110 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
111 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
112 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
113 "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]114 "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]115 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
116 "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]117 "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]118 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
119 "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]120 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]121 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]122 "message": "A String", # [Output Only] A human-readable description of the warning code.
123 "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.
124 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
125 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]126 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]127 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]128 "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]129 },
130 ],
131 },
132 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]133 "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]134 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
135 "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]136 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]137 "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]138 "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]139 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]140 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]141 "message": "A String", # [Output Only] An optional, human-readable error message.
142 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]143 "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]144 },
145 ],
146 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]147 "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]148 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]149 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]150 }</pre>
151</div>
152
153<div class="method">
154 <code class="details" id="get">get(project, snapshot)</code>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]155 <pre>Returns the specified Snapshot resource. Get a list of available snapshots by making a list() request.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]156
157Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]158 project: string, Project ID for this request. (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]159 snapshot: string, Name of the Snapshot resource to return. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]160
161Returns:
162 An object of the form:
163
164 { # A persistent disk snapshot resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]165 "status": "A String", # [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]166 "kind": "compute#snapshot", # [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]167 "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.
168 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
169 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
170 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]171 "storageBytes": "A String", # [Output Only] A size of the the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]172 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
173 "sourceDisk": "A String", # [Output Only] The source disk used to create this snapshot.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]174 "snapshotEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the snapshot using a customer-supplied encryption key.
175 #
176 # After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the image later For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request.
177 #
178 # Customer-supplied encryption keys do not protect access to metadata of the disk.
179 #
180 # If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later.
181 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
182 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
183 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]184 "storageBytesStatus": "A String", # [Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]185 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set 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.
186 #
187 # To see the latest fingerprint, make a get() request to retrieve a snapshot.
188 "labels": { # Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty.
189 "a_key": "A String",
190 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]191 "sourceDiskId": "A String", # [Output Only] The ID value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name.
192 "diskSizeGb": "A String", # [Output Only] Size of the snapshot, specified in GB.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]193 "licenses": [ # [Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]194 "A String",
195 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]196 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]197 "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]198 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
199 "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]200 }</pre>
201</div>
202
203<div class="method">
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]204 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]205 <pre>Retrieves the list of Snapshot resources contained within the specified project.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]206
207Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]208 project: string, Project ID for this request. (required)
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]209 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
210
211You 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.
212
213Currently, only sorting by name or creationTimestamp desc is supported.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]214 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. Acceptable values are 0 to 500, inclusive. (Default: 500)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]215 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.
216 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]217
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]218The 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]219
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]220For 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]221
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]222You 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]223
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]224To 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]225
226Returns:
227 An object of the form:
228
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]229 { # Contains a list of Snapshot resources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]230 "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.
231 "items": [ # [Output Only] A list of Snapshot resources.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]232 { # A persistent disk snapshot resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]233 "status": "A String", # [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]234 "kind": "compute#snapshot", # [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]235 "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.
236 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
237 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
238 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]239 "storageBytes": "A String", # [Output Only] A size of the the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]240 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
241 "sourceDisk": "A String", # [Output Only] The source disk used to create this snapshot.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]242 "snapshotEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the snapshot using a customer-supplied encryption key.
243 #
244 # After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the image later For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request.
245 #
246 # Customer-supplied encryption keys do not protect access to metadata of the disk.
247 #
248 # If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later.
249 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
250 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
251 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]252 "storageBytesStatus": "A String", # [Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]253 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set 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.
254 #
255 # To see the latest fingerprint, make a get() request to retrieve a snapshot.
256 "labels": { # Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty.
257 "a_key": "A String",
258 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]259 "sourceDiskId": "A String", # [Output Only] The ID value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name.
260 "diskSizeGb": "A String", # [Output Only] Size of the snapshot, specified in GB.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]261 "licenses": [ # [Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]262 "A String",
263 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]264 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]265 "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]266 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
267 "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]268 },
269 ],
270 "kind": "compute#snapshotList", # Type of resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]271 "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]272 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]273 }</pre>
274</div>
275
276<div class="method">
277 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
278 <pre>Retrieves the next page of results.
279
280Args:
281 previous_request: The request for the previous page. (required)
282 previous_response: The response from the request for the previous page. (required)
283
284Returns:
285 A request object that you can call 'execute()' on to request the next
286 page. Returns None if there are no more items in the collection.
287 </pre>
288</div>
289
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]290<div class="method">
291 <code class="details" id="setLabels">setLabels(project, resource, body)</code>
292 <pre>Sets the labels on a snapshot. To learn more about labels, read the Labeling or Tagging Resources documentation.
293
294Args:
295 project: string, Project ID for this request. (required)
296 resource: string, Name of the resource for this request. (required)
297 body: object, The request body. (required)
298 The object takes the form of:
299
300{
301 "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.
302 "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": "").
303 "a_key": "A String",
304 },
305 }
306
307
308Returns:
309 An object of the form:
310
311 { # An Operation resource, used to manage asynchronous API requests.
312 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
313 "clientOperationId": "A String", # [Output Only] Reserved for future use.
314 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
315 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
316 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
317 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
318 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
319 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
320 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
321 "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.
322 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
323 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
324 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
325 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
326 {
327 "message": "A String", # [Output Only] A human-readable description of the warning code.
328 "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.
329 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
330 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
331 {
332 "value": "A String", # [Output Only] A warning data value corresponding to the key.
333 "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).
334 },
335 ],
336 },
337 ],
338 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
339 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
340 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
341 "name": "A String", # [Output Only] Name of the resource.
342 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
343 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
344 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
345 {
346 "message": "A String", # [Output Only] An optional, human-readable error message.
347 "code": "A String", # [Output Only] The error type identifier for this error.
348 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
349 },
350 ],
351 },
352 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
353 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
354 "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.
355 }</pre>
356</div>
357
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]358</body></html>