Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / e633be11dbb412e5030b5afca31111fa4074dff1 / . / docs / dyn / compute_v1.snapshots.html
blob: 2b94c56f30b266298c4b73ada4602b805fe62060 [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>
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="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
85<p class="firstline">Retrieves the list of persistent disk snapshot resources contained within the specified project.</p>
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>
89<h3>Method Details</h3>
90<div class="method">
91 <code class="details" id="delete">delete(project, snapshot)</code>
92 <pre>Deletes the specified persistent disk snapshot resource.
93
94Args:
95 project: string, Name of the project scoping this request. (required)
96 snapshot: string, Name of the persistent disk snapshot resource to delete. (required)
97
98Returns:
99 An object of the form:
100
101 { # An operation resource, used to manage asynchronous API requests.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]102 "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
103 "clientOperationId": "A String",
104 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
105 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
106 "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
107 "operationType": "A String",
108 "httpErrorMessage": "A String",
109 "progress": 42,
110 "httpErrorStatusCode": 42,
111 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
112 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
113 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
114 "warnings": [
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]115 {
116 "message": "A String", # Optional human-readable details for this warning.
117 "code": "A String", # The warning type identifier for this warning.
118 "data": [ # Metadata for this warning in 'key: value' format.
119 {
120 "value": "A String", # A warning data value corresponding to the key.
121 "key": "A String", # A key for the warning data.
122 },
123 ],
124 },
125 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]126 "user": "A String",
127 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
128 "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
129 "name": "A String", # [Output Only] Name of the resource (output only).
130 "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
131 "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
132 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]133 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]134 "message": "A String", # [Output Only] An optional, human-readable error message.
135 "code": "A String", # [Output Only] The error type identifier for this error.
136 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]137 },
138 ],
139 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]140 "endTime": "A String",
141 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
142 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]143 }</pre>
144</div>
145
146<div class="method">
147 <code class="details" id="get">get(project, snapshot)</code>
148 <pre>Returns the specified persistent disk snapshot resource.
149
150Args:
151 project: string, Name of the project scoping this request. (required)
152 snapshot: string, Name of the persistent disk snapshot resource to return. (required)
153
154Returns:
155 An object of the form:
156
157 { # A persistent disk snapshot resource.
158 "status": "A String", # The status of the persistent disk snapshot (output only).
159 "kind": "compute#snapshot", # Type of the resource.
160 "storageBytes": "A String", # A size of the the storage used by the snapshot. As snapshots share storage this number is expected to change with snapshot creation/deletion.
161 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]162 "sourceDisk": "A String", # The source disk used to create this snapshot.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]163 "storageBytesStatus": "A String", # An indicator whether storageBytes is in a stable state, or it is being adjusted as a result of shared storage reallocation.
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).
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]166 "licenses": [ # Public visible licenses.
167 "A String",
168 ],
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]169 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
170 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
171 "selfLink": "A String", # Server defined URL for the resource (output only).
172 "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.
173 }</pre>
174</div>
175
176<div class="method">
177 <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
178 <pre>Retrieves the list of persistent disk snapshot resources contained within the specified project.
179
180Args:
181 project: string, Name of the project scoping this request. (required)
182 maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
183 pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
184 filter: string, Optional. Filter expression for filtering listed resources.
185
186Returns:
187 An object of the form:
188
189 { # Contains a list of persistent disk snapshot resources.
190 "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]191 "items": [ # A list of Snapshot resources.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]192 { # A persistent disk snapshot resource.
193 "status": "A String", # The status of the persistent disk snapshot (output only).
194 "kind": "compute#snapshot", # Type of the resource.
195 "storageBytes": "A String", # A size of the the storage used by the snapshot. As snapshots share storage this number is expected to change with snapshot creation/deletion.
196 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]197 "sourceDisk": "A String", # The source disk used to create this snapshot.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]198 "storageBytesStatus": "A String", # An indicator whether storageBytes is in a stable state, or it is being adjusted as a result of shared storage reallocation.
199 "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.
200 "diskSizeGb": "A String", # Size of the persistent disk snapshot, specified in GB (output only).
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]201 "licenses": [ # Public visible licenses.
202 "A String",
203 ],
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]204 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
205 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
206 "selfLink": "A String", # Server defined URL for the resource (output only).
207 "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.
208 },
209 ],
210 "kind": "compute#snapshotList", # Type of resource.
211 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
212 "selfLink": "A String", # Server defined URL for this resource (output only).
213 }</pre>
214</div>
215
216<div class="method">
217 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
218 <pre>Retrieves the next page of results.
219
220Args:
221 previous_request: The request for the previous page. (required)
222 previous_response: The response from the request for the previous page. (required)
223
224Returns:
225 A request object that you can call 'execute()' on to request the next
226 page. Returns None if there are no more items in the collection.
227 </pre>
228</div>
229
230</body></html>