Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c72efbc6b71c963997c5728d471c04ab33d95e4f / . / docs / dyn / cloudshell_v1.operations.html
blob: d782c5bedfeddae1b8a14c65147396b8d8193d1a [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">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]87 <code><a href="#list">list(name, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]97guaranteed. If the server doesn&#x27;t support this method, it returns
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]138operation. If the server doesn&#x27;t support this method, it returns
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]181 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
182 # If `true`, the operation is completed, and either `error` or `response` is
183 # available.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]184 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]185 # method returns no data on success, such as `Delete`, the response is
186 # `google.protobuf.Empty`. If the original method is standard
187 # `Get`/`Create`/`Update`, the response should be the resource. For other
188 # methods, the response should have the type `XxxResponse`, where `Xxx`
189 # is the original method name. For example, if the original method name
190 # is `TakeSnapshot()`, the inferred response type is
191 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]192 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]193 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]194 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]195 # originally returns it. If you use the default HTTP mapping, the
196 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]197 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
198 # different programming environments, including REST APIs and RPC APIs. It is
199 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
200 # three pieces of data: error code, error message, and error details.
201 #
202 # You can find out more about this error model and how to work with it in the
203 # [API Design Guide](https://cloud.google.com/apis/design/errors).
204 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
205 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
206 # user-facing error message should be localized and sent in the
207 # google.rpc.Status.details field, or localized by the client.
208 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
209 # message types for APIs to use.
210 {
211 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
212 },
213 ],
214 },
215 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
216 # contains progress information and common metadata such as create time.
217 # Some services might not provide such metadata. Any method that returns a
218 # long-running operation should document the metadata type, if any.
219 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
220 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]221 }</pre>
222</div>
223
224<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]225 <code class="details" id="list">list(name, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]226 <pre>Lists operations that match the specified filter in the request. If the
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]227server doesn&#x27;t support this method, it returns `UNIMPLEMENTED`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]232`&quot;/v1/{name=users/*}/operations&quot;` to their service configuration.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]238 name: string, The name of the operation&#x27;s parent resource. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]239 filter: string, The standard list filter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]240 pageToken: string, The standard list page token.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]241 pageSize: integer, The standard list page size.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]242 x__xgafv: string, V1 error format.
243 Allowed values
244 1 - v1 error format
245 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]246
247Returns:
248 An object of the form:
249
250 { # The response message for Operations.ListOperations.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]251 &quot;nextPageToken&quot;: &quot;A String&quot;, # The standard List next-page token.
252 &quot;operations&quot;: [ # A list of operations that matches the specified filter in the request.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]253 { # This resource represents a long-running operation that is the result of a
254 # network API call.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]255 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
256 # If `true`, the operation is completed, and either `error` or `response` is
257 # available.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]258 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]259 # method returns no data on success, such as `Delete`, the response is
260 # `google.protobuf.Empty`. If the original method is standard
261 # `Get`/`Create`/`Update`, the response should be the resource. For other
262 # methods, the response should have the type `XxxResponse`, where `Xxx`
263 # is the original method name. For example, if the original method name
264 # is `TakeSnapshot()`, the inferred response type is
265 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]266 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]267 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]268 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]269 # originally returns it. If you use the default HTTP mapping, the
270 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]271 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
272 # different programming environments, including REST APIs and RPC APIs. It is
273 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
274 # three pieces of data: error code, error message, and error details.
275 #
276 # You can find out more about this error model and how to work with it in the
277 # [API Design Guide](https://cloud.google.com/apis/design/errors).
278 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
279 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
280 # user-facing error message should be localized and sent in the
281 # google.rpc.Status.details field, or localized by the client.
282 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
283 # message types for APIs to use.
284 {
285 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
286 },
287 ],
288 },
289 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
290 # contains progress information and common metadata such as create time.
291 # Some services might not provide such metadata. Any method that returns a
292 # long-running operation should document the metadata type, if any.
293 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
294 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]295 },
296 ],
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:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]309 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]310 page. Returns None if there are no more items in the collection.
311 </pre>
312</div>
313
314</body></html>