Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 42818cfca63bf2d3d257ff8859939dcf6839456e / . / docs / dyn / genomics_v1.operations.html
blob: ab6ddf118d1501bc5a7f1a36dae5ca2afe0a6575 [file] [log] [blame]
Takashi Matsuo06694102015-09-11 13:55:40 -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="genomics_v1.html">Genomics API</a> . <a href="genomics_v1.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>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]79<p class="firstline">Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation.</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]80<p class="toc_element">
81 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]82<p class="firstline">Gets the latest state of a long-running operation. Clients can use this</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]83<p class="toc_element">
84 <code><a href="#list">list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Lists operations that match the specified filter in the request.</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, body, x__xgafv=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]92 <pre>Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]93
94Args:
95 name: string, The name of the operation resource to be cancelled. (required)
96 body: object, The request body. (required)
97 The object takes the form of:
98
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]99{ # The request message for Operations.CancelOperation.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]100 }
101
102 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]103 Allowed values
104 1 - v1 error format
105 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]106
107Returns:
108 An object of the form:
109
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]110 { # A generic empty message that you can re-use to avoid defining duplicated
111 # empty messages in your APIs. A typical example is to use it as the request
112 # or the response type of an API method. For instance:
113 #
114 # service Foo {
115 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
116 # }
117 #
118 # The JSON representation for `Empty` is empty JSON object `{}`.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]119 }</pre>
120</div>
121
122<div class="method">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]123 <code class="details" id="get">get(name, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]124 <pre>Gets the latest state of a long-running operation. Clients can use this
125method to poll the operation result at intervals as recommended by the API
126service.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]127
128Args:
129 name: string, The name of the operation resource. (required)
130 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]131 Allowed values
132 1 - v1 error format
133 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]134
135Returns:
136 An object of the form:
137
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]138 { # This resource represents a long-running operation that is the result of a
139 # network API call.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]140 "metadata": { # An OperationMetadata object. This will always be returned with the Operation.
141 "a_key": "", # Properties of the object. Contains field @type with type URL.
142 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]143 "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.
144 # programming environments, including REST APIs and RPC APIs. It is used by
145 # [gRPC](https://github.com/grpc). The error model is designed to be:
146 #
147 # - Simple to use and understand for most users
148 # - Flexible enough to meet unexpected needs
149 #
150 # # Overview
151 #
152 # The `Status` message contains three pieces of data: error code, error message,
153 # and error details. The error code should be an enum value of
154 # google.rpc.Code, but it may accept additional error codes if needed. The
155 # error message should be a developer-facing English message that helps
156 # developers *understand* and *resolve* the error. If a localized user-facing
157 # error message is needed, put the localized message in the error details or
158 # localize it in the client. The optional error details may contain arbitrary
159 # information about the error. There is a predefined set of error detail types
160 # in the package `google.rpc` which can be used for common error conditions.
161 #
162 # # Language mapping
163 #
164 # The `Status` message is the logical representation of the error model, but it
165 # is not necessarily the actual wire format. When the `Status` message is
166 # exposed in different client libraries and different wire protocols, it can be
167 # mapped differently. For example, it will likely be mapped to some exceptions
168 # in Java, but more likely mapped to some error codes in C.
169 #
170 # # Other uses
171 #
172 # The error model and the `Status` message can be used in a variety of
173 # environments, either with or without APIs, to provide a
174 # consistent developer experience across different environments.
175 #
176 # Example uses of this error model include:
177 #
178 # - Partial errors. If a service needs to return partial errors to the client,
179 # it may embed the `Status` in the normal response to indicate the partial
180 # errors.
181 #
182 # - Workflow errors. A typical workflow has multiple steps. Each step may
183 # have a `Status` message for error reporting purpose.
184 #
185 # - Batch operations. If a client uses batch request and batch response, the
186 # `Status` message should be used directly inside batch response, one for
187 # each error sub-response.
188 #
189 # - Asynchronous operations. If an API call embeds asynchronous operation
190 # results in its response, the status of those operations should be
191 # represented directly using the `Status` message.
192 #
193 # - Logging. If some API errors are stored in logs, the message `Status` could
194 # be used directly after any stripping needed for security/privacy reasons.
195 "message": "A String", # 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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]198 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]199 "details": [ # A list of messages that carry the error details. There will be a
200 # common set of message types for APIs to use.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]201 {
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]202 "a_key": "", # Properties of the object. Contains field @type with type URL.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]203 },
204 ],
205 },
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]206 "done": True or False, # If the value is `false`, it means the operation is still in progress.
207 # If true, the operation is completed, and either `error` or `response` is
208 # available.
209 "response": { # If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For pipelines and exports, an empty response is returned.
210 "a_key": "", # Properties of the object. Contains field @type with type URL.
211 },
212 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. For example&#58; `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]213 }</pre>
214</div>
215
216<div class="method">
217 <code class="details" id="list">list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
218 <pre>Lists operations that match the specified filter in the request.
219
220Args:
221 name: string, The name of the operation collection. (required)
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]222 pageSize: integer, The maximum number of results to return. If unspecified, defaults to
223256. The maximum value is 2048.
224 filter: string, A string for filtering Operations.
225The following filter fields are supported&#58;
226
227* projectId&#58; Required. Corresponds to
228 OperationMetadata.projectId.
229* createTime&#58; The time this job was created, in seconds from the
230 [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `<=`
231 operators.
232* status&#58; Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only
233 one status may be specified.
234* labels.key where key is a label key.
235
236Examples&#58;
237
238* `projectId = my-project AND createTime >= 1432140000`
239* `projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING`
240* `projectId = my-project AND labels.color = *`
241* `projectId = my-project AND labels.color = red`
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]242 pageToken: string, The standard list page token.
243 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]244 Allowed values
245 1 - v1 error format
246 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]247
248Returns:
249 An object of the form:
250
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]251 { # The response message for Operations.ListOperations.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]252 "operations": [ # A list of operations that matches the specified filter in the request.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]253 { # This resource represents a long-running operation that is the result of a
254 # network API call.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]255 "metadata": { # An OperationMetadata object. This will always be returned with the Operation.
256 "a_key": "", # Properties of the object. Contains field @type with type URL.
257 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]258 "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.
259 # programming environments, including REST APIs and RPC APIs. It is used by
260 # [gRPC](https://github.com/grpc). The error model is designed to be:
261 #
262 # - Simple to use and understand for most users
263 # - Flexible enough to meet unexpected needs
264 #
265 # # Overview
266 #
267 # The `Status` message contains three pieces of data: error code, error message,
268 # and error details. The error code should be an enum value of
269 # google.rpc.Code, but it may accept additional error codes if needed. The
270 # error message should be a developer-facing English message that helps
271 # developers *understand* and *resolve* the error. If a localized user-facing
272 # error message is needed, put the localized message in the error details or
273 # localize it in the client. The optional error details may contain arbitrary
274 # information about the error. There is a predefined set of error detail types
275 # in the package `google.rpc` which can be used for common error conditions.
276 #
277 # # Language mapping
278 #
279 # The `Status` message is the logical representation of the error model, but it
280 # is not necessarily the actual wire format. When the `Status` message is
281 # exposed in different client libraries and different wire protocols, it can be
282 # mapped differently. For example, it will likely be mapped to some exceptions
283 # in Java, but more likely mapped to some error codes in C.
284 #
285 # # Other uses
286 #
287 # The error model and the `Status` message can be used in a variety of
288 # environments, either with or without APIs, to provide a
289 # consistent developer experience across different environments.
290 #
291 # Example uses of this error model include:
292 #
293 # - Partial errors. If a service needs to return partial errors to the client,
294 # it may embed the `Status` in the normal response to indicate the partial
295 # errors.
296 #
297 # - Workflow errors. A typical workflow has multiple steps. Each step may
298 # have a `Status` message for error reporting purpose.
299 #
300 # - Batch operations. If a client uses batch request and batch response, the
301 # `Status` message should be used directly inside batch response, one for
302 # each error sub-response.
303 #
304 # - Asynchronous operations. If an API call embeds asynchronous operation
305 # results in its response, the status of those operations should be
306 # represented directly using the `Status` message.
307 #
308 # - Logging. If some API errors are stored in logs, the message `Status` could
309 # be used directly after any stripping needed for security/privacy reasons.
310 "message": "A String", # A developer-facing error message, which should be in English. Any
311 # user-facing error message should be localized and sent in the
312 # google.rpc.Status.details field, or localized by the client.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]313 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]314 "details": [ # A list of messages that carry the error details. There will be a
315 # common set of message types for APIs to use.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]316 {
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]317 "a_key": "", # Properties of the object. Contains field @type with type URL.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]318 },
319 ],
320 },
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]321 "done": True or False, # If the value is `false`, it means the operation is still in progress.
322 # If true, the operation is completed, and either `error` or `response` is
323 # available.
324 "response": { # If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For pipelines and exports, an empty response is returned.
325 "a_key": "", # Properties of the object. Contains field @type with type URL.
326 },
327 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. For example&#58; `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]328 },
329 ],
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]330 "nextPageToken": "A String", # The standard List next-page token.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]331 }</pre>
332</div>
333
334<div class="method">
335 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
336 <pre>Retrieves the next page of results.
337
338Args:
339 previous_request: The request for the previous page. (required)
340 previous_response: The response from the request for the previous page. (required)
341
342Returns:
343 A request object that you can call 'execute()' on to request the next
344 page. Returns None if there are no more items in the collection.
345 </pre>
346</div>
347
348</body></html>