Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0669410c6b2c48884ae31671b9d710a9ff6346c6 / . / docs / dyn / compute_v1.zoneOperations.html
blob: 8b33ef645c4e0f26e3d8e5ab490039a67fba88ba [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>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]79<p class="firstline">Deletes the specified zone-specific Operations resource.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]80<p class="toc_element">
81 <code><a href="#get">get(project, zone, operation)</a></code></p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]82<p class="firstline">Retrieves the specified zone-specific Operations resource.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]83<p class="toc_element">
84 <code><a href="#list">list(project, zone, 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 Operation resources contained within the specified zone.</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>
89<h3>Method Details</h3>
90<div class="method">
91 <code class="details" id="delete">delete(project, zone, operation)</code>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]92 <pre>Deletes the specified zone-specific Operations resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]97 operation: string, Name of the Operations resource to delete. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]98</pre>
99</div>
100
101<div class="method">
102 <code class="details" id="get">get(project, zone, operation)</code>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]103 <pre>Retrieves the specified zone-specific Operations resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]108 operation: string, Name of the Operations resource to return. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]109
110Returns:
111 An object of the form:
112
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]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.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]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 monotonically increase as the operation progresses.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[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>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]160 <pre>Retrieves the list of Operation resources contained within the specified zone.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]165 maxResults: integer, Maximum count of results to be returned.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]166 pageToken: string, Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.
167 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.
168
169The 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 (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.
170
171For example, filter=name ne example-instance.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]172
173Returns:
174 An object of the form:
175
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]176 { # Contains a list of Operation resources.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]177 "nextPageToken": "A String", # [Output Only] A token used to continue a truncate.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]178 "items": [ # [Output Only] The Operation resources.
179 { # An Operation resource, used to manage asynchronous API requests.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]180 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]181 "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.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]182 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]183 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]184 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
185 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
186 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]187 "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 monotonically increase as the operation progresses.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]188 "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]189 "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]190 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
191 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
192 "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]193 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]194 "message": "A String", # [Output Only] Optional human-readable details for this warning.
195 "code": "A String", # [Output Only] The warning type identifier for this warning.
196 "data": [ # [Output Only] Metadata for this warning in key: value format.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]197 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]198 "value": "A String", # [Output Only] A warning data value corresponding to the key.
199 "key": "A String", # [Output Only] A key for the warning data.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]200 },
201 ],
202 },
203 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]204 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
205 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
206 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
207 "name": "A String", # [Output Only] Name of the resource.
208 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
209 "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]210 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]211 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]212 "message": "A String", # [Output Only] An optional, human-readable error message.
213 "code": "A String", # [Output Only] The error type identifier for this error.
214 "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]215 },
216 ],
217 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]218 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]219 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]220 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]221 },
222 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]223 "kind": "compute#operationList", # [Output Only] Type of resource. Always compute#operations for Operations resource.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]224 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]225 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]226 }</pre>
227</div>
228
229<div class="method">
230 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
231 <pre>Retrieves the next page of results.
232
233Args:
234 previous_request: The request for the previous page. (required)
235 previous_response: The response from the request for the previous page. (required)
236
237Returns:
238 A request object that you can call 'execute()' on to request the next
239 page. Returns None if there are no more items in the collection.
240 </pre>
241</div>
242
243</body></html>