Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 5cbe5baf3fad3d67e05b9387e8d81de7ce99aeb9 / . / docs / dyn / compute_v1.zoneOperations.html
blob: 5114bc30d75fa06a44d721b42d88691ece35cf76 [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.zoneOperations.html">zoneOperations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(project, zone, operation)</a></code></p>
79<p class="firstline">Deletes the specified zone-specific operation resource.</p>
80<p class="toc_element">
81 <code><a href="#get">get(project, zone, operation)</a></code></p>
82<p class="firstline">Retrieves the specified zone-specific operation resource.</p>
83<p class="toc_element">
84 <code><a href="#list">list(project, zone, maxResults=None, pageToken=None, filter=None)</a></code></p>
85<p class="firstline">Retrieves the list of operation resources contained within the specified zone.</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, zone, operation)</code>
92 <pre>Deletes the specified zone-specific operation resource.
93
94Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]95 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]96 zone: string, Name of the zone scoping this request. (required)
97 operation: string, Name of the operation resource to delete. (required)
98</pre>
99</div>
100
101<div class="method">
102 <code class="details" id="get">get(project, zone, operation)</code>
103 <pre>Retrieves the specified zone-specific operation resource.
104
105Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]106 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]107 zone: string, Name of the zone scoping this request. (required)
108 operation: string, Name of the operation resource to return. (required)
109
110Returns:
111 An object of the form:
112
113 { # An operation resource, used to manage asynchronous API requests.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]114 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
115 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
116 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]117 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]118 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
119 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
120 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
121 "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 at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
122 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]123 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]124 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
125 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
126 "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]127 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]128 "message": "A String", # [Output Only] Optional human-readable details for this warning.
129 "code": "A String", # [Output Only] The warning type identifier for this warning.
130 "data": [ # [Output Only] Metadata for this warning in key: value format.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]131 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]132 "value": "A String", # [Output Only] A warning data value corresponding to the key.
133 "key": "A String", # [Output Only] A key for the warning data.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]134 },
135 ],
136 },
137 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]138 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
139 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
140 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
141 "name": "A String", # [Output Only] Name of the resource.
142 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
143 "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]144 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]145 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]146 "message": "A String", # [Output Only] An optional, human-readable error message.
147 "code": "A String", # [Output Only] The error type identifier for this error.
148 "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]149 },
150 ],
151 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]152 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]153 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]154 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]155 }</pre>
156</div>
157
158<div class="method">
159 <code class="details" id="list">list(project, zone, maxResults=None, pageToken=None, filter=None)</code>
160 <pre>Retrieves the list of operation resources contained within the specified zone.
161
162Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]163 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]164 zone: string, Name of the zone scoping this request. (required)
165 maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
166 pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
167 filter: string, Optional. Filter expression for filtering listed resources.
168
169Returns:
170 An object of the form:
171
172 { # Contains a list of operation resources.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]173 "nextPageToken": "A String", # [Output Only] A token used to continue a truncate.
174 "items": [ # [Output Only] The operation resources.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]175 { # An operation resource, used to manage asynchronous API requests.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]176 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
177 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project
178 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]179 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]180 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
181 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
182 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
183 "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 at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
184 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]185 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]186 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
187 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
188 "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]189 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]190 "message": "A String", # [Output Only] Optional human-readable details for this warning.
191 "code": "A String", # [Output Only] The warning type identifier for this warning.
192 "data": [ # [Output Only] Metadata for this warning in key: value format.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]193 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]194 "value": "A String", # [Output Only] A warning data value corresponding to the key.
195 "key": "A String", # [Output Only] A key for the warning data.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]196 },
197 ],
198 },
199 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]200 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
201 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
202 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
203 "name": "A String", # [Output Only] Name of the resource.
204 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
205 "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]206 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]207 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]208 "message": "A String", # [Output Only] An optional, human-readable error message.
209 "code": "A String", # [Output Only] The error type identifier for this error.
210 "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]211 },
212 ],
213 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]214 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]215 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]216 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]217 },
218 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]219 "kind": "compute#operationList", # [Output Only] Type of resource. Always compute#operations for Operations resource.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]220 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
221 "selfLink": "A String", # [Output Only] Server defined URL for this resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]222 }</pre>
223</div>
224
225<div class="method">
226 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
227 <pre>Retrieves the next page of results.
228
229Args:
230 previous_request: The request for the previous page. (required)
231 previous_response: The response from the request for the previous page. (required)
232
233Returns:
234 A request object that you can call 'execute()' on to request the next
235 page. Returns None if there are no more items in the collection.
236 </pre>
237</div>
238
239</body></html>