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