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