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