Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / a527de24cda7c7d62a371203158fd5f617a1c08c / . / docs / dyn / translate_v3.projects.locations.operations.html
blob: a9f8ac45e9618875184f9b56f71e9cb13a21169d [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -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="translate_v3.html">Cloud Translation API</a> . <a href="translate_v3.projects.html">projects</a> . <a href="translate_v3.projects.locations.html">locations</a> . <a href="translate_v3.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">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]87 <code><a href="#list">list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim65020912020-05-20 12:08:20 -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<p class="toc_element">
93 <code><a href="#wait">wait(name, body=None, x__xgafv=None)</a></code></p>
94<p class="firstline">Waits for the specified long-running operation until it is done or reaches</p>
95<h3>Method Details</h3>
96<div class="method">
97 <code class="details" id="cancel">cancel(name, body=None, x__xgafv=None)</code>
98 <pre>Starts asynchronous cancellation on a long-running operation. The server
99makes a best effort to cancel the operation, but success is not
100guaranteed. If the server doesn&#x27;t support this method, it returns
101`google.rpc.Code.UNIMPLEMENTED`. Clients can use
102Operations.GetOperation or
103other methods to check whether the cancellation succeeded or whether the
104operation completed despite cancellation. On successful cancellation,
105the operation is not deleted; instead, it becomes an operation with
106an Operation.error value with a google.rpc.Status.code of 1,
107corresponding to `Code.CANCELLED`.
108
109Args:
110 name: string, The name of the operation resource to be cancelled. (required)
111 body: object, The request body.
112 The object takes the form of:
113
114{ # The request message for Operations.CancelOperation.
115 }
116
117 x__xgafv: string, V1 error format.
118 Allowed values
119 1 - v1 error format
120 2 - v2 error format
121
122Returns:
123 An object of the form:
124
125 { # A generic empty message that you can re-use to avoid defining duplicated
126 # empty messages in your APIs. A typical example is to use it as the request
127 # or the response type of an API method. For instance:
128 #
129 # service Foo {
130 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
131 # }
132 #
133 # The JSON representation for `Empty` is empty JSON object `{}`.
134 }</pre>
135</div>
136
137<div class="method">
138 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
139 <pre>Deletes a long-running operation. This method indicates that the client is
140no longer interested in the operation result. It does not cancel the
141operation. If the server doesn&#x27;t support this method, it returns
142`google.rpc.Code.UNIMPLEMENTED`.
143
144Args:
145 name: string, The name of the operation resource to be deleted. (required)
146 x__xgafv: string, V1 error format.
147 Allowed values
148 1 - v1 error format
149 2 - v2 error format
150
151Returns:
152 An object of the form:
153
154 { # A generic empty message that you can re-use to avoid defining duplicated
155 # empty messages in your APIs. A typical example is to use it as the request
156 # or the response type of an API method. For instance:
157 #
158 # service Foo {
159 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
160 # }
161 #
162 # The JSON representation for `Empty` is empty JSON object `{}`.
163 }</pre>
164</div>
165
166<div class="method">
167 <code class="details" id="get">get(name, x__xgafv=None)</code>
168 <pre>Gets the latest state of a long-running operation. Clients can use this
169method to poll the operation result at intervals as recommended by the API
170service.
171
172Args:
173 name: string, The name of the operation resource. (required)
174 x__xgafv: string, V1 error format.
175 Allowed values
176 1 - v1 error format
177 2 - v2 error format
178
179Returns:
180 An object of the form:
181
182 { # This resource represents a long-running operation that is the result of a
183 # network API call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]184 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
185 # originally returns it. If you use the default HTTP mapping, the
186 # `name` should be a resource name ending with `operations/{unique_id}`.
187 &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.
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 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
195 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
196 # user-facing error message should be localized and sent in the
197 # google.rpc.Status.details field, or localized by the client.
198 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
199 # message types for APIs to use.
200 {
201 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
202 },
203 ],
204 },
205 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
206 # contains progress information and common metadata such as create time.
207 # Some services might not provide such metadata. Any method that returns a
208 # long-running operation should document the metadata type, if any.
209 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
210 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]211 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
212 # If `true`, the operation is completed, and either `error` or `response` is
213 # available.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]214 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
215 # method returns no data on success, such as `Delete`, the response is
216 # `google.protobuf.Empty`. If the original method is standard
217 # `Get`/`Create`/`Update`, the response should be the resource. For other
218 # methods, the response should have the type `XxxResponse`, where `Xxx`
219 # is the original method name. For example, if the original method name
220 # is `TakeSnapshot()`, the inferred response type is
221 # `TakeSnapshotResponse`.
222 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
223 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]224 }</pre>
225</div>
226
227<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]228 <code class="details" id="list">list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]229 <pre>Lists operations that match the specified filter in the request. If the
230server doesn&#x27;t support this method, it returns `UNIMPLEMENTED`.
231
232NOTE: the `name` binding allows API services to override the binding
233to use different resource name schemes, such as `users/*/operations`. To
234override the binding, API services can add a binding such as
235`&quot;/v1/{name=users/*}/operations&quot;` to their service configuration.
236For backwards compatibility, the default name includes the operations
237collection id, however overriding users must ensure the name binding
238is the parent resource, without the operations collection id.
239
240Args:
241 name: string, The name of the operation&#x27;s parent resource. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]242 pageSize: integer, The standard list page size.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]243 filter: string, The standard list filter.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]244 pageToken: string, The standard list page token.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]245 x__xgafv: string, V1 error format.
246 Allowed values
247 1 - v1 error format
248 2 - v2 error format
249
250Returns:
251 An object of the form:
252
253 { # The response message for Operations.ListOperations.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]254 &quot;operations&quot;: [ # A list of operations that matches the specified filter in the request.
255 { # This resource represents a long-running operation that is the result of a
256 # network API call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]257 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
258 # originally returns it. If you use the default HTTP mapping, the
259 # `name` should be a resource name ending with `operations/{unique_id}`.
260 &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.
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 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
268 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
269 # user-facing error message should be localized and sent in the
270 # google.rpc.Status.details field, or localized by the client.
271 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
272 # message types for APIs to use.
273 {
274 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
275 },
276 ],
277 },
278 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
279 # contains progress information and common metadata such as create time.
280 # Some services might not provide such metadata. Any method that returns a
281 # long-running operation should document the metadata type, if any.
282 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
283 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]284 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
285 # If `true`, the operation is completed, and either `error` or `response` is
286 # available.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]287 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
288 # method returns no data on success, such as `Delete`, the response is
289 # `google.protobuf.Empty`. If the original method is standard
290 # `Get`/`Create`/`Update`, the response should be the resource. For other
291 # methods, the response should have the type `XxxResponse`, where `Xxx`
292 # is the original method name. For example, if the original method name
293 # is `TakeSnapshot()`, the inferred response type is
294 # `TakeSnapshotResponse`.
295 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
296 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]297 },
298 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]299 &quot;nextPageToken&quot;: &quot;A String&quot;, # The standard List next-page token.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]300 }</pre>
301</div>
302
303<div class="method">
304 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
305 <pre>Retrieves the next page of results.
306
307Args:
308 previous_request: The request for the previous page. (required)
309 previous_response: The response from the request for the previous page. (required)
310
311Returns:
312 A request object that you can call &#x27;execute()&#x27; on to request the next
313 page. Returns None if there are no more items in the collection.
314 </pre>
315</div>
316
317<div class="method">
318 <code class="details" id="wait">wait(name, body=None, x__xgafv=None)</code>
319 <pre>Waits for the specified long-running operation until it is done or reaches
320at most a specified timeout, returning the latest state. If the operation
321is already done, the latest state is immediately returned. If the timeout
322specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
323timeout is used. If the server does not support this method, it returns
324`google.rpc.Code.UNIMPLEMENTED`.
325Note that this method is on a best-effort basis. It may return the latest
326state before the specified timeout (including immediately), meaning even an
327immediate response is no guarantee that the operation is done.
328
329Args:
330 name: string, The name of the operation resource to wait on. (required)
331 body: object, The request body.
332 The object takes the form of:
333
334{ # The request message for Operations.WaitOperation.
335 &quot;timeout&quot;: &quot;A String&quot;, # The maximum duration to wait before timing out. If left blank, the wait
336 # will be at most the time permitted by the underlying HTTP/RPC protocol.
337 # If RPC context deadline is also specified, the shorter one will be used.
338 }
339
340 x__xgafv: string, V1 error format.
341 Allowed values
342 1 - v1 error format
343 2 - v2 error format
344
345Returns:
346 An object of the form:
347
348 { # This resource represents a long-running operation that is the result of a
349 # network API call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]350 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
351 # originally returns it. If you use the default HTTP mapping, the
352 # `name` should be a resource name ending with `operations/{unique_id}`.
353 &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.
354 # different programming environments, including REST APIs and RPC APIs. It is
355 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
356 # three pieces of data: error code, error message, and error details.
357 #
358 # You can find out more about this error model and how to work with it in the
359 # [API Design Guide](https://cloud.google.com/apis/design/errors).
360 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
361 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
362 # user-facing error message should be localized and sent in the
363 # google.rpc.Status.details field, or localized by the client.
364 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
365 # message types for APIs to use.
366 {
367 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
368 },
369 ],
370 },
371 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
372 # contains progress information and common metadata such as create time.
373 # Some services might not provide such metadata. Any method that returns a
374 # long-running operation should document the metadata type, if any.
375 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
376 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]377 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
378 # If `true`, the operation is completed, and either `error` or `response` is
379 # available.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]380 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
381 # method returns no data on success, such as `Delete`, the response is
382 # `google.protobuf.Empty`. If the original method is standard
383 # `Get`/`Create`/`Update`, the response should be the resource. For other
384 # methods, the response should have the type `XxxResponse`, where `Xxx`
385 # is the original method name. For example, if the original method name
386 # is `TakeSnapshot()`, the inferred response type is
387 # `TakeSnapshotResponse`.
388 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
389 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]390 }</pre>
391</div>
392
393</body></html>