Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 715bd7f9ca9a324a05ee05a6476af383e54930f9 / . / docs / dyn / file_v1beta1.projects.locations.operations.html
blob: 2962147923bdc1c6a6f47cc479301ff77e2eb049 [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="file_v1beta1.html">Cloud Filestore API</a> . <a href="file_v1beta1.projects.html">projects</a> . <a href="file_v1beta1.projects.locations.html">locations</a> . <a href="file_v1beta1.projects.locations.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 "response": { # The normal response of the operation in case of success. If the original
182 # method returns no data on success, such as `Delete`, the response is
183 # `google.protobuf.Empty`. If the original method is standard
184 # `Get`/`Create`/`Update`, the response should be the resource. For other
185 # methods, the response should have the type `XxxResponse`, where `Xxx`
186 # is the original method name. For example, if the original method name
187 # is `TakeSnapshot()`, the inferred response type is
188 # `TakeSnapshotResponse`.
189 "a_key": "", # Properties of the object. Contains field @type with type URL.
190 },
191 "metadata": { # Service-specific metadata associated with the operation. It typically
192 # contains progress information and common metadata such as create time.
193 # Some services might not provide such metadata. Any method that returns a
194 # long-running operation should document the metadata type, if any.
195 "a_key": "", # Properties of the object. Contains field @type with type URL.
196 },
197 "done": True or False, # If the value is `false`, it means the operation is still in progress.
198 # If `true`, the operation is completed, and either `error` or `response` is
199 # available.
200 "name": "A String", # The server-assigned name, which is only unique within the same service that
201 # originally returns it. If you use the default HTTP mapping, the
202 # `name` should be a resource name ending with `operations/{unique_id}`.
203 "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.
204 # different programming environments, including REST APIs and RPC APIs. It is
205 # used by [gRPC](https://github.com/grpc). The error model is designed to be:
206 #
207 # - Simple to use and understand for most users
208 # - Flexible enough to meet unexpected needs
209 #
210 # # Overview
211 #
212 # The `Status` message contains three pieces of data: error code, error
213 # message, and error details. The error code should be an enum value of
214 # google.rpc.Code, but it may accept additional error codes if needed. The
215 # error message should be a developer-facing English message that helps
216 # developers *understand* and *resolve* the error. If a localized user-facing
217 # error message is needed, put the localized message in the error details or
218 # localize it in the client. The optional error details may contain arbitrary
219 # information about the error. There is a predefined set of error detail types
220 # in the package `google.rpc` that can be used for common error conditions.
221 #
222 # # Language mapping
223 #
224 # The `Status` message is the logical representation of the error model, but it
225 # is not necessarily the actual wire format. When the `Status` message is
226 # exposed in different client libraries and different wire protocols, it can be
227 # mapped differently. For example, it will likely be mapped to some exceptions
228 # in Java, but more likely mapped to some error codes in C.
229 #
230 # # Other uses
231 #
232 # The error model and the `Status` message can be used in a variety of
233 # environments, either with or without APIs, to provide a
234 # consistent developer experience across different environments.
235 #
236 # Example uses of this error model include:
237 #
238 # - Partial errors. If a service needs to return partial errors to the client,
239 # it may embed the `Status` in the normal response to indicate the partial
240 # errors.
241 #
242 # - Workflow errors. A typical workflow has multiple steps. Each step may
243 # have a `Status` message for error reporting.
244 #
245 # - Batch operations. If a client uses batch request and batch response, the
246 # `Status` message should be used directly inside batch response, one for
247 # each error sub-response.
248 #
249 # - Asynchronous operations. If an API call embeds asynchronous operation
250 # results in its response, the status of those operations should be
251 # represented directly using the `Status` message.
252 #
253 # - Logging. If some API errors are stored in logs, the message `Status` could
254 # be used directly after any stripping needed for security/privacy reasons.
255 "message": "A String", # A developer-facing error message, which should be in English. Any
256 # user-facing error message should be localized and sent in the
257 # google.rpc.Status.details field, or localized by the client.
258 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
259 "details": [ # A list of messages that carry the error details. There is a common set of
260 # message types for APIs to use.
261 {
262 "a_key": "", # Properties of the object. Contains field @type with type URL.
263 },
264 ],
265 },
266 }</pre>
267</div>
268
269<div class="method">
270 <code class="details" id="list">list(name, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</code>
271 <pre>Lists operations that match the specified filter in the request. If the
272server doesn't support this method, it returns `UNIMPLEMENTED`.
273
274NOTE: the `name` binding allows API services to override the binding
275to use different resource name schemes, such as `users/*/operations`. To
276override the binding, API services can add a binding such as
277`"/v1/{name=users/*}/operations"` to their service configuration.
278For backwards compatibility, the default name includes the operations
279collection id, however overriding users must ensure the name binding
280is the parent resource, without the operations collection id.
281
282Args:
283 name: string, The name of the operation's parent resource. (required)
284 pageToken: string, The standard list page token.
285 x__xgafv: string, V1 error format.
286 Allowed values
287 1 - v1 error format
288 2 - v2 error format
289 pageSize: integer, The standard list page size.
290 filter: string, The standard list filter.
291
292Returns:
293 An object of the form:
294
295 { # The response message for Operations.ListOperations.
296 "operations": [ # A list of operations that matches the specified filter in the request.
297 { # This resource represents a long-running operation that is the result of a
298 # network API call.
299 "response": { # The normal response of the operation in case of success. If the original
300 # method returns no data on success, such as `Delete`, the response is
301 # `google.protobuf.Empty`. If the original method is standard
302 # `Get`/`Create`/`Update`, the response should be the resource. For other
303 # methods, the response should have the type `XxxResponse`, where `Xxx`
304 # is the original method name. For example, if the original method name
305 # is `TakeSnapshot()`, the inferred response type is
306 # `TakeSnapshotResponse`.
307 "a_key": "", # Properties of the object. Contains field @type with type URL.
308 },
309 "metadata": { # Service-specific metadata associated with the operation. It typically
310 # contains progress information and common metadata such as create time.
311 # Some services might not provide such metadata. Any method that returns a
312 # long-running operation should document the metadata type, if any.
313 "a_key": "", # Properties of the object. Contains field @type with type URL.
314 },
315 "done": True or False, # If the value is `false`, it means the operation is still in progress.
316 # If `true`, the operation is completed, and either `error` or `response` is
317 # available.
318 "name": "A String", # The server-assigned name, which is only unique within the same service that
319 # originally returns it. If you use the default HTTP mapping, the
320 # `name` should be a resource name ending with `operations/{unique_id}`.
321 "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.
322 # different programming environments, including REST APIs and RPC APIs. It is
323 # used by [gRPC](https://github.com/grpc). The error model is designed to be:
324 #
325 # - Simple to use and understand for most users
326 # - Flexible enough to meet unexpected needs
327 #
328 # # Overview
329 #
330 # The `Status` message contains three pieces of data: error code, error
331 # message, and error details. The error code should be an enum value of
332 # google.rpc.Code, but it may accept additional error codes if needed. The
333 # error message should be a developer-facing English message that helps
334 # developers *understand* and *resolve* the error. If a localized user-facing
335 # error message is needed, put the localized message in the error details or
336 # localize it in the client. The optional error details may contain arbitrary
337 # information about the error. There is a predefined set of error detail types
338 # in the package `google.rpc` that can be used for common error conditions.
339 #
340 # # Language mapping
341 #
342 # The `Status` message is the logical representation of the error model, but it
343 # is not necessarily the actual wire format. When the `Status` message is
344 # exposed in different client libraries and different wire protocols, it can be
345 # mapped differently. For example, it will likely be mapped to some exceptions
346 # in Java, but more likely mapped to some error codes in C.
347 #
348 # # Other uses
349 #
350 # The error model and the `Status` message can be used in a variety of
351 # environments, either with or without APIs, to provide a
352 # consistent developer experience across different environments.
353 #
354 # Example uses of this error model include:
355 #
356 # - Partial errors. If a service needs to return partial errors to the client,
357 # it may embed the `Status` in the normal response to indicate the partial
358 # errors.
359 #
360 # - Workflow errors. A typical workflow has multiple steps. Each step may
361 # have a `Status` message for error reporting.
362 #
363 # - Batch operations. If a client uses batch request and batch response, the
364 # `Status` message should be used directly inside batch response, one for
365 # each error sub-response.
366 #
367 # - Asynchronous operations. If an API call embeds asynchronous operation
368 # results in its response, the status of those operations should be
369 # represented directly using the `Status` message.
370 #
371 # - Logging. If some API errors are stored in logs, the message `Status` could
372 # be used directly after any stripping needed for security/privacy reasons.
373 "message": "A String", # A developer-facing error message, which should be in English. Any
374 # user-facing error message should be localized and sent in the
375 # google.rpc.Status.details field, or localized by the client.
376 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
377 "details": [ # A list of messages that carry the error details. There is a common set of
378 # message types for APIs to use.
379 {
380 "a_key": "", # Properties of the object. Contains field @type with type URL.
381 },
382 ],
383 },
384 },
385 ],
386 "nextPageToken": "A String", # The standard List next-page token.
387 }</pre>
388</div>
389
390<div class="method">
391 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
392 <pre>Retrieves the next page of results.
393
394Args:
395 previous_request: The request for the previous page. (required)
396 previous_response: The response from the request for the previous page. (required)
397
398Returns:
399 A request object that you can call 'execute()' on to request the next
400 page. Returns None if there are no more items in the collection.
401 </pre>
402</div>
403
404</body></html>