Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 715bd7f9ca9a324a05ee05a6476af383e54930f9 / . / docs / dyn / genomics_v1.operations.html
blob: d7bcb1b362dea2089cea4e5b91d5a7636bca8994 [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">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]78 <code><a href="#cancel">cancel(name, body=None, x__xgafv=None)</a></code></p>
79<p class="firstline">Starts asynchronous cancellation on a long-running operation.</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>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]82<p class="firstline">Gets the latest state of a long-running operation.</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]83<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]84 <code><a href="#list">list(name, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</a></code></p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]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">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]91 <code class="details" id="cancel">cancel(name, body=None, x__xgafv=None)</code>
92 <pre>Starts asynchronous cancellation on a long-running operation.
93The server makes a best effort to cancel the operation, but success is not
94guaranteed. Clients may use Operations.GetOperation
95or Operations.ListOperations
96to check whether the cancellation succeeded or the operation completed
97despite cancellation.
98Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission&#58;
99
100* `genomics.operations.cancel`
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]101
102Args:
103 name: string, The name of the operation resource to be cancelled. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]104 body: object, The request body.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]105 The object takes the form of:
106
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]107{ # The request message for Operations.CancelOperation.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]108 }
109
110 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]111 Allowed values
112 1 - v1 error format
113 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]114
115Returns:
116 An object of the form:
117
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]118 { # A generic empty message that you can re-use to avoid defining duplicated
119 # empty messages in your APIs. A typical example is to use it as the request
120 # or the response type of an API method. For instance:
121 #
122 # service Foo {
123 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
124 # }
125 #
126 # The JSON representation for `Empty` is empty JSON object `{}`.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]127 }</pre>
128</div>
129
130<div class="method">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]131 <code class="details" id="get">get(name, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]132 <pre>Gets the latest state of a long-running operation.
133Clients can use this method to poll the operation result at intervals as
134recommended by the API service.
135Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission&#58;
136
137* `genomics.operations.get`
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]138
139Args:
140 name: string, The name of the operation resource. (required)
141 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]142 Allowed values
143 1 - v1 error format
144 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]145
146Returns:
147 An object of the form:
148
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]149 { # This resource represents a long-running operation that is the result of a
150 # network API call.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]151 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
152 # different programming environments, including REST APIs and RPC APIs. It is
153 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
154 # three pieces of data: error code, error message, and error details.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]155 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]156 # You can find out more about this error model and how to work with it in the
157 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]158 "message": "A String", # A developer-facing error message, which should be in English. Any
159 # user-facing error message should be localized and sent in the
160 # google.rpc.Status.details field, or localized by the client.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]161 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]162 "details": [ # A list of messages that carry the error details. There is a common set of
163 # message types for APIs to use.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]164 {
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]165 "a_key": "", # Properties of the object. Contains field @type with type URL.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]166 },
167 ],
168 },
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]169 "done": True or False, # If the value is `false`, it means the operation is still in progress.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]170 # If `true`, the operation is completed, and either `error` or `response` is
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]171 # available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]172 "response": { # An Empty object.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]173 "a_key": "", # Properties of the object. Contains field @type with type URL.
174 },
175 "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`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]176 "metadata": { # An OperationMetadata or Metadata object. This will always be returned with the Operation.
177 "a_key": "", # Properties of the object. Contains field @type with type URL.
178 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]179 }</pre>
180</div>
181
182<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]183 <code class="details" id="list">list(name, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</code>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]184 <pre>Lists operations that match the specified filter in the request.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]185Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission&#58;
186
187* `genomics.operations.list`
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]188
189Args:
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]190 name: string, The name of the operation's parent resource. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]191 pageToken: string, The standard list page token.
192 x__xgafv: string, V1 error format.
193 Allowed values
194 1 - v1 error format
195 2 - v2 error format
196 pageSize: integer, The maximum number of results to return. The maximum value is 256.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]197 filter: string, A string for filtering Operations.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]198In v2alpha1, the following filter fields are supported&#58;
199
200* createTime&#58; The time this job was created
201* events&#58; The set of event (names) that have occurred while running
202 the pipeline. The &#58; operator can be used to determine if a
203 particular event has occurred.
204* error&#58; If the pipeline is running, this value is NULL. Once the
205 pipeline finishes, the value is the standard Google error code.
206* labels.key or labels."key with space" where key is a label key.
207* done&#58; If the pipeline is running, this value is false. Once the
208 pipeline finishes, the value is true.
209
210In v1 and v1alpha2, the following filter fields are supported&#58;
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]211
212* projectId&#58; Required. Corresponds to
213 OperationMetadata.projectId.
214* createTime&#58; The time this job was created, in seconds from the
215 [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `<=`
216 operators.
217* status&#58; Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only
218 one status may be specified.
219* labels.key where key is a label key.
220
221Examples&#58;
222
223* `projectId = my-project AND createTime >= 1432140000`
224* `projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING`
225* `projectId = my-project AND labels.color = *`
226* `projectId = my-project AND labels.color = red`
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]227
228Returns:
229 An object of the form:
230
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]231 { # The response message for Operations.ListOperations.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]232 "nextPageToken": "A String", # The standard List next-page token.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]233 "operations": [ # A list of operations that matches the specified filter in the request.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]234 { # This resource represents a long-running operation that is the result of a
235 # network API call.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]236 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
237 # different programming environments, including REST APIs and RPC APIs. It is
238 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
239 # three pieces of data: error code, error message, and error details.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]240 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]241 # You can find out more about this error model and how to work with it in the
242 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]243 "message": "A String", # A developer-facing error message, which should be in English. Any
244 # user-facing error message should be localized and sent in the
245 # google.rpc.Status.details field, or localized by the client.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]246 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]247 "details": [ # A list of messages that carry the error details. There is a common set of
248 # message types for APIs to use.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]249 {
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]250 "a_key": "", # Properties of the object. Contains field @type with type URL.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]251 },
252 ],
253 },
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]254 "done": True or False, # If the value is `false`, it means the operation is still in progress.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]255 # If `true`, the operation is completed, and either `error` or `response` is
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]256 # available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]257 "response": { # An Empty object.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]258 "a_key": "", # Properties of the object. Contains field @type with type URL.
259 },
260 "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`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]261 "metadata": { # An OperationMetadata or Metadata object. This will always be returned with the Operation.
262 "a_key": "", # Properties of the object. Contains field @type with type URL.
263 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]264 },
265 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]266 }</pre>
267</div>
268
269<div class="method">
270 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
271 <pre>Retrieves the next page of results.
272
273Args:
274 previous_request: The request for the previous page. (required)
275 previous_response: The response from the request for the previous page. (required)
276
277Returns:
278 A request object that you can call 'execute()' on to request the next
279 page. Returns None if there are no more items in the collection.
280 </pre>
281</div>
282
283</body></html>