Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / f80be181200f4aae910badec3f4bddea08ae5044 / . / docs / dyn / cloudshell_v1.operations.html
blob: fabb5e071c8c64128d287e54027e30c348d6674e [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[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="cloudshell_v1.html">Cloud Shell API</a> . <a href="cloudshell_v1.operations.html">operations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#cancel">cancel(name, body=None, x__xgafv=None)</a></code></p>
79<p class="firstline">Starts asynchronous cancellation on a long-running operation. The server</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes a long-running operation. This method indicates that the client is</p>
83<p class="toc_element">
84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
85<p class="firstline">Gets the latest state of a long-running operation. Clients can use this</p>
86<p class="toc_element">
87 <code><a href="#list">list(name, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</a></code></p>
88<p class="firstline">Lists operations that match the specified filter in the request. If the</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="cancel">cancel(name, body=None, x__xgafv=None)</code>
95 <pre>Starts asynchronous cancellation on a long-running operation. The server
96makes a best effort to cancel the operation, but success is not
97guaranteed. If the server doesn't support this method, it returns
98`google.rpc.Code.UNIMPLEMENTED`. Clients can use
99Operations.GetOperation or
100other methods to check whether the cancellation succeeded or whether the
101operation completed despite cancellation. On successful cancellation,
102the operation is not deleted; instead, it becomes an operation with
103an Operation.error value with a google.rpc.Status.code of 1,
104corresponding to `Code.CANCELLED`.
105
106Args:
107 name: string, The name of the operation resource to be cancelled. (required)
108 body: object, The request body.
109 The object takes the form of:
110
111{ # The request message for Operations.CancelOperation.
112 }
113
114 x__xgafv: string, V1 error format.
115 Allowed values
116 1 - v1 error format
117 2 - v2 error format
118
119Returns:
120 An object of the form:
121
122 { # A generic empty message that you can re-use to avoid defining duplicated
123 # empty messages in your APIs. A typical example is to use it as the request
124 # or the response type of an API method. For instance:
125 #
126 # service Foo {
127 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
128 # }
129 #
130 # The JSON representation for `Empty` is empty JSON object `{}`.
131 }</pre>
132</div>
133
134<div class="method">
135 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
136 <pre>Deletes a long-running operation. This method indicates that the client is
137no longer interested in the operation result. It does not cancel the
138operation. If the server doesn't support this method, it returns
139`google.rpc.Code.UNIMPLEMENTED`.
140
141Args:
142 name: string, The name of the operation resource to be deleted. (required)
143 x__xgafv: string, V1 error format.
144 Allowed values
145 1 - v1 error format
146 2 - v2 error format
147
148Returns:
149 An object of the form:
150
151 { # A generic empty message that you can re-use to avoid defining duplicated
152 # empty messages in your APIs. A typical example is to use it as the request
153 # or the response type of an API method. For instance:
154 #
155 # service Foo {
156 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
157 # }
158 #
159 # The JSON representation for `Empty` is empty JSON object `{}`.
160 }</pre>
161</div>
162
163<div class="method">
164 <code class="details" id="get">get(name, x__xgafv=None)</code>
165 <pre>Gets the latest state of a long-running operation. Clients can use this
166method to poll the operation result at intervals as recommended by the API
167service.
168
169Args:
170 name: string, The name of the operation resource. (required)
171 x__xgafv: string, V1 error format.
172 Allowed values
173 1 - v1 error format
174 2 - v2 error format
175
176Returns:
177 An object of the form:
178
179 { # This resource represents a long-running operation that is the result of a
180 # network API call.
181 "metadata": { # Service-specific metadata associated with the operation. It typically
182 # contains progress information and common metadata such as create time.
183 # Some services might not provide such metadata. Any method that returns a
184 # long-running operation should document the metadata type, if any.
185 "a_key": "", # Properties of the object. Contains field @type with type URL.
186 },
187 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
188 # different programming environments, including REST APIs and RPC APIs. It is
189 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
190 # three pieces of data: error code, error message, and error details.
191 #
192 # You can find out more about this error model and how to work with it in the
193 # [API Design Guide](https://cloud.google.com/apis/design/errors).
194 "message": "A String", # A developer-facing error message, which should be in English. Any
195 # user-facing error message should be localized and sent in the
196 # google.rpc.Status.details field, or localized by the client.
197 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
198 "details": [ # A list of messages that carry the error details. There is a common set of
199 # message types for APIs to use.
200 {
201 "a_key": "", # Properties of the object. Contains field @type with type URL.
202 },
203 ],
204 },
205 "done": True or False, # If the value is `false`, it means the operation is still in progress.
206 # If `true`, the operation is completed, and either `error` or `response` is
207 # available.
208 "response": { # The normal response of the operation in case of success. If the original
209 # method returns no data on success, such as `Delete`, the response is
210 # `google.protobuf.Empty`. If the original method is standard
211 # `Get`/`Create`/`Update`, the response should be the resource. For other
212 # methods, the response should have the type `XxxResponse`, where `Xxx`
213 # is the original method name. For example, if the original method name
214 # is `TakeSnapshot()`, the inferred response type is
215 # `TakeSnapshotResponse`.
216 "a_key": "", # Properties of the object. Contains field @type with type URL.
217 },
218 "name": "A String", # The server-assigned name, which is only unique within the same service that
219 # originally returns it. If you use the default HTTP mapping, the
220 # `name` should be a resource name ending with `operations/{unique_id}`.
221 }</pre>
222</div>
223
224<div class="method">
225 <code class="details" id="list">list(name, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</code>
226 <pre>Lists operations that match the specified filter in the request. If the
227server doesn't support this method, it returns `UNIMPLEMENTED`.
228
229NOTE: the `name` binding allows API services to override the binding
230to use different resource name schemes, such as `users/*/operations`. To
231override the binding, API services can add a binding such as
232`"/v1/{name=users/*}/operations"` to their service configuration.
233For backwards compatibility, the default name includes the operations
234collection id, however overriding users must ensure the name binding
235is the parent resource, without the operations collection id.
236
237Args:
238 name: string, The name of the operation's parent resource. (required)
239 pageToken: string, The standard list page token.
240 x__xgafv: string, V1 error format.
241 Allowed values
242 1 - v1 error format
243 2 - v2 error format
244 pageSize: integer, The standard list page size.
245 filter: string, The standard list filter.
246
247Returns:
248 An object of the form:
249
250 { # The response message for Operations.ListOperations.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]251 "operations": [ # A list of operations that matches the specified filter in the request.
252 { # This resource represents a long-running operation that is the result of a
253 # network API call.
254 "metadata": { # Service-specific metadata associated with the operation. It typically
255 # contains progress information and common metadata such as create time.
256 # Some services might not provide such metadata. Any method that returns a
257 # long-running operation should document the metadata type, if any.
258 "a_key": "", # Properties of the object. Contains field @type with type URL.
259 },
260 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
261 # different programming environments, including REST APIs and RPC APIs. It is
262 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
263 # three pieces of data: error code, error message, and error details.
264 #
265 # You can find out more about this error model and how to work with it in the
266 # [API Design Guide](https://cloud.google.com/apis/design/errors).
267 "message": "A String", # A developer-facing error message, which should be in English. Any
268 # user-facing error message should be localized and sent in the
269 # google.rpc.Status.details field, or localized by the client.
270 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
271 "details": [ # A list of messages that carry the error details. There is a common set of
272 # message types for APIs to use.
273 {
274 "a_key": "", # Properties of the object. Contains field @type with type URL.
275 },
276 ],
277 },
278 "done": True or False, # If the value is `false`, it means the operation is still in progress.
279 # If `true`, the operation is completed, and either `error` or `response` is
280 # available.
281 "response": { # The normal response of the operation in case of success. If the original
282 # method returns no data on success, such as `Delete`, the response is
283 # `google.protobuf.Empty`. If the original method is standard
284 # `Get`/`Create`/`Update`, the response should be the resource. For other
285 # methods, the response should have the type `XxxResponse`, where `Xxx`
286 # is the original method name. For example, if the original method name
287 # is `TakeSnapshot()`, the inferred response type is
288 # `TakeSnapshotResponse`.
289 "a_key": "", # Properties of the object. Contains field @type with type URL.
290 },
291 "name": "A String", # The server-assigned name, which is only unique within the same service that
292 # originally returns it. If you use the default HTTP mapping, the
293 # `name` should be a resource name ending with `operations/{unique_id}`.
294 },
295 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]296 "nextPageToken": "A String", # The standard List next-page token.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]297 }</pre>
298</div>
299
300<div class="method">
301 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
302 <pre>Retrieves the next page of results.
303
304Args:
305 previous_request: The request for the previous page. (required)
306 previous_response: The response from the request for the previous page. (required)
307
308Returns:
309 A request object that you can call 'execute()' on to request the next
310 page. Returns None if there are no more items in the collection.
311 </pre>
312</div>
313
314</body></html>