Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 7578da5dc1ea87d1992fda18898270eb8253a2c6 / . / docs / dyn / compute_v1beta12.disks.html
blob: b0d5d5d9a61f2aa6a8af0a2d4ba2f6e6c2cb2997 [file] [log] [blame]
Joe Gregorio075572b2012-07-09 16:53:09 -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_v1beta12.html">Compute Engine API</a> . <a href="compute_v1beta12.disks.html">disks</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(project, disk)</a></code></p>
79<p class="firstline">Deletes the specified persistent disk resource.</p>
80<p class="toc_element">
81 <code><a href="#get">get(project, disk)</a></code></p>
82<p class="firstline">Returns the specified persistent disk 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 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 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, disk)</code>
95 <pre>Deletes the specified persistent disk resource.
96
97Args:
98 project: string, Name of the project scoping this request. (required)
99 disk: string, Name of the persistent disk resource to delete. (required)
100
101Returns:
102 An object of the form:
103
104 {
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.
108 "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
109 "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
110 "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
111 "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
112 "errors": [ # The array of errors encountered while processing this operation.
113 {
114 "message": "A String", # An optional, human-readable error message.
115 "code": "A String", # The error type identifier for this error.
116 "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
117 },
118 ],
119 },
120 "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
121 "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
122 "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
123 "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
124 "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
125 "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).
126 "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).
127 "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
128 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
129 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
130 "selfLink": "A String", # Server defined URL for the resource (output only).
131 "targetLink": "A String", # URL of the resource the operation is mutating (output only).
132 }</pre>
133</div>
134
135<div class="method">
136 <code class="details" id="get">get(project, disk)</code>
137 <pre>Returns the specified persistent disk resource.
138
139Args:
140 project: string, Name of the project scoping this request. (required)
141 disk: string, Name of the persistent disk resource to return. (required)
142
143Returns:
144 An object of the form:
145
146 {
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame^]147 "status": "A String", # The status of disk creation (output only).
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]148 "sourceSnapshot": "A String", # The source snapshot used to create this disk. Once the source snapshot has been deleted from the system, this field will be cleared, and will not be set even if a snapshot with the same name has been re-created.
149 "kind": "compute#disk", # Type of the resource.
150 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
151 "sizeGb": "A String", # Size of the persistent disk, specified in GB.
152 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
153 "sourceSnapshotId": "A String", # The 'id' value of the snapshot used to create this disk. This value may be used to determine whether the disk was created from the current or a previous instance of a given disk snapshot.
154 "zone": "A String", # URL for the zone where the persistent disk resides; provided by the client when the disk is created. A persistent disk must reside in the same zone as the instance to which it is attached.
155 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
156 "options": "A String", # Internal use only.
157 "selfLink": "A String", # Server defined URL for the resource (output only).
158 "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.
159 }</pre>
160</div>
161
162<div class="method">
163 <code class="details" id="insert">insert(project, body)</code>
164 <pre>Creates a persistent disk resource in the specified project using the data included in the request.
165
166Args:
167 project: string, Name of the project scoping this request. (required)
168 body: object, The request body. (required)
169 The object takes the form of:
170
171{
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame^]172 "status": "A String", # The status of disk creation (output only).
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]173 "sourceSnapshot": "A String", # The source snapshot used to create this disk. Once the source snapshot has been deleted from the system, this field will be cleared, and will not be set even if a snapshot with the same name has been re-created.
174 "kind": "compute#disk", # Type of the resource.
175 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
176 "sizeGb": "A String", # Size of the persistent disk, specified in GB.
177 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
178 "sourceSnapshotId": "A String", # The 'id' value of the snapshot used to create this disk. This value may be used to determine whether the disk was created from the current or a previous instance of a given disk snapshot.
179 "zone": "A String", # URL for the zone where the persistent disk resides; provided by the client when the disk is created. A persistent disk must reside in the same zone as the instance to which it is attached.
180 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
181 "options": "A String", # Internal use only.
182 "selfLink": "A String", # Server defined URL for the resource (output only).
183 "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.
184 }
185
186
187Returns:
188 An object of the form:
189
190 {
191 "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
192 "kind": "compute#operation", # Type of the resource.
193 "name": "A String", # Name of the resource.
194 "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
195 "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
196 "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
197 "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
198 "errors": [ # The array of errors encountered while processing this operation.
199 {
200 "message": "A String", # An optional, human-readable error message.
201 "code": "A String", # The error type identifier for this error.
202 "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
203 },
204 ],
205 },
206 "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
207 "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
208 "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
209 "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
210 "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
211 "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).
212 "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).
213 "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
214 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
215 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
216 "selfLink": "A String", # Server defined URL for the resource (output only).
217 "targetLink": "A String", # URL of the resource the operation is mutating (output only).
218 }</pre>
219</div>
220
221<div class="method">
222 <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
223 <pre>Retrieves the list of persistent disk resources contained within the specified project.
224
225Args:
226 project: string, Name of the project scoping this request. (required)
227 maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
228 pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
229 filter: string, Optional. Filter expression for filtering listed resources.
230
231Returns:
232 An object of the form:
233
234 {
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame^]235 "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]236 "items": [ # The persistent disk resources.
237 {
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame^]238 "status": "A String", # The status of disk creation (output only).
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]239 "sourceSnapshot": "A String", # The source snapshot used to create this disk. Once the source snapshot has been deleted from the system, this field will be cleared, and will not be set even if a snapshot with the same name has been re-created.
240 "kind": "compute#disk", # Type of the resource.
241 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
242 "sizeGb": "A String", # Size of the persistent disk, specified in GB.
243 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
244 "sourceSnapshotId": "A String", # The 'id' value of the snapshot used to create this disk. This value may be used to determine whether the disk was created from the current or a previous instance of a given disk snapshot.
245 "zone": "A String", # URL for the zone where the persistent disk resides; provided by the client when the disk is created. A persistent disk must reside in the same zone as the instance to which it is attached.
246 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
247 "options": "A String", # Internal use only.
248 "selfLink": "A String", # Server defined URL for the resource (output only).
249 "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.
250 },
251 ],
252 "kind": "compute#diskList", # Type of resource.
253 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
254 "selfLink": "A String", # Server defined URL for this resource (output only).
255 }</pre>
256</div>
257
258<div class="method">
259 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
260 <pre>Retrieves the next page of results.
261
262Args:
263 previous_request: The request for the previous page. (required)
264 previous_response: The response from the request for the previous page. (required)
265
266Returns:
267 A request object that you can call 'execute()' on to request the next
268 page. Returns None if there are no more items in the collection.
269 </pre>
270</div>
271
272</body></html>