Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 7d5badbac4f925c1867e20b50cf0a1a70a5fb573 / . / docs / dyn / speech_v1beta1.operations.html
blob: 3bf0c3c344138c79f251c4a466df7afcddd21a52 [file] [log] [blame]
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -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="speech_v1beta1.html">Google Cloud Speech API</a> . <a href="speech_v1beta1.operations.html">operations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#cancel">cancel(name, body, 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=None, pageSize=None, filter=None, pageToken=None, x__xgafv=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, 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.
102
103Args:
104 name: string, The name of the operation resource to be cancelled. (required)
105 body: object, The request body. (required)
106 The object takes the form of:
107
108{ # The request message for Operations.CancelOperation.
109 }
110
111 x__xgafv: string, V1 error format.
112 Allowed values
113 1 - v1 error format
114 2 - v2 error format
115
116Returns:
117 An object of the form:
118
119 { # A generic empty message that you can re-use to avoid defining duplicated
120 # empty messages in your APIs. A typical example is to use it as the request
121 # or the response type of an API method. For instance:
122 #
123 # service Foo {
124 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
125 # }
126 #
127 # The JSON representation for `Empty` is empty JSON object `{}`.
128 }</pre>
129</div>
130
131<div class="method">
132 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
133 <pre>Deletes a long-running operation. This method indicates that the client is
134no longer interested in the operation result. It does not cancel the
135operation. If the server doesn't support this method, it returns
136`google.rpc.Code.UNIMPLEMENTED`.
137
138Args:
139 name: string, The name of the operation resource to be deleted. (required)
140 x__xgafv: string, V1 error format.
141 Allowed values
142 1 - v1 error format
143 2 - v2 error format
144
145Returns:
146 An object of the form:
147
148 { # A generic empty message that you can re-use to avoid defining duplicated
149 # empty messages in your APIs. A typical example is to use it as the request
150 # or the response type of an API method. For instance:
151 #
152 # service Foo {
153 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
154 # }
155 #
156 # The JSON representation for `Empty` is empty JSON object `{}`.
157 }</pre>
158</div>
159
160<div class="method">
161 <code class="details" id="get">get(name, x__xgafv=None)</code>
162 <pre>Gets the latest state of a long-running operation. Clients can use this
163method to poll the operation result at intervals as recommended by the API
164service.
165
166Args:
167 name: string, The name of the operation resource. (required)
168 x__xgafv: string, V1 error format.
169 Allowed values
170 1 - v1 error format
171 2 - v2 error format
172
173Returns:
174 An object of the form:
175
176 { # This resource represents a long-running operation that is the result of a
177 # network API call.
178 "metadata": { # Service-specific metadata associated with the operation. It typically
179 # contains progress information and common metadata such as create time.
180 # Some services might not provide such metadata. Any method that returns a
181 # long-running operation should document the metadata type, if any.
182 "a_key": "", # Properties of the object. Contains field @type with type URL.
183 },
184 "done": True or False, # If the value is `false`, it means the operation is still in progress.
185 # If true, the operation is completed, and either `error` or `response` is
186 # available.
187 "response": { # The normal response of the operation in case of success. If the original
188 # method returns no data on success, such as `Delete`, the response is
189 # `google.protobuf.Empty`. If the original method is standard
190 # `Get`/`Create`/`Update`, the response should be the resource. For other
191 # methods, the response should have the type `XxxResponse`, where `Xxx`
192 # is the original method name. For example, if the original method name
193 # is `TakeSnapshot()`, the inferred response type is
194 # `TakeSnapshotResponse`.
195 "a_key": "", # Properties of the object. Contains field @type with type URL.
196 },
197 "name": "A String", # The server-assigned name, which is only unique within the same service that
198 # originally returns it. If you use the default HTTP mapping, the
199 # `name` should have the format of `operations/some/unique/name`.
200 "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure.
201 # programming environments, including REST APIs and RPC APIs. It is used by
202 # [gRPC](https://github.com/grpc). The error model is designed to be:
203 #
204 # - Simple to use and understand for most users
205 # - Flexible enough to meet unexpected needs
206 #
207 # # Overview
208 #
209 # The `Status` message contains three pieces of data: error code, error message,
210 # and error details. The error code should be an enum value of
211 # google.rpc.Code, but it may accept additional error codes if needed. The
212 # error message should be a developer-facing English message that helps
213 # developers *understand* and *resolve* the error. If a localized user-facing
214 # error message is needed, put the localized message in the error details or
215 # localize it in the client. The optional error details may contain arbitrary
216 # information about the error. There is a predefined set of error detail types
217 # in the package `google.rpc` which can be used for common error conditions.
218 #
219 # # Language mapping
220 #
221 # The `Status` message is the logical representation of the error model, but it
222 # is not necessarily the actual wire format. When the `Status` message is
223 # exposed in different client libraries and different wire protocols, it can be
224 # mapped differently. For example, it will likely be mapped to some exceptions
225 # in Java, but more likely mapped to some error codes in C.
226 #
227 # # Other uses
228 #
229 # The error model and the `Status` message can be used in a variety of
230 # environments, either with or without APIs, to provide a
231 # consistent developer experience across different environments.
232 #
233 # Example uses of this error model include:
234 #
235 # - Partial errors. If a service needs to return partial errors to the client,
236 # it may embed the `Status` in the normal response to indicate the partial
237 # errors.
238 #
239 # - Workflow errors. A typical workflow has multiple steps. Each step may
240 # have a `Status` message for error reporting purpose.
241 #
242 # - Batch operations. If a client uses batch request and batch response, the
243 # `Status` message should be used directly inside batch response, one for
244 # each error sub-response.
245 #
246 # - Asynchronous operations. If an API call embeds asynchronous operation
247 # results in its response, the status of those operations should be
248 # represented directly using the `Status` message.
249 #
250 # - Logging. If some API errors are stored in logs, the message `Status` could
251 # be used directly after any stripping needed for security/privacy reasons.
252 "message": "A String", # A developer-facing error message, which should be in English. Any
253 # user-facing error message should be localized and sent in the
254 # google.rpc.Status.details field, or localized by the client.
255 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
256 "details": [ # A list of messages that carry the error details. There will be a
257 # common set of message types for APIs to use.
258 {
259 "a_key": "", # Properties of the object. Contains field @type with type URL.
260 },
261 ],
262 },
263 }</pre>
264</div>
265
266<div class="method">
267 <code class="details" id="list">list(name=None, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
268 <pre>Lists operations that match the specified filter in the request. If the
269server doesn't support this method, it returns `UNIMPLEMENTED`.
270
271NOTE: the `name` binding below allows API services to override the binding
272to use different resource name schemes, such as `users/*/operations`.
273
274Args:
275 name: string, The name of the operation collection.
276 pageSize: integer, The standard list page size.
277 filter: string, The standard list filter.
278 pageToken: string, The standard list page token.
279 x__xgafv: string, V1 error format.
280 Allowed values
281 1 - v1 error format
282 2 - v2 error format
283
284Returns:
285 An object of the form:
286
287 { # The response message for Operations.ListOperations.
288 "nextPageToken": "A String", # The standard List next-page token.
289 "operations": [ # A list of operations that matches the specified filter in the request.
290 { # This resource represents a long-running operation that is the result of a
291 # network API call.
292 "metadata": { # Service-specific metadata associated with the operation. It typically
293 # contains progress information and common metadata such as create time.
294 # Some services might not provide such metadata. Any method that returns a
295 # long-running operation should document the metadata type, if any.
296 "a_key": "", # Properties of the object. Contains field @type with type URL.
297 },
298 "done": True or False, # If the value is `false`, it means the operation is still in progress.
299 # If true, the operation is completed, and either `error` or `response` is
300 # available.
301 "response": { # The normal response of the operation in case of success. If the original
302 # method returns no data on success, such as `Delete`, the response is
303 # `google.protobuf.Empty`. If the original method is standard
304 # `Get`/`Create`/`Update`, the response should be the resource. For other
305 # methods, the response should have the type `XxxResponse`, where `Xxx`
306 # is the original method name. For example, if the original method name
307 # is `TakeSnapshot()`, the inferred response type is
308 # `TakeSnapshotResponse`.
309 "a_key": "", # Properties of the object. Contains field @type with type URL.
310 },
311 "name": "A String", # The server-assigned name, which is only unique within the same service that
312 # originally returns it. If you use the default HTTP mapping, the
313 # `name` should have the format of `operations/some/unique/name`.
314 "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure.
315 # programming environments, including REST APIs and RPC APIs. It is used by
316 # [gRPC](https://github.com/grpc). The error model is designed to be:
317 #
318 # - Simple to use and understand for most users
319 # - Flexible enough to meet unexpected needs
320 #
321 # # Overview
322 #
323 # The `Status` message contains three pieces of data: error code, error message,
324 # and error details. The error code should be an enum value of
325 # google.rpc.Code, but it may accept additional error codes if needed. The
326 # error message should be a developer-facing English message that helps
327 # developers *understand* and *resolve* the error. If a localized user-facing
328 # error message is needed, put the localized message in the error details or
329 # localize it in the client. The optional error details may contain arbitrary
330 # information about the error. There is a predefined set of error detail types
331 # in the package `google.rpc` which can be used for common error conditions.
332 #
333 # # Language mapping
334 #
335 # The `Status` message is the logical representation of the error model, but it
336 # is not necessarily the actual wire format. When the `Status` message is
337 # exposed in different client libraries and different wire protocols, it can be
338 # mapped differently. For example, it will likely be mapped to some exceptions
339 # in Java, but more likely mapped to some error codes in C.
340 #
341 # # Other uses
342 #
343 # The error model and the `Status` message can be used in a variety of
344 # environments, either with or without APIs, to provide a
345 # consistent developer experience across different environments.
346 #
347 # Example uses of this error model include:
348 #
349 # - Partial errors. If a service needs to return partial errors to the client,
350 # it may embed the `Status` in the normal response to indicate the partial
351 # errors.
352 #
353 # - Workflow errors. A typical workflow has multiple steps. Each step may
354 # have a `Status` message for error reporting purpose.
355 #
356 # - Batch operations. If a client uses batch request and batch response, the
357 # `Status` message should be used directly inside batch response, one for
358 # each error sub-response.
359 #
360 # - Asynchronous operations. If an API call embeds asynchronous operation
361 # results in its response, the status of those operations should be
362 # represented directly using the `Status` message.
363 #
364 # - Logging. If some API errors are stored in logs, the message `Status` could
365 # be used directly after any stripping needed for security/privacy reasons.
366 "message": "A String", # A developer-facing error message, which should be in English. Any
367 # user-facing error message should be localized and sent in the
368 # google.rpc.Status.details field, or localized by the client.
369 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
370 "details": [ # A list of messages that carry the error details. There will be a
371 # common set of message types for APIs to use.
372 {
373 "a_key": "", # Properties of the object. Contains field @type with type URL.
374 },
375 ],
376 },
377 },
378 ],
379 }</pre>
380</div>
381
382<div class="method">
383 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
384 <pre>Retrieves the next page of results.
385
386Args:
387 previous_request: The request for the previous page. (required)
388 previous_response: The response from the request for the previous page. (required)
389
390Returns:
391 A request object that you can call 'execute()' on to request the next
392 page. Returns None if there are no more items in the collection.
393 </pre>
394</div>
395
396</body></html>