Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 48d10b04b5498b3f9a96bd9a49d30ae6000bbeac / . / docs / dyn / compute_v1beta14.snapshots.html
blob: e140952a2d0fe2de7a6dd20ffba48d7de2bdeba7 [file] [log] [blame]
Joe Gregoriob8006ce2013-03-07 10:33:19 -0500[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_v1beta14.html">Compute Engine API</a> . <a href="compute_v1beta14.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>
79<p class="firstline">Deletes the specified persistent disk snapshot resource.</p>
80<p class="toc_element">
81 <code><a href="#get">get(project, snapshot)</a></code></p>
82<p class="firstline">Returns the specified persistent disk snapshot resource.</p>
83<p class="toc_element">
84 <code><a href="#insert">insert(project, body)</a></code></p>
85<p class="firstline">Creates a persistent disk snapshot resource in the specified project using the data included in the request.</p>
86<p class="toc_element">
87 <code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
88<p class="firstline">Retrieves the list of persistent disk snapshot resources contained within the specified project.</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="delete">delete(project, snapshot)</code>
95 <pre>Deletes the specified persistent disk snapshot resource.
96
97Args:
98 project: string, Name of the project scoping this request. (required)
99 snapshot: string, Name of the persistent disk snapshot resource to delete. (required)
100
101Returns:
102 An object of the form:
103
104 { # An operation resource, used to manage asynchronous API requests.
105 "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
106 "kind": "compute#operation", # Type of the resource.
107 "name": "A String", # Name of the resource (output only).
108 "zone": "A String", # URL of the zone where the operation resides (output only).
109 "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
110 {
111 "message": "A String", # Optional human-readable details for this warning.
112 "code": "A String", # The warning type identifier for this warning.
113 "data": [ # Metadata for this warning in 'key: value' format.
114 {
115 "value": "A String", # A warning data value corresponding to the key.
116 "key": "A String", # A key for the warning data.
117 },
118 ],
119 },
120 ],
121 "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
122 "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
123 "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
124 "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
125 "errors": [ # The array of errors encountered while processing this operation.
126 {
127 "message": "A String", # An optional, human-readable error message.
128 "code": "A String", # The error type identifier for this error.
129 "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
130 },
131 ],
132 },
133 "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
134 "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
135 "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
136 "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
137 "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
138 "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
139 "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
140 "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
141 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
142 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
143 "selfLink": "A String", # Server defined URL for the resource (output only).
144 "targetLink": "A String", # URL of the resource the operation is mutating (output only).
145 }</pre>
146</div>
147
148<div class="method">
149 <code class="details" id="get">get(project, snapshot)</code>
150 <pre>Returns the specified persistent disk snapshot resource.
151
152Args:
153 project: string, Name of the project scoping this request. (required)
154 snapshot: string, Name of the persistent disk snapshot resource to return. (required)
155
156Returns:
157 An object of the form:
158
159 { # A persistent disk snapshot resource.
160 "status": "A String", # The status of the persistent disk snapshot (output only).
161 "kind": "compute#snapshot", # Type of the resource.
162 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
163 "sourceDisk": "A String", # The source disk used to create this snapshot. Once the source disk has been deleted from the system, this field will be cleared, and will not be set even if a disk with the same name has been re-created.
164 "sourceDiskId": "A String", # 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.
165 "diskSizeGb": "A String", # Size of the persistent disk snapshot, specified in GB (output only).
166 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
167 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
168 "selfLink": "A String", # Server defined URL for the resource (output only).
169 "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.
170 }</pre>
171</div>
172
173<div class="method">
174 <code class="details" id="insert">insert(project, body)</code>
175 <pre>Creates a persistent disk snapshot resource in the specified project using the data included in the request.
176
177Args:
178 project: string, Name of the project scoping this request. (required)
179 body: object, The request body. (required)
180 The object takes the form of:
181
182{ # A persistent disk snapshot resource.
183 "status": "A String", # The status of the persistent disk snapshot (output only).
184 "kind": "compute#snapshot", # Type of the resource.
185 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
186 "sourceDisk": "A String", # The source disk used to create this snapshot. Once the source disk has been deleted from the system, this field will be cleared, and will not be set even if a disk with the same name has been re-created.
187 "sourceDiskId": "A String", # 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.
188 "diskSizeGb": "A String", # Size of the persistent disk snapshot, specified in GB (output only).
189 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
190 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
191 "selfLink": "A String", # Server defined URL for the resource (output only).
192 "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.
193 }
194
195
196Returns:
197 An object of the form:
198
199 { # An operation resource, used to manage asynchronous API requests.
200 "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
201 "kind": "compute#operation", # Type of the resource.
202 "name": "A String", # Name of the resource (output only).
203 "zone": "A String", # URL of the zone where the operation resides (output only).
204 "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
205 {
206 "message": "A String", # Optional human-readable details for this warning.
207 "code": "A String", # The warning type identifier for this warning.
208 "data": [ # Metadata for this warning in 'key: value' format.
209 {
210 "value": "A String", # A warning data value corresponding to the key.
211 "key": "A String", # A key for the warning data.
212 },
213 ],
214 },
215 ],
216 "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
217 "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
218 "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
219 "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
220 "errors": [ # The array of errors encountered while processing this operation.
221 {
222 "message": "A String", # An optional, human-readable error message.
223 "code": "A String", # The error type identifier for this error.
224 "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
225 },
226 ],
227 },
228 "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
229 "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
230 "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
231 "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
232 "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
233 "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
234 "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
235 "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
236 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
237 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
238 "selfLink": "A String", # Server defined URL for the resource (output only).
239 "targetLink": "A String", # URL of the resource the operation is mutating (output only).
240 }</pre>
241</div>
242
243<div class="method">
244 <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
245 <pre>Retrieves the list of persistent disk snapshot resources contained within the specified project.
246
247Args:
248 project: string, Name of the project scoping this request. (required)
249 maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
250 pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
251 filter: string, Optional. Filter expression for filtering listed resources.
252
253Returns:
254 An object of the form:
255
256 { # Contains a list of persistent disk snapshot resources.
257 "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
258 "items": [ # The persistent snapshot resources.
259 { # A persistent disk snapshot resource.
260 "status": "A String", # The status of the persistent disk snapshot (output only).
261 "kind": "compute#snapshot", # Type of the resource.
262 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
263 "sourceDisk": "A String", # The source disk used to create this snapshot. Once the source disk has been deleted from the system, this field will be cleared, and will not be set even if a disk with the same name has been re-created.
264 "sourceDiskId": "A String", # 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.
265 "diskSizeGb": "A String", # Size of the persistent disk snapshot, specified in GB (output only).
266 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
267 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
268 "selfLink": "A String", # Server defined URL for the resource (output only).
269 "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.
270 },
271 ],
272 "kind": "compute#snapshotList", # Type of resource.
273 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
274 "selfLink": "A String", # Server defined URL for this resource (output only).
275 }</pre>
276</div>
277
278<div class="method">
279 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
280 <pre>Retrieves the next page of results.
281
282Args:
283 previous_request: The request for the previous page. (required)
284 previous_response: The response from the request for the previous page. (required)
285
286Returns:
287 A request object that you can call 'execute()' on to request the next
288 page. Returns None if there are no more items in the collection.
289 </pre>
290</div>
291
292</body></html>