Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(142)

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: discovery/googleapis_beta/genomics__v1beta.json

Issue 559053002: Generate 0.1.0 version of googleapis/googleapis_beta (Closed) Base URL: git@github.com:dart-lang/googleapis.git@master
Patch Set: Created 6 years, 3 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
« no previous file with comments | « discovery/googleapis_beta/dns__v1beta1.json ('k') | discovery/googleapis_beta/manager__v1beta2.json » ('j') | pubspec.yaml » ('J')
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
(Empty)
1 {
2 "auth": {
3 "oauth2": {
4 "scopes": {
5 "https://www.googleapis.com/auth/bigquery": {
6 "description": "View and manage your data in Google BigQuery "
7 },
8 "https://www.googleapis.com/auth/devstorage.read_write": {
9 "description": "Manage your data in Google Cloud Storage"
10 },
11 "https://www.googleapis.com/auth/genomics": {
12 "description": "View and manage Genomics data"
13 },
14 "https://www.googleapis.com/auth/genomics.readonly": {
15 "description": "View Genomics data"
16 }
17 }
18 }
19 },
20 "basePath": "/genomics/v1beta/",
21 "baseUrl": "https://www.googleapis.com/genomics/v1beta/",
22 "batchPath": "batch",
23 "description": "Provides access to Genomics data.",
24 "discoveryVersion": "v1",
25 "documentationLink": "https://developers.google.com/genomics/v1beta/referenc e",
26 "etag": "\"uUWyYHXmEn-ab7WLvo8qNz2S8ws/x23R38eVdK-WjO-U4LV9QK0q830\"",
27 "icons": {
28 "x16": "http://www.google.com/images/icons/product/search-16.gif",
29 "x32": "http://www.google.com/images/icons/product/search-32.gif"
30 },
31 "id": "genomics:v1beta",
32 "kind": "discovery#restDescription",
33 "name": "genomics",
34 "ownerDomain": "google.com",
35 "ownerName": "Google",
36 "parameters": {
37 "alt": {
38 "default": "json",
39 "description": "Data format for the response.",
40 "enum": [
41 "json"
42 ],
43 "enumDescriptions": [
44 "Responses with Content-Type of application/json"
45 ],
46 "location": "query",
47 "type": "string"
48 },
49 "fields": {
50 "description": "Selector specifying which fields to include in a par tial response.",
51 "location": "query",
52 "type": "string"
53 },
54 "key": {
55 "description": "API key. Your API key identifies your project and pr ovides you with API access, quota, and reports. Required unless you provide an O Auth 2.0 token.",
56 "location": "query",
57 "type": "string"
58 },
59 "oauth_token": {
60 "description": "OAuth 2.0 token for the current user.",
61 "location": "query",
62 "type": "string"
63 },
64 "prettyPrint": {
65 "default": "true",
66 "description": "Returns response with indentations and line breaks." ,
67 "location": "query",
68 "type": "boolean"
69 },
70 "quotaUser": {
71 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exc eed 40 characters. Overrides userIp if both are provided.",
72 "location": "query",
73 "type": "string"
74 },
75 "userIp": {
76 "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
77 "location": "query",
78 "type": "string"
79 }
80 },
81 "protocol": "rest",
82 "resources": {
83 "beacons": {
84 "methods": {
85 "get": {
86 "description": "This is an experimental API that provides a Global Alliance for Genomics and Health Beacon. It may change at any time.",
87 "httpMethod": "GET",
88 "id": "genomics.beacons.get",
89 "parameterOrder": [
90 "variantsetId"
91 ],
92 "parameters": {
93 "allele": {
94 "description": "Required. The allele to look for ('A ', 'C', 'G' or 'T').",
95 "location": "query",
96 "type": "string"
97 },
98 "contig": {
99 "description": "Required. The contig to query over." ,
100 "location": "query",
101 "type": "string"
102 },
103 "position": {
104 "description": "Required. The 0-based position to qu ery.",
105 "format": "int64",
106 "location": "query",
107 "type": "string"
108 },
109 "variantsetId": {
110 "description": "The ID of the variantset to query ov er. It must be public. Private variantsets will return an unauthorized exception .",
111 "location": "path",
112 "required": true,
113 "type": "string"
114 }
115 },
116 "path": "beacons/{variantsetId}",
117 "response": {
118 "$ref": "Beacon"
119 }
120 }
121 }
122 },
123 "callsets": {
124 "methods": {
125 "create": {
126 "description": "Creates a new callset.",
127 "httpMethod": "POST",
128 "id": "genomics.callsets.create",
129 "path": "callsets",
130 "request": {
131 "$ref": "Callset"
132 },
133 "response": {
134 "$ref": "Callset"
135 },
136 "scopes": [
137 "https://www.googleapis.com/auth/genomics"
138 ]
139 },
140 "delete": {
141 "description": "Deletes a callset.",
142 "httpMethod": "DELETE",
143 "id": "genomics.callsets.delete",
144 "parameterOrder": [
145 "callsetId"
146 ],
147 "parameters": {
148 "callsetId": {
149 "description": "The ID of the callset to be deleted. ",
150 "location": "path",
151 "required": true,
152 "type": "string"
153 }
154 },
155 "path": "callsets/{callsetId}",
156 "scopes": [
157 "https://www.googleapis.com/auth/genomics"
158 ]
159 },
160 "get": {
161 "description": "Gets a callset by ID.",
162 "httpMethod": "GET",
163 "id": "genomics.callsets.get",
164 "parameterOrder": [
165 "callsetId"
166 ],
167 "parameters": {
168 "callsetId": {
169 "description": "The ID of the callset.",
170 "location": "path",
171 "required": true,
172 "type": "string"
173 }
174 },
175 "path": "callsets/{callsetId}",
176 "response": {
177 "$ref": "Callset"
178 },
179 "scopes": [
180 "https://www.googleapis.com/auth/genomics",
181 "https://www.googleapis.com/auth/genomics.readonly"
182 ]
183 },
184 "patch": {
185 "description": "Updates a callset. This method supports patc h semantics.",
186 "httpMethod": "PATCH",
187 "id": "genomics.callsets.patch",
188 "parameterOrder": [
189 "callsetId"
190 ],
191 "parameters": {
192 "callsetId": {
193 "description": "The ID of the callset to be updated. ",
194 "location": "path",
195 "required": true,
196 "type": "string"
197 }
198 },
199 "path": "callsets/{callsetId}",
200 "request": {
201 "$ref": "Callset"
202 },
203 "response": {
204 "$ref": "Callset"
205 },
206 "scopes": [
207 "https://www.googleapis.com/auth/genomics"
208 ]
209 },
210 "search": {
211 "description": "Gets a list of callsets matching the criteri a.",
212 "httpMethod": "POST",
213 "id": "genomics.callsets.search",
214 "path": "callsets/search",
215 "request": {
216 "$ref": "SearchCallsetsRequest"
217 },
218 "response": {
219 "$ref": "SearchCallsetsResponse"
220 },
221 "scopes": [
222 "https://www.googleapis.com/auth/genomics",
223 "https://www.googleapis.com/auth/genomics.readonly"
224 ]
225 },
226 "update": {
227 "description": "Updates a callset.",
228 "httpMethod": "PUT",
229 "id": "genomics.callsets.update",
230 "parameterOrder": [
231 "callsetId"
232 ],
233 "parameters": {
234 "callsetId": {
235 "description": "The ID of the callset to be updated. ",
236 "location": "path",
237 "required": true,
238 "type": "string"
239 }
240 },
241 "path": "callsets/{callsetId}",
242 "request": {
243 "$ref": "Callset"
244 },
245 "response": {
246 "$ref": "Callset"
247 },
248 "scopes": [
249 "https://www.googleapis.com/auth/genomics"
250 ]
251 }
252 }
253 },
254 "datasets": {
255 "methods": {
256 "create": {
257 "description": "Creates a new dataset.",
258 "httpMethod": "POST",
259 "id": "genomics.datasets.create",
260 "path": "datasets",
261 "request": {
262 "$ref": "Dataset"
263 },
264 "response": {
265 "$ref": "Dataset"
266 },
267 "scopes": [
268 "https://www.googleapis.com/auth/genomics"
269 ]
270 },
271 "delete": {
272 "description": "Deletes a dataset.",
273 "httpMethod": "DELETE",
274 "id": "genomics.datasets.delete",
275 "parameterOrder": [
276 "datasetId"
277 ],
278 "parameters": {
279 "datasetId": {
280 "description": "The ID of the dataset to be deleted. ",
281 "location": "path",
282 "required": true,
283 "type": "string"
284 }
285 },
286 "path": "datasets/{datasetId}",
287 "scopes": [
288 "https://www.googleapis.com/auth/genomics"
289 ]
290 },
291 "get": {
292 "description": "Gets a dataset by ID.",
293 "httpMethod": "GET",
294 "id": "genomics.datasets.get",
295 "parameterOrder": [
296 "datasetId"
297 ],
298 "parameters": {
299 "datasetId": {
300 "description": "The ID of the dataset.",
301 "location": "path",
302 "required": true,
303 "type": "string"
304 }
305 },
306 "path": "datasets/{datasetId}",
307 "response": {
308 "$ref": "Dataset"
309 },
310 "scopes": [
311 "https://www.googleapis.com/auth/genomics",
312 "https://www.googleapis.com/auth/genomics.readonly"
313 ]
314 },
315 "list": {
316 "description": "Lists all datasets.",
317 "httpMethod": "GET",
318 "id": "genomics.datasets.list",
319 "parameters": {
320 "maxResults": {
321 "default": "50",
322 "description": "The maximum number of results return ed by this request.",
323 "format": "uint64",
324 "location": "query",
325 "type": "string"
326 },
327 "pageToken": {
328 "description": "The continuation token, which is use d to page through large result sets. To get the next page of results, set this p arameter to the value of \"nextPageToken\" from the previous response.",
329 "location": "query",
330 "type": "string"
331 },
332 "projectId": {
333 "description": "Only return datasets which belong to this Google Developers Console project. Only accepts project numbers.",
334 "format": "int64",
335 "location": "query",
336 "type": "string"
337 }
338 },
339 "path": "datasets",
340 "response": {
341 "$ref": "ListDatasetsResponse"
342 },
343 "scopes": [
344 "https://www.googleapis.com/auth/genomics",
345 "https://www.googleapis.com/auth/genomics.readonly"
346 ]
347 },
348 "patch": {
349 "description": "Updates a dataset. This method supports patc h semantics.",
350 "httpMethod": "PATCH",
351 "id": "genomics.datasets.patch",
352 "parameterOrder": [
353 "datasetId"
354 ],
355 "parameters": {
356 "datasetId": {
357 "description": "The ID of the dataset to be updated. ",
358 "location": "path",
359 "required": true,
360 "type": "string"
361 }
362 },
363 "path": "datasets/{datasetId}",
364 "request": {
365 "$ref": "Dataset"
366 },
367 "response": {
368 "$ref": "Dataset"
369 },
370 "scopes": [
371 "https://www.googleapis.com/auth/genomics"
372 ]
373 },
374 "undelete": {
375 "description": "Undeletes a dataset by restoring a dataset w hich was deleted via this API. This operation is only possible for a week after the deletion occurred.",
376 "httpMethod": "POST",
377 "id": "genomics.datasets.undelete",
378 "parameterOrder": [
379 "datasetId"
380 ],
381 "parameters": {
382 "datasetId": {
383 "description": "The ID of the dataset to be undelete d.",
384 "location": "path",
385 "required": true,
386 "type": "string"
387 }
388 },
389 "path": "datasets/{datasetId}/undelete",
390 "response": {
391 "$ref": "Dataset"
392 },
393 "scopes": [
394 "https://www.googleapis.com/auth/genomics"
395 ]
396 },
397 "update": {
398 "description": "Updates a dataset.",
399 "httpMethod": "PUT",
400 "id": "genomics.datasets.update",
401 "parameterOrder": [
402 "datasetId"
403 ],
404 "parameters": {
405 "datasetId": {
406 "description": "The ID of the dataset to be updated. ",
407 "location": "path",
408 "required": true,
409 "type": "string"
410 }
411 },
412 "path": "datasets/{datasetId}",
413 "request": {
414 "$ref": "Dataset"
415 },
416 "response": {
417 "$ref": "Dataset"
418 },
419 "scopes": [
420 "https://www.googleapis.com/auth/genomics"
421 ]
422 }
423 }
424 },
425 "experimental": {
426 "resources": {
427 "jobs": {
428 "methods": {
429 "create": {
430 "description": "Creates and asynchronously runs an a d-hoc job. This is an experimental call and may be removed or changed at any tim e.",
431 "httpMethod": "POST",
432 "id": "genomics.experimental.jobs.create",
433 "path": "experimental/jobs/create",
434 "request": {
435 "$ref": "ExperimentalCreateJobRequest"
436 },
437 "response": {
438 "$ref": "ExperimentalCreateJobResponse"
439 },
440 "scopes": [
441 "https://www.googleapis.com/auth/devstorage.read _write",
442 "https://www.googleapis.com/auth/genomics"
443 ]
444 }
445 }
446 }
447 }
448 },
449 "jobs": {
450 "methods": {
451 "cancel": {
452 "description": "Cancels a job by ID. Note that it is possibl e for partial results to be generated and stored for cancelled jobs.",
453 "httpMethod": "POST",
454 "id": "genomics.jobs.cancel",
455 "parameterOrder": [
456 "jobId"
457 ],
458 "parameters": {
459 "jobId": {
460 "description": "Required. The ID of the job.",
461 "location": "path",
462 "required": true,
463 "type": "string"
464 }
465 },
466 "path": "jobs/{jobId}/cancel",
467 "scopes": [
468 "https://www.googleapis.com/auth/genomics"
469 ]
470 },
471 "get": {
472 "description": "Gets a job by ID.",
473 "httpMethod": "GET",
474 "id": "genomics.jobs.get",
475 "parameterOrder": [
476 "jobId"
477 ],
478 "parameters": {
479 "jobId": {
480 "description": "Required. The ID of the job.",
481 "location": "path",
482 "required": true,
483 "type": "string"
484 }
485 },
486 "path": "jobs/{jobId}",
487 "response": {
488 "$ref": "Job"
489 },
490 "scopes": [
491 "https://www.googleapis.com/auth/genomics",
492 "https://www.googleapis.com/auth/genomics.readonly"
493 ]
494 },
495 "search": {
496 "description": "Gets a list of jobs matching the criteria.",
497 "httpMethod": "POST",
498 "id": "genomics.jobs.search",
499 "path": "jobs/search",
500 "request": {
501 "$ref": "SearchJobsRequest"
502 },
503 "response": {
504 "$ref": "SearchJobsResponse"
505 },
506 "scopes": [
507 "https://www.googleapis.com/auth/genomics",
508 "https://www.googleapis.com/auth/genomics.readonly"
509 ]
510 }
511 }
512 },
513 "reads": {
514 "methods": {
515 "search": {
516 "description": "Gets a list of reads for one or more readset s. Reads search operates over a genomic coordinate space of reference sequence & position defined over the reference sequences to which the requested readsets a re aligned. If a target positional range is specified, search returns all reads whose alignment to the reference genome overlap the range. A query which specifi es only readset IDs yields all reads in those readsets, including unmapped reads . All reads returned (including reads on subsequent pages) are ordered by genomi c coordinate (reference sequence & position). Reads with equivalent genomic coor dinates are returned in a deterministic order.",
517 "httpMethod": "POST",
518 "id": "genomics.reads.search",
519 "path": "reads/search",
520 "request": {
521 "$ref": "SearchReadsRequest"
522 },
523 "response": {
524 "$ref": "SearchReadsResponse"
525 },
526 "scopes": [
527 "https://www.googleapis.com/auth/genomics",
528 "https://www.googleapis.com/auth/genomics.readonly"
529 ]
530 }
531 }
532 },
533 "readsets": {
534 "methods": {
535 "delete": {
536 "description": "Deletes a readset.",
537 "httpMethod": "DELETE",
538 "id": "genomics.readsets.delete",
539 "parameterOrder": [
540 "readsetId"
541 ],
542 "parameters": {
543 "readsetId": {
544 "description": "The ID of the readset to be deleted. The caller must have WRITE permissions to the dataset associated with this read set.",
545 "location": "path",
546 "required": true,
547 "type": "string"
548 }
549 },
550 "path": "readsets/{readsetId}",
551 "scopes": [
552 "https://www.googleapis.com/auth/genomics"
553 ]
554 },
555 "export": {
556 "description": "Exports readsets to a BAM file in Google Clo ud Storage. Note that currently there may be some differences between exported B AM files and the original BAM file at the time of import. In particular, comment s in the input file header will not be preserved, and some custom tags will be c onverted to strings.",
557 "httpMethod": "POST",
558 "id": "genomics.readsets.export",
559 "path": "readsets/export",
560 "request": {
561 "$ref": "ExportReadsetsRequest"
562 },
563 "response": {
564 "$ref": "ExportReadsetsResponse"
565 },
566 "scopes": [
567 "https://www.googleapis.com/auth/devstorage.read_write",
568 "https://www.googleapis.com/auth/genomics"
569 ]
570 },
571 "get": {
572 "description": "Gets a readset by ID.",
573 "httpMethod": "GET",
574 "id": "genomics.readsets.get",
575 "parameterOrder": [
576 "readsetId"
577 ],
578 "parameters": {
579 "readsetId": {
580 "description": "The ID of the readset.",
581 "location": "path",
582 "required": true,
583 "type": "string"
584 }
585 },
586 "path": "readsets/{readsetId}",
587 "response": {
588 "$ref": "Readset"
589 },
590 "scopes": [
591 "https://www.googleapis.com/auth/genomics",
592 "https://www.googleapis.com/auth/genomics.readonly"
593 ]
594 },
595 "import": {
596 "description": "Creates readsets by asynchronously importing the provided information. Note that currently comments in the input file header are not imported and some custom tags will be converted to strings, rather than preserving tag types. The caller must have WRITE permissions to the dataset.",
597 "httpMethod": "POST",
598 "id": "genomics.readsets.import",
599 "path": "readsets/import",
600 "request": {
601 "$ref": "ImportReadsetsRequest"
602 },
603 "response": {
604 "$ref": "ImportReadsetsResponse"
605 },
606 "scopes": [
607 "https://www.googleapis.com/auth/devstorage.read_write",
608 "https://www.googleapis.com/auth/genomics"
609 ]
610 },
611 "patch": {
612 "description": "Updates a readset. This method supports patc h semantics.",
613 "httpMethod": "PATCH",
614 "id": "genomics.readsets.patch",
615 "parameterOrder": [
616 "readsetId"
617 ],
618 "parameters": {
619 "readsetId": {
620 "description": "The ID of the readset to be updated. The caller must have WRITE permissions to the dataset associated with this read set.",
621 "location": "path",
622 "required": true,
623 "type": "string"
624 }
625 },
626 "path": "readsets/{readsetId}",
627 "request": {
628 "$ref": "Readset"
629 },
630 "response": {
631 "$ref": "Readset"
632 },
633 "scopes": [
634 "https://www.googleapis.com/auth/genomics"
635 ]
636 },
637 "search": {
638 "description": "Gets a list of readsets matching the criteri a.",
639 "httpMethod": "POST",
640 "id": "genomics.readsets.search",
641 "path": "readsets/search",
642 "request": {
643 "$ref": "SearchReadsetsRequest"
644 },
645 "response": {
646 "$ref": "SearchReadsetsResponse"
647 },
648 "scopes": [
649 "https://www.googleapis.com/auth/genomics",
650 "https://www.googleapis.com/auth/genomics.readonly"
651 ]
652 },
653 "update": {
654 "description": "Updates a readset.",
655 "httpMethod": "PUT",
656 "id": "genomics.readsets.update",
657 "parameterOrder": [
658 "readsetId"
659 ],
660 "parameters": {
661 "readsetId": {
662 "description": "The ID of the readset to be updated. The caller must have WRITE permissions to the dataset associated with this read set.",
663 "location": "path",
664 "required": true,
665 "type": "string"
666 }
667 },
668 "path": "readsets/{readsetId}",
669 "request": {
670 "$ref": "Readset"
671 },
672 "response": {
673 "$ref": "Readset"
674 },
675 "scopes": [
676 "https://www.googleapis.com/auth/genomics"
677 ]
678 }
679 },
680 "resources": {
681 "coveragebuckets": {
682 "methods": {
683 "list": {
684 "description": "Lists fixed width coverage buckets f or a readset, each of which correspond to a range of a reference sequence. Each bucket summarizes coverage information across its corresponding genomic range. C overage is defined as the number of reads which are aligned to a given base in t he reference sequence. Coverage buckets are available at various bucket widths, enabling various coverage \"zoom levels\". The caller must have READ permissions for the target readset.",
685 "httpMethod": "GET",
686 "id": "genomics.readsets.coveragebuckets.list",
687 "parameterOrder": [
688 "readsetId"
689 ],
690 "parameters": {
691 "maxResults": {
692 "default": "1024",
693 "description": "The maximum number of result s to return in a single page. If unspecified, defaults to 1024. The maximum valu e is 2048.",
694 "format": "uint64",
695 "location": "query",
696 "type": "string"
697 },
698 "pageToken": {
699 "description": "The continuation token, whic h is used to page through large result sets. To get the next page of results, se t this parameter to the value of \"nextPageToken\" from the previous response.",
700 "location": "query",
701 "type": "string"
702 },
703 "range.sequenceEnd": {
704 "description": "The end position of the rang e on the reference, 1-based exclusive. If specified, sequenceName must also be s pecified.",
705 "format": "uint64",
706 "location": "query",
707 "type": "string"
708 },
709 "range.sequenceName": {
710 "description": "The reference sequence name, for example \"chr1\", \"1\", or \"chrX\".",
711 "location": "query",
712 "type": "string"
713 },
714 "range.sequenceStart": {
715 "description": "The start position of the ra nge on the reference, 1-based inclusive. If specified, sequenceName must also be specified.",
716 "format": "uint64",
717 "location": "query",
718 "type": "string"
719 },
720 "readsetId": {
721 "description": "Required. The ID of the read set over which coverage is requested.",
722 "location": "path",
723 "required": true,
724 "type": "string"
725 },
726 "targetBucketWidth": {
727 "description": "The desired width of each re ported coverage bucket in base pairs. This will be rounded down to the nearest p recomputed bucket width; the value of which is returned as bucket_width in the r esponse. Defaults to infinity (each bucket spans an entire reference sequence) o r the length of the target range, if specified. The smallest precomputed bucket_ width is currently 2048 base pairs; this is subject to change.",
728 "format": "uint64",
729 "location": "query",
730 "type": "string"
731 }
732 },
733 "path": "readsets/{readsetId}/coveragebuckets",
734 "response": {
735 "$ref": "ListCoverageBucketsResponse"
736 },
737 "scopes": [
738 "https://www.googleapis.com/auth/genomics",
739 "https://www.googleapis.com/auth/genomics.readon ly"
740 ]
741 }
742 }
743 }
744 }
745 },
746 "variants": {
747 "methods": {
748 "create": {
749 "description": "Creates a new variant.",
750 "httpMethod": "POST",
751 "id": "genomics.variants.create",
752 "path": "variants",
753 "request": {
754 "$ref": "Variant"
755 },
756 "response": {
757 "$ref": "Variant"
758 },
759 "scopes": [
760 "https://www.googleapis.com/auth/genomics"
761 ]
762 },
763 "delete": {
764 "description": "Deletes a variant.",
765 "httpMethod": "DELETE",
766 "id": "genomics.variants.delete",
767 "parameterOrder": [
768 "variantId"
769 ],
770 "parameters": {
771 "variantId": {
772 "description": "The ID of the variant to be deleted. ",
773 "location": "path",
774 "required": true,
775 "type": "string"
776 }
777 },
778 "path": "variants/{variantId}",
779 "scopes": [
780 "https://www.googleapis.com/auth/genomics"
781 ]
782 },
783 "export": {
784 "description": "Exports variant data to an external destinat ion.",
785 "httpMethod": "POST",
786 "id": "genomics.variants.export",
787 "path": "variants/export",
788 "request": {
789 "$ref": "ExportVariantsRequest"
790 },
791 "response": {
792 "$ref": "ExportVariantsResponse"
793 },
794 "scopes": [
795 "https://www.googleapis.com/auth/bigquery",
796 "https://www.googleapis.com/auth/genomics"
797 ]
798 },
799 "get": {
800 "description": "Gets a variant by ID.",
801 "httpMethod": "GET",
802 "id": "genomics.variants.get",
803 "parameterOrder": [
804 "variantId"
805 ],
806 "parameters": {
807 "variantId": {
808 "description": "The ID of the variant.",
809 "location": "path",
810 "required": true,
811 "type": "string"
812 }
813 },
814 "path": "variants/{variantId}",
815 "response": {
816 "$ref": "Variant"
817 },
818 "scopes": [
819 "https://www.googleapis.com/auth/genomics",
820 "https://www.googleapis.com/auth/genomics.readonly"
821 ]
822 },
823 "getSummary": {
824 "description": "Gets a summary of all the variant data in a variantset.",
825 "httpMethod": "GET",
826 "id": "genomics.variants.getSummary",
827 "parameters": {
828 "variantsetId": {
829 "description": "Required. The ID of the variant set to get variant summary information for.",
830 "location": "query",
831 "type": "string"
832 }
833 },
834 "path": "variants/summary",
835 "response": {
836 "$ref": "GetVariantsSummaryResponse"
837 },
838 "scopes": [
839 "https://www.googleapis.com/auth/genomics",
840 "https://www.googleapis.com/auth/genomics.readonly"
841 ]
842 },
843 "import": {
844 "description": "Creates variant data by asynchronously impor ting the provided information.",
845 "httpMethod": "POST",
846 "id": "genomics.variants.import",
847 "path": "variants/import",
848 "request": {
849 "$ref": "ImportVariantsRequest"
850 },
851 "response": {
852 "$ref": "ImportVariantsResponse"
853 },
854 "scopes": [
855 "https://www.googleapis.com/auth/devstorage.read_write",
856 "https://www.googleapis.com/auth/genomics"
857 ]
858 },
859 "patch": {
860 "description": "Updates a variant. This method supports patc h semantics.",
861 "httpMethod": "PATCH",
862 "id": "genomics.variants.patch",
863 "parameterOrder": [
864 "variantId"
865 ],
866 "parameters": {
867 "variantId": {
868 "description": "The ID of the variant to be updated. .",
869 "location": "path",
870 "required": true,
871 "type": "string"
872 }
873 },
874 "path": "variants/{variantId}",
875 "request": {
876 "$ref": "Variant"
877 },
878 "response": {
879 "$ref": "Variant"
880 },
881 "scopes": [
882 "https://www.googleapis.com/auth/genomics"
883 ]
884 },
885 "search": {
886 "description": "Gets a list of variants matching the criteri a.",
887 "httpMethod": "POST",
888 "id": "genomics.variants.search",
889 "path": "variants/search",
890 "request": {
891 "$ref": "SearchVariantsRequest"
892 },
893 "response": {
894 "$ref": "SearchVariantsResponse"
895 },
896 "scopes": [
897 "https://www.googleapis.com/auth/genomics",
898 "https://www.googleapis.com/auth/genomics.readonly"
899 ]
900 },
901 "update": {
902 "description": "Updates a variant.",
903 "httpMethod": "PUT",
904 "id": "genomics.variants.update",
905 "parameterOrder": [
906 "variantId"
907 ],
908 "parameters": {
909 "variantId": {
910 "description": "The ID of the variant to be updated. .",
911 "location": "path",
912 "required": true,
913 "type": "string"
914 }
915 },
916 "path": "variants/{variantId}",
917 "request": {
918 "$ref": "Variant"
919 },
920 "response": {
921 "$ref": "Variant"
922 },
923 "scopes": [
924 "https://www.googleapis.com/auth/genomics"
925 ]
926 }
927 }
928 }
929 },
930 "revision": "20140904",
931 "rootUrl": "https://www.googleapis.com/",
932 "schemas": {
933 "Beacon": {
934 "description": "A beacon represents whether any variant call in a va riantset has a specific allele at a particular position.",
935 "id": "Beacon",
936 "properties": {
937 "exists": {
938 "description": "True if the allele exists on any variant cal l, false otherwise.",
939 "type": "boolean"
940 }
941 },
942 "type": "object"
943 },
944 "Call": {
945 "description": "A Call represents the determination of genotype with respect to a particular variant. It may include associated information such as quality and phasing. For example, a Call might assign a probability of 0.32 to t he occurrence of a SNP named rs1234 in a callset with the name NA12345.",
946 "id": "Call",
947 "properties": {
948 "callsetId": {
949 "description": "The ID of the callset this variant call belo ngs to.",
950 "type": "string"
951 },
952 "callsetName": {
953 "description": "The name of the callset this variant call be longs to.",
954 "type": "string"
955 },
956 "genotype": {
957 "description": "The genotype of this variant call. Each valu e represents either the value of the referenceBases field or a 1-based index int o alternateBases. If a variant had a referenceBases field of \"T\" and an altern ateBases value of [\"A\", \"C\"], and the genotype was [2, 1], that would mean t he call represented the heterozygous value \"CA\" for this variant. If the genot ype was instead [0, 1], the represented value would be \"TA\". Ordering of the g enotype values is important if the phaseset field is present. If a genotype is n ot called (that is, a \".\" is present in the GT string) -1 is returned.",
958 "items": {
959 "format": "int32",
960 "type": "integer"
961 },
962 "type": "array"
963 },
964 "genotypeLikelihood": {
965 "description": "The genotype likelihoods for this variant ca ll. Each array entry represents how likely a specific genotype is for this call. The value ordering is defined by the GL tag in the VCF spec.",
966 "items": {
967 "format": "double",
968 "type": "number"
969 },
970 "type": "array"
971 },
972 "info": {
973 "additionalProperties": {
974 "description": "A string which maps to an array of value s.",
975 "items": {
976 "type": "string"
977 },
978 "type": "array"
979 },
980 "description": "A map of additional variant call information .",
981 "type": "object"
982 },
983 "phaseset": {
984 "description": "If this field is present, this variant call' s genotype ordering implies the phase of the bases and is consistent with any ot her variant calls on the same contig which have the same phaseset value. When im porting data from VCF, if the genotype data was phased but no phase set was spec ified this field will be set to \"*\".",
985 "type": "string"
986 }
987 },
988 "type": "object"
989 },
990 "Callset": {
991 "description": "A Callset is a collection of Variant Calls. It belon gs to a Variantset.",
992 "id": "Callset",
993 "properties": {
994 "created": {
995 "description": "The date this callset was created in millise conds from the epoch.",
996 "format": "int64",
997 "type": "string"
998 },
999 "id": {
1000 "description": "The Google generated ID of the callset, immu table.",
1001 "type": "string"
1002 },
1003 "info": {
1004 "additionalProperties": {
1005 "description": "A string which maps to an array of value s.",
1006 "items": {
1007 "type": "string"
1008 },
1009 "type": "array"
1010 },
1011 "description": "A map of additional callset information.",
1012 "type": "object"
1013 },
1014 "name": {
1015 "description": "The callset name.",
1016 "type": "string"
1017 },
1018 "variantsetId": {
1019 "description": "The ID of the variantset this callset belong s to.",
1020 "type": "string"
1021 }
1022 },
1023 "type": "object"
1024 },
1025 "ContigBound": {
1026 "description": "ContigBound records an upper bound for the starting coordinate of variants in a particular contig.",
1027 "id": "ContigBound",
1028 "properties": {
1029 "contig": {
1030 "description": "The contig the bound is associate with.",
1031 "type": "string"
1032 },
1033 "upperBound": {
1034 "description": "An upper bound (inclusive) on the starting c oordinate of any variant in the contig.",
1035 "format": "int64",
1036 "type": "string"
1037 }
1038 },
1039 "type": "object"
1040 },
1041 "CoverageBucket": {
1042 "description": "A bucket over which read coverage has been precomput ed. A bucket corresponds to a specific range of the reference sequence.",
1043 "id": "CoverageBucket",
1044 "properties": {
1045 "meanCoverage": {
1046 "description": "The average number of reads which are aligne d to each individual reference base in this bucket.",
1047 "format": "float",
1048 "type": "number"
1049 },
1050 "range": {
1051 "$ref": "GenomicRange",
1052 "description": "The genomic coordinate range spanned by this bucket."
1053 }
1054 },
1055 "type": "object"
1056 },
1057 "Dataset": {
1058 "description": "A Dataset is a collection of genomic data.",
1059 "id": "Dataset",
1060 "properties": {
1061 "id": {
1062 "description": "The Google generated ID of the dataset, immu table.",
1063 "type": "string"
1064 },
1065 "isPublic": {
1066 "description": "Flag indicating whether or not a dataset is publicly viewable. If a dataset is not public, it inherits viewing permissions f rom its project.",
1067 "type": "boolean"
1068 },
1069 "name": {
1070 "description": "The dataset name.",
1071 "type": "string"
1072 },
1073 "projectId": {
1074 "description": "The Google Developers Console project number that this dataset belongs to.",
1075 "format": "int64",
1076 "type": "string"
1077 }
1078 },
1079 "type": "object"
1080 },
1081 "ExperimentalCreateJobRequest": {
1082 "description": "The job creation request.",
1083 "id": "ExperimentalCreateJobRequest",
1084 "properties": {
1085 "align": {
1086 "description": "Specifies whether or not to run the alignmen t pipeline. At least one of align or call_variants must be provided.",
1087 "type": "boolean"
1088 },
1089 "callVariants": {
1090 "description": "Specifies whether or not to run the variant calling pipeline. If specified, alignment will be performed first and the aligne d BAMs will passed as input to the variant caller. At least one of align or call _variants must be provided.",
1091 "type": "boolean"
1092 },
1093 "gcsOutputPath": {
1094 "description": "Specifies where to copy the results of certa in pipelines. This shoud be in the form of \"gs://bucket/path\".",
1095 "type": "string"
1096 },
1097 "pairedSourceUris": {
1098 "description": "A list of Google Cloud Storage URIs of paire d end .fastq files to operate upon. If specified, this represents the second fil e of each paired .fastq file. The first file of each pair should be specified in \"sourceUris\".",
1099 "items": {
1100 "type": "string"
1101 },
1102 "type": "array"
1103 },
1104 "projectId": {
1105 "description": "Required. The Google Cloud Project ID with w hich to associate the request.",
1106 "format": "int64",
1107 "type": "string"
1108 },
1109 "sourceUris": {
1110 "description": "A list of Google Cloud Storage URIs of data files to operate upon. These can be .bam, interleaved .fastq, or paired .fastq. If specifying paired .fastq files, the first of each pair of files should be lis ted here, and the second of each pair should be listed in \"pairedSourceUris\"." ,
1111 "items": {
1112 "type": "string"
1113 },
1114 "type": "array"
1115 }
1116 },
1117 "type": "object"
1118 },
1119 "ExperimentalCreateJobResponse": {
1120 "description": "The job creation response.",
1121 "id": "ExperimentalCreateJobResponse",
1122 "properties": {
1123 "jobId": {
1124 "description": "A job ID that can be used to get status info rmation.",
1125 "type": "string"
1126 }
1127 },
1128 "type": "object"
1129 },
1130 "ExportReadsetsRequest": {
1131 "description": "The readset export request.",
1132 "id": "ExportReadsetsRequest",
1133 "properties": {
1134 "exportUri": {
1135 "description": "A Google Cloud Storage URI where the exporte d BAM file will be created. The currently authenticated user must have write acc ess to the new file location. An error will be returned if the URI already conta ins data.",
1136 "type": "string"
1137 },
1138 "projectId": {
1139 "description": "The Google Developers Console project number that owns this export. This is the project that will be billed.",
1140 "format": "int64",
1141 "type": "string"
1142 },
1143 "readsetIds": {
1144 "description": "The IDs of the readsets to export.",
1145 "items": {
1146 "type": "string"
1147 },
1148 "type": "array"
1149 },
1150 "referenceNames": {
1151 "description": "The reference names to export. If this is no t specified, all reference sequences are exported. Use '*' to export unmapped re ads.",
1152 "items": {
1153 "type": "string"
1154 },
1155 "type": "array"
1156 }
1157 },
1158 "type": "object"
1159 },
1160 "ExportReadsetsResponse": {
1161 "description": "The readset export response.",
1162 "id": "ExportReadsetsResponse",
1163 "properties": {
1164 "jobId": {
1165 "description": "A job ID that can be used to get status info rmation.",
1166 "type": "string"
1167 }
1168 },
1169 "type": "object"
1170 },
1171 "ExportVariantsRequest": {
1172 "description": "The variant data export request.",
1173 "id": "ExportVariantsRequest",
1174 "properties": {
1175 "bigqueryDataset": {
1176 "description": "The BigQuery dataset to export data to. Note that this is distinct from the Genomics concept of \"dataset\". The caller must have WRITE access to this BigQuery dataset.",
1177 "type": "string"
1178 },
1179 "bigqueryTable": {
1180 "description": "The BigQuery table to export data to. The ca ller must have WRITE access to this BigQuery table.",
1181 "type": "string"
1182 },
1183 "callsetIds": {
1184 "description": "If provided, only variant call information f rom the specified callsets will be exported. By default all variant calls are ex ported.",
1185 "items": {
1186 "type": "string"
1187 },
1188 "type": "array"
1189 },
1190 "format": {
1191 "description": "The format for the exported data.",
1192 "enum": [
1193 "bigquery"
1194 ],
1195 "enumDescriptions": [
1196 ""
1197 ],
1198 "type": "string"
1199 },
1200 "projectId": {
1201 "description": "The Google Cloud project number that owns th is export. This is the project that will be billed.",
1202 "format": "int64",
1203 "type": "string"
1204 },
1205 "variantsetId": {
1206 "description": "Required. The ID of the variantset that cont ains variant data which should be exported. The caller must have READ access to this variantset.",
1207 "type": "string"
1208 }
1209 },
1210 "type": "object"
1211 },
1212 "ExportVariantsResponse": {
1213 "description": "The variant data export response.",
1214 "id": "ExportVariantsResponse",
1215 "properties": {
1216 "jobId": {
1217 "description": "A job ID that can be used to get status info rmation.",
1218 "type": "string"
1219 }
1220 },
1221 "type": "object"
1222 },
1223 "GenomicRange": {
1224 "description": "An inclusive, exclusive genomic coordinate range ove r a reference sequence.",
1225 "id": "GenomicRange",
1226 "properties": {
1227 "sequenceEnd": {
1228 "description": "The end position of the range on the referen ce, 1-based exclusive. If specified, sequenceName must also be specified.",
1229 "format": "uint64",
1230 "type": "string"
1231 },
1232 "sequenceName": {
1233 "description": "The reference sequence name, for example \"c hr1\", \"1\", or \"chrX\".",
1234 "type": "string"
1235 },
1236 "sequenceStart": {
1237 "description": "The start position of the range on the refer ence, 1-based inclusive. If specified, sequenceName must also be specified.",
1238 "format": "uint64",
1239 "type": "string"
1240 }
1241 },
1242 "type": "object"
1243 },
1244 "GetVariantsSummaryResponse": {
1245 "description": "The variants summary response.",
1246 "id": "GetVariantsSummaryResponse",
1247 "properties": {
1248 "contigBounds": {
1249 "description": "A list of all contigs used by the variants i n a dataset with associated coordinate upper bounds for each one.",
1250 "items": {
1251 "$ref": "ContigBound"
1252 },
1253 "type": "array"
1254 },
1255 "metadata": {
1256 "description": "The metadata associated with this dataset.",
1257 "items": {
1258 "$ref": "Metadata"
1259 },
1260 "type": "array"
1261 }
1262 },
1263 "type": "object"
1264 },
1265 "Header": {
1266 "id": "Header",
1267 "properties": {
1268 "sortingOrder": {
1269 "description": "(SO) Sorting order of alignments.",
1270 "type": "string"
1271 },
1272 "version": {
1273 "description": "(VN) BAM format version.",
1274 "type": "string"
1275 }
1276 },
1277 "type": "object"
1278 },
1279 "HeaderSection": {
1280 "description": "The header section of the BAM/SAM file.",
1281 "id": "HeaderSection",
1282 "properties": {
1283 "comments": {
1284 "description": "(@CO) One-line text comments.",
1285 "items": {
1286 "type": "string"
1287 },
1288 "type": "array"
1289 },
1290 "fileUri": {
1291 "description": "[Deprecated] This field is deprecated and wi ll no longer be populated. Please use filename instead.",
1292 "type": "string"
1293 },
1294 "filename": {
1295 "description": "The name of the file from which this data wa s imported.",
1296 "type": "string"
1297 },
1298 "headers": {
1299 "description": "(@HD) The header line.",
1300 "items": {
1301 "$ref": "Header"
1302 },
1303 "type": "array"
1304 },
1305 "programs": {
1306 "description": "(@PG) Programs.",
1307 "items": {
1308 "$ref": "Program"
1309 },
1310 "type": "array"
1311 },
1312 "readGroups": {
1313 "description": "(@RG) Read group.",
1314 "items": {
1315 "$ref": "ReadGroup"
1316 },
1317 "type": "array"
1318 },
1319 "refSequences": {
1320 "description": "(@SQ) Reference sequence dictionary.",
1321 "items": {
1322 "$ref": "ReferenceSequence"
1323 },
1324 "type": "array"
1325 }
1326 },
1327 "type": "object"
1328 },
1329 "ImportReadsetsRequest": {
1330 "description": "The readset import request.",
1331 "id": "ImportReadsetsRequest",
1332 "properties": {
1333 "datasetId": {
1334 "description": "Required. The ID of the dataset these readse ts will belong to. The caller must have WRITE permissions to this dataset.",
1335 "type": "string"
1336 },
1337 "sourceUris": {
1338 "description": "A list of URIs pointing at BAM files in Goog le Cloud Storage.",
1339 "items": {
1340 "type": "string"
1341 },
1342 "type": "array"
1343 }
1344 },
1345 "type": "object"
1346 },
1347 "ImportReadsetsResponse": {
1348 "description": "The readset import response.",
1349 "id": "ImportReadsetsResponse",
1350 "properties": {
1351 "jobId": {
1352 "description": "A job ID that can be used to get status info rmation.",
1353 "type": "string"
1354 }
1355 },
1356 "type": "object"
1357 },
1358 "ImportVariantsRequest": {
1359 "description": "The variant data import request.",
1360 "id": "ImportVariantsRequest",
1361 "properties": {
1362 "format": {
1363 "description": "The format of the variant data being importe d.",
1364 "enum": [
1365 "completeGenomics",
1366 "vcf"
1367 ],
1368 "enumDescriptions": [
1369 "",
1370 ""
1371 ],
1372 "type": "string"
1373 },
1374 "sourceUris": {
1375 "description": "A list of URIs pointing at VCF files in Goog le Cloud Storage. See the VCF Specification for more details on the input format .",
1376 "items": {
1377 "type": "string"
1378 },
1379 "type": "array"
1380 },
1381 "variantsetId": {
1382 "description": "Required. The variantset to which variant da ta should be imported.",
1383 "type": "string"
1384 }
1385 },
1386 "type": "object"
1387 },
1388 "ImportVariantsResponse": {
1389 "description": "The variant data import response.",
1390 "id": "ImportVariantsResponse",
1391 "properties": {
1392 "jobId": {
1393 "description": "A job ID that can be used to get status info rmation.",
1394 "type": "string"
1395 }
1396 },
1397 "type": "object"
1398 },
1399 "Job": {
1400 "description": "A Job represents an ongoing process that can be moni tored for status information.",
1401 "id": "Job",
1402 "properties": {
1403 "created": {
1404 "description": "The date this job was created, in millisecon ds from the epoch.",
1405 "format": "int64",
1406 "type": "string"
1407 },
1408 "description": {
1409 "description": "A more detailed description of this job's cu rrent status.",
1410 "type": "string"
1411 },
1412 "errors": {
1413 "description": "Any errors that occurred during processing." ,
1414 "items": {
1415 "type": "string"
1416 },
1417 "type": "array"
1418 },
1419 "id": {
1420 "description": "The job ID.",
1421 "type": "string"
1422 },
1423 "importedIds": {
1424 "description": "If this Job represents an import, this field will contain the IDs of the objects that were successfully imported.",
1425 "items": {
1426 "type": "string"
1427 },
1428 "type": "array"
1429 },
1430 "projectId": {
1431 "description": "The Google Developers Console project number to which this job belongs.",
1432 "format": "int64",
1433 "type": "string"
1434 },
1435 "request": {
1436 "$ref": "JobRequest",
1437 "description": "A summarized representation of the original service request."
1438 },
1439 "status": {
1440 "description": "The status of this job.",
1441 "enum": [
1442 "canceled",
1443 "failure",
1444 "new",
1445 "pending",
1446 "running",
1447 "success",
1448 "unknownStatus"
1449 ],
1450 "enumDescriptions": [
1451 "",
1452 "",
1453 "",
1454 "",
1455 "",
1456 "",
1457 ""
1458 ],
1459 "type": "string"
1460 },
1461 "warnings": {
1462 "description": "Any warnings that occurred during processing .",
1463 "items": {
1464 "type": "string"
1465 },
1466 "type": "array"
1467 }
1468 },
1469 "type": "object"
1470 },
1471 "JobRequest": {
1472 "description": "A summary representation of the service request that spawned the job.",
1473 "id": "JobRequest",
1474 "properties": {
1475 "destination": {
1476 "description": "The data destination of the request, for exa mple, a Google BigQuery Table or Dataset ID.",
1477 "items": {
1478 "type": "string"
1479 },
1480 "type": "array"
1481 },
1482 "source": {
1483 "description": "The data source of the request, for example, a Google Cloud Storage object path or Readset ID.",
1484 "items": {
1485 "type": "string"
1486 },
1487 "type": "array"
1488 },
1489 "type": {
1490 "description": "The original request type.",
1491 "enum": [
1492 "experimentalCreateJob",
1493 "exportReadsets",
1494 "exportVariants",
1495 "importReadsets",
1496 "importVariants",
1497 "unknownType"
1498 ],
1499 "enumDescriptions": [
1500 "",
1501 "",
1502 "",
1503 "",
1504 "",
1505 ""
1506 ],
1507 "type": "string"
1508 }
1509 },
1510 "type": "object"
1511 },
1512 "ListCoverageBucketsResponse": {
1513 "id": "ListCoverageBucketsResponse",
1514 "properties": {
1515 "bucketWidth": {
1516 "description": "The length of each coverage bucket in base p airs. Note that buckets at the end of a reference sequence may be shorter. This value is omitted if the bucket width is infinity (the default behaviour, with no range or target_bucket_width).",
1517 "format": "uint64",
1518 "type": "string"
1519 },
1520 "coverageBuckets": {
1521 "description": "The coverage buckets. The list of buckets is sparse; a bucket with 0 overlapping reads is not returned. A bucket never cross es more than one reference sequence. Each bucket has width bucket_width, unless its end is is the end of the reference sequence.",
1522 "items": {
1523 "$ref": "CoverageBucket"
1524 },
1525 "type": "array"
1526 },
1527 "nextPageToken": {
1528 "description": "The continuation token, which is used to pag e through large result sets. Provide this value in a subsequent request to retur n the next page of results. This field will be empty if there aren't any additio nal results.",
1529 "type": "string"
1530 }
1531 },
1532 "type": "object"
1533 },
1534 "ListDatasetsResponse": {
1535 "description": "The dataset list response.",
1536 "id": "ListDatasetsResponse",
1537 "properties": {
1538 "datasets": {
1539 "description": "The list of matching Datasets.",
1540 "items": {
1541 "$ref": "Dataset"
1542 },
1543 "type": "array"
1544 },
1545 "nextPageToken": {
1546 "description": "The continuation token, which is used to pag e through large result sets. Provide this value in a subsequent request to retur n the next page of results. This field will be empty if there aren't any additio nal results.",
1547 "type": "string"
1548 }
1549 },
1550 "type": "object"
1551 },
1552 "Metadata": {
1553 "description": "Metadata describes a single piece of variant call me tadata. These data include a top level key and either a single value string (val ue) or a list of key-value pairs (info.) Value and info are mutually exclusive." ,
1554 "id": "Metadata",
1555 "properties": {
1556 "description": {
1557 "description": "A textual description of this metadata.",
1558 "type": "string"
1559 },
1560 "id": {
1561 "description": "User-provided ID field, not enforced by this API. Two or more pieces of structured metadata with identical id and key fields are considered equivalent.",
1562 "type": "string"
1563 },
1564 "info": {
1565 "additionalProperties": {
1566 "description": "A string which maps to an array of value s.",
1567 "items": {
1568 "type": "string"
1569 },
1570 "type": "array"
1571 },
1572 "description": "Remaining structured metadata key-value pair s.",
1573 "type": "object"
1574 },
1575 "key": {
1576 "description": "The top-level key.",
1577 "type": "string"
1578 },
1579 "number": {
1580 "description": "The number of values that can be included in a field described by this metadata.",
1581 "type": "string"
1582 },
1583 "type": {
1584 "description": "The type of data. Possible types include: In teger, Float, Flag, Character, and String.",
1585 "enum": [
1586 "character",
1587 "flag",
1588 "float",
1589 "integer",
1590 "string",
1591 "unknownType"
1592 ],
1593 "enumDescriptions": [
1594 "",
1595 "",
1596 "",
1597 "",
1598 "",
1599 ""
1600 ],
1601 "type": "string"
1602 },
1603 "value": {
1604 "description": "The value field for simple metadata",
1605 "type": "string"
1606 }
1607 },
1608 "type": "object"
1609 },
1610 "Program": {
1611 "id": "Program",
1612 "properties": {
1613 "commandLine": {
1614 "description": "(CL) Command line.",
1615 "type": "string"
1616 },
1617 "id": {
1618 "description": "(ID) Program record identifier.",
1619 "type": "string"
1620 },
1621 "name": {
1622 "description": "(PN) Program name.",
1623 "type": "string"
1624 },
1625 "prevProgramId": {
1626 "description": "(PP) Previous program ID.",
1627 "type": "string"
1628 },
1629 "version": {
1630 "description": "(VN) Program version.",
1631 "type": "string"
1632 }
1633 },
1634 "type": "object"
1635 },
1636 "Read": {
1637 "description": "A Read is a group of bases that may or may not have been aligned to a reference. It contains quality information and other metadata. ",
1638 "id": "Read",
1639 "properties": {
1640 "alignedBases": {
1641 "description": "The originalBases after the cigar field has been applied. Deletions are represented with '-' and insertions are omitted.",
1642 "type": "string"
1643 },
1644 "baseQuality": {
1645 "description": "Represents the quality of each base in this read. Each character represents one base. To get the quality, take the ASCII val ue of the character and subtract 33. (QUAL)",
1646 "type": "string"
1647 },
1648 "cigar": {
1649 "description": "A condensed representation of how this read matches up to the reference. (CIGAR)",
1650 "type": "string"
1651 },
1652 "flags": {
1653 "description": "Each bit of this number has a different mean ing if enabled. See the full BAM spec for more details. (FLAG)",
1654 "format": "int32",
1655 "type": "integer"
1656 },
1657 "id": {
1658 "description": "The Google generated ID of the read, immutab le.",
1659 "type": "string"
1660 },
1661 "mappingQuality": {
1662 "description": "A score up to 255 that represents how likely this read's aligned position is to be correct. A higher value is better. (MAPQ) ",
1663 "format": "int32",
1664 "type": "integer"
1665 },
1666 "matePosition": {
1667 "description": "The 1-based start position of the paired rea d. (PNEXT)",
1668 "format": "int32",
1669 "type": "integer"
1670 },
1671 "mateReferenceSequenceName": {
1672 "description": "The name of the sequence that the paired rea d is aligned to. This is usually the same as referenceSequenceName. (RNEXT)",
1673 "type": "string"
1674 },
1675 "name": {
1676 "description": "The name of the read. When imported from a B AM file, this is the query template name. (QNAME)",
1677 "type": "string"
1678 },
1679 "originalBases": {
1680 "description": "The list of bases that this read represents (such as \"CATCGA\"). (SEQ)",
1681 "type": "string"
1682 },
1683 "position": {
1684 "description": "The 1-based start position of the aligned re ad. If the first base starts at the very beginning of the reference sequence, th en the position would be '1'. (POS)",
1685 "format": "int32",
1686 "type": "integer"
1687 },
1688 "readsetId": {
1689 "description": "The ID of the readset this read belongs to." ,
1690 "type": "string"
1691 },
1692 "referenceSequenceName": {
1693 "description": "The name of the sequence that this read is a ligned to. This would be, for example, 'X' for the X Chromosome or '20' for Chro mosome 20. (RNAME)",
1694 "type": "string"
1695 },
1696 "tags": {
1697 "additionalProperties": {
1698 "description": "A string which maps to an array of value s.",
1699 "items": {
1700 "type": "string"
1701 },
1702 "type": "array"
1703 },
1704 "description": "A map of additional read information. (TAG)" ,
1705 "type": "object"
1706 },
1707 "templateLength": {
1708 "description": "Length of the original piece of DNA that pro duced both this read and the paired read. (TLEN)",
1709 "format": "int32",
1710 "type": "integer"
1711 }
1712 },
1713 "type": "object"
1714 },
1715 "ReadGroup": {
1716 "id": "ReadGroup",
1717 "properties": {
1718 "date": {
1719 "description": "(DT) Date the run was produced (ISO8601 date or date/time).",
1720 "type": "string"
1721 },
1722 "description": {
1723 "description": "(DS) Description.",
1724 "type": "string"
1725 },
1726 "flowOrder": {
1727 "description": "(FO) Flow order. The array of nucleotide bas es that correspond to the nucleotides used for each flow of each read.",
1728 "type": "string"
1729 },
1730 "id": {
1731 "description": "(ID) Read group identifier.",
1732 "type": "string"
1733 },
1734 "keySequence": {
1735 "description": "(KS) The array of nucleotide bases that corr espond to the key sequence of each read.",
1736 "type": "string"
1737 },
1738 "library": {
1739 "description": "(LS) Library.",
1740 "type": "string"
1741 },
1742 "platformUnit": {
1743 "description": "(PU) Platform unit.",
1744 "type": "string"
1745 },
1746 "predictedInsertSize": {
1747 "description": "(PI) Predicted median insert size.",
1748 "format": "int32",
1749 "type": "integer"
1750 },
1751 "processingProgram": {
1752 "description": "(PG) Programs used for processing the read g roup.",
1753 "type": "string"
1754 },
1755 "sample": {
1756 "description": "(SM) Sample.",
1757 "type": "string"
1758 },
1759 "sequencingCenterName": {
1760 "description": "(CN) Name of sequencing center producing the read.",
1761 "type": "string"
1762 },
1763 "sequencingTechnology": {
1764 "description": "(PL) Platform/technology used to produce the reads.",
1765 "type": "string"
1766 }
1767 },
1768 "type": "object"
1769 },
1770 "Readset": {
1771 "description": "A Readset is a collection of Reads.",
1772 "id": "Readset",
1773 "properties": {
1774 "datasetId": {
1775 "description": "The ID of the dataset this readset belongs t o.",
1776 "type": "string"
1777 },
1778 "fileData": {
1779 "description": "File information from the original BAM impor t. See the BAM format specification for additional information on each field.",
1780 "items": {
1781 "$ref": "HeaderSection"
1782 },
1783 "type": "array"
1784 },
1785 "id": {
1786 "description": "The Google generated ID of the readset, immu table.",
1787 "type": "string"
1788 },
1789 "name": {
1790 "description": "The readset name, typically this is the samp le name.",
1791 "type": "string"
1792 }
1793 },
1794 "type": "object"
1795 },
1796 "ReferenceSequence": {
1797 "id": "ReferenceSequence",
1798 "properties": {
1799 "assemblyId": {
1800 "description": "(AS) Genome assembly identifier.",
1801 "type": "string"
1802 },
1803 "length": {
1804 "description": "(LN) Reference sequence length.",
1805 "format": "int32",
1806 "type": "integer"
1807 },
1808 "md5Checksum": {
1809 "description": "(M5) MD5 checksum of the sequence in the upp ercase, excluding spaces but including pads as *.",
1810 "type": "string"
1811 },
1812 "name": {
1813 "description": "(SN) Reference sequence name.",
1814 "type": "string"
1815 },
1816 "species": {
1817 "description": "(SP) Species.",
1818 "type": "string"
1819 },
1820 "uri": {
1821 "description": "(UR) URI of the sequence.",
1822 "type": "string"
1823 }
1824 },
1825 "type": "object"
1826 },
1827 "SearchCallsetsRequest": {
1828 "description": "The callset search request.",
1829 "id": "SearchCallsetsRequest",
1830 "properties": {
1831 "maxResults": {
1832 "description": "The maximum number of callsets to return.",
1833 "format": "uint64",
1834 "type": "string"
1835 },
1836 "name": {
1837 "description": "Only return callsets for which a substring o f the name matches this string.",
1838 "type": "string"
1839 },
1840 "pageToken": {
1841 "description": "The continuation token, which is used to pag e through large result sets. To get the next page of results, set this parameter to the value of \"nextPageToken\" from the previous response.",
1842 "type": "string"
1843 },
1844 "variantsetIds": {
1845 "description": "Restrict the query to callsets within the gi ven variantsets. At least one ID must be provided.",
1846 "items": {
1847 "type": "string"
1848 },
1849 "type": "array"
1850 }
1851 },
1852 "type": "object"
1853 },
1854 "SearchCallsetsResponse": {
1855 "description": "The callset search response.",
1856 "id": "SearchCallsetsResponse",
1857 "properties": {
1858 "callsets": {
1859 "description": "The list of matching callsets.",
1860 "items": {
1861 "$ref": "Callset"
1862 },
1863 "type": "array"
1864 },
1865 "nextPageToken": {
1866 "description": "The continuation token, which is used to pag e through large result sets. Provide this value in a subsequent request to retur n the next page of results. This field will be empty if there aren't any additio nal results.",
1867 "type": "string"
1868 }
1869 },
1870 "type": "object"
1871 },
1872 "SearchJobsRequest": {
1873 "description": "The jobs search request.",
1874 "id": "SearchJobsRequest",
1875 "properties": {
1876 "createdAfter": {
1877 "description": "If specified, only jobs created on or after this date, given in milliseconds since Unix epoch, will be returned.",
1878 "format": "int64",
1879 "type": "string"
1880 },
1881 "createdBefore": {
1882 "description": "If specified, only jobs created prior to thi s date, given in milliseconds since Unix epoch, will be returned.",
1883 "format": "int64",
1884 "type": "string"
1885 },
1886 "maxResults": {
1887 "description": "Specifies the number of results to return in a single page. Defaults to 128. The maximum value is 256.",
1888 "format": "uint64",
1889 "type": "string"
1890 },
1891 "pageToken": {
1892 "description": "The continuation token which is used to page through large result sets. To get the next page of results, set this parameter to the value of the \"nextPageToken\" from the previous response.",
1893 "type": "string"
1894 },
1895 "projectId": {
1896 "description": "Required. Only return jobs which belong to t his Google Developers Console project. Only accepts project numbers.",
1897 "format": "int64",
1898 "type": "string"
1899 },
1900 "status": {
1901 "description": "Only return jobs which have a matching statu s.",
1902 "items": {
1903 "enum": [
1904 "canceled",
1905 "failure",
1906 "new",
1907 "pending",
1908 "running",
1909 "success",
1910 "unknownStatus"
1911 ],
1912 "enumDescriptions": [
1913 "",
1914 "",
1915 "",
1916 "",
1917 "",
1918 "",
1919 ""
1920 ],
1921 "type": "string"
1922 },
1923 "type": "array"
1924 }
1925 },
1926 "type": "object"
1927 },
1928 "SearchJobsResponse": {
1929 "description": "The job search response.",
1930 "id": "SearchJobsResponse",
1931 "properties": {
1932 "jobs": {
1933 "description": "The list of jobs results, ordered newest to oldest.",
1934 "items": {
1935 "$ref": "Job"
1936 },
1937 "type": "array"
1938 },
1939 "nextPageToken": {
1940 "description": "The continuation token which is used to page through large result sets. Provide this value is a subsequent request to return the next page of results. This field will be empty if there are no more results .",
1941 "type": "string"
1942 }
1943 },
1944 "type": "object"
1945 },
1946 "SearchReadsRequest": {
1947 "description": "The read search request.",
1948 "id": "SearchReadsRequest",
1949 "properties": {
1950 "maxResults": {
1951 "description": "Specifies number of results to return in a s ingle page. If unspecified, it will default to 256. The maximum value is 2048.",
1952 "format": "uint64",
1953 "type": "string"
1954 },
1955 "pageToken": {
1956 "description": "The continuation token, which is used to pag e through large result sets. To get the next page of results, set this parameter to the value of \"nextPageToken\" from the previous response.",
1957 "type": "string"
1958 },
1959 "readsetIds": {
1960 "description": "The readsets within which to search for read s. At least one readset ID must be provided. All specified readsets must be alig ned against a common set of reference sequences; this defines the genomic coordi nates for the query.",
1961 "items": {
1962 "type": "string"
1963 },
1964 "type": "array"
1965 },
1966 "sequenceEnd": {
1967 "description": "The end position (1-based, inclusive) of the target range. If specified, \"sequenceName\" must also be specified. Defaults t o the end of the target reference sequence, if any.",
1968 "format": "uint64",
1969 "type": "string"
1970 },
1971 "sequenceName": {
1972 "description": "Restricts the results to a particular refere nce sequence such as '1', 'chr1', or 'X'. The set of valid references sequences depends on the readsets specified. If set to \"*\", only unmapped Reads are retu rned.",
1973 "type": "string"
1974 },
1975 "sequenceStart": {
1976 "description": "The start position (1-based, inclusive) of t he target range. If specified, \"sequenceName\" must also be specified. Defaults to the start of the target reference sequence, if any.",
1977 "format": "uint64",
1978 "type": "string"
1979 }
1980 },
1981 "type": "object"
1982 },
1983 "SearchReadsResponse": {
1984 "description": "The read search response.",
1985 "id": "SearchReadsResponse",
1986 "properties": {
1987 "nextPageToken": {
1988 "description": "The continuation token, which is used to pag e through large result sets. Provide this value in a subsequent request to retur n the next page of results. This field will be empty if there aren't any additio nal results.",
1989 "type": "string"
1990 },
1991 "reads": {
1992 "description": "The list of matching Reads. The resulting Re ads are sorted by position; the smallest positions are returned first. Unmapped reads, which have no position, are returned last and are further sorted alphabet ically by name.",
1993 "items": {
1994 "$ref": "Read"
1995 },
1996 "type": "array"
1997 }
1998 },
1999 "type": "object"
2000 },
2001 "SearchReadsetsRequest": {
2002 "description": "The readset search request.",
2003 "id": "SearchReadsetsRequest",
2004 "properties": {
2005 "datasetIds": {
2006 "description": "Restricts this query to readsets within the given datasets. At least one ID must be provided.",
2007 "items": {
2008 "type": "string"
2009 },
2010 "type": "array"
2011 },
2012 "maxResults": {
2013 "description": "Specifies number of results to return in a s ingle page. If unspecified, it will default to 128. The maximum value is 1024.",
2014 "format": "uint64",
2015 "type": "string"
2016 },
2017 "name": {
2018 "description": "Only return readsets for which a substring o f the name matches this string.",
2019 "type": "string"
2020 },
2021 "pageToken": {
2022 "description": "The continuation token, which is used to pag e through large result sets. To get the next page of results, set this parameter to the value of \"nextPageToken\" from the previous response.",
2023 "type": "string"
2024 }
2025 },
2026 "type": "object"
2027 },
2028 "SearchReadsetsResponse": {
2029 "description": "The readset search response.",
2030 "id": "SearchReadsetsResponse",
2031 "properties": {
2032 "nextPageToken": {
2033 "description": "The continuation token, which is used to pag e through large result sets. Provide this value in a subsequent request to retur n the next page of results. This field will be empty if there aren't any additio nal results.",
2034 "type": "string"
2035 },
2036 "readsets": {
2037 "description": "The list of matching Readsets.",
2038 "items": {
2039 "$ref": "Readset"
2040 },
2041 "type": "array"
2042 }
2043 },
2044 "type": "object"
2045 },
2046 "SearchVariantsRequest": {
2047 "description": "The variant search request.",
2048 "id": "SearchVariantsRequest",
2049 "properties": {
2050 "callsetIds": {
2051 "description": "Only return variant calls which belong to ca llsets with these ids. Leaving this blank returns all variant calls. At most one of callsetNames or callsetIds should be provided.",
2052 "items": {
2053 "type": "string"
2054 },
2055 "type": "array"
2056 },
2057 "callsetNames": {
2058 "description": "Only return variant calls which belong to ca llsets which have exactly these names. Leaving this blank returns all variant ca lls. At most one of callsetNames or callsetIds should be provided.",
2059 "items": {
2060 "type": "string"
2061 },
2062 "type": "array"
2063 },
2064 "contig": {
2065 "description": "Required. Only return variants on this conti g.",
2066 "type": "string"
2067 },
2068 "endPosition": {
2069 "description": "Required. The end of the window (0-based, ex clusive) for which overlapping variants should be returned.",
2070 "format": "int64",
2071 "type": "string"
2072 },
2073 "maxResults": {
2074 "description": "The maximum number of variants to return.",
2075 "format": "uint64",
2076 "type": "string"
2077 },
2078 "pageToken": {
2079 "description": "The continuation token, which is used to pag e through large result sets. To get the next page of results, set this parameter to the value of \"nextPageToken\" from the previous response.",
2080 "type": "string"
2081 },
2082 "startPosition": {
2083 "description": "Required. The beginning of the window (0-bas ed, inclusive) for which overlapping variants should be returned.",
2084 "format": "int64",
2085 "type": "string"
2086 },
2087 "variantName": {
2088 "description": "Only return variants which have exactly this name.",
2089 "type": "string"
2090 },
2091 "variantsetId": {
2092 "description": "Required. The ID of the variantset to search .",
2093 "type": "string"
2094 }
2095 },
2096 "type": "object"
2097 },
2098 "SearchVariantsResponse": {
2099 "description": "The variant search response.",
2100 "id": "SearchVariantsResponse",
2101 "properties": {
2102 "nextPageToken": {
2103 "description": "The continuation token, which is used to pag e through large result sets. Provide this value in a subsequent request to retur n the next page of results. This field will be empty if there aren't any additio nal results.",
2104 "type": "string"
2105 },
2106 "variants": {
2107 "description": "The list of matching Variants.",
2108 "items": {
2109 "$ref": "Variant"
2110 },
2111 "type": "array"
2112 }
2113 },
2114 "type": "object"
2115 },
2116 "Variant": {
2117 "description": "A Variant represents a change in DNA sequence relati ve to some reference. For example, a Variant could represent a SNP or an inserti on. Variants belong to a Variantset.",
2118 "id": "Variant",
2119 "properties": {
2120 "alternateBases": {
2121 "description": "The bases that appear instead of the referen ce bases.",
2122 "items": {
2123 "type": "string"
2124 },
2125 "type": "array"
2126 },
2127 "calls": {
2128 "description": "The variant calls for this particular varian t. Each one represents the determination of genotype with respect to this varian t.",
2129 "items": {
2130 "$ref": "Call"
2131 },
2132 "type": "array"
2133 },
2134 "contig": {
2135 "description": "The contig on which this variant occurs. (su ch as 'chr20' or 'X')",
2136 "type": "string"
2137 },
2138 "created": {
2139 "description": "The date this variant was created, in millis econds from the epoch.",
2140 "format": "int64",
2141 "type": "string"
2142 },
2143 "end": {
2144 "description": "The end position (0-based) of this variant. This corresponds to the first base after the last base in the reference allele. So, the length of the reference allele is (end - position). This is useful for v ariants that don't explicitly give alternate bases, for example large deletions. ",
2145 "format": "int64",
2146 "type": "string"
2147 },
2148 "id": {
2149 "description": "The Google generated ID of the variant, immu table.",
2150 "type": "string"
2151 },
2152 "info": {
2153 "additionalProperties": {
2154 "description": "A string which maps to an array of value s.",
2155 "items": {
2156 "type": "string"
2157 },
2158 "type": "array"
2159 },
2160 "description": "A map of additional variant information.",
2161 "type": "object"
2162 },
2163 "names": {
2164 "description": "Names for the variant, for example a RefSNP ID.",
2165 "items": {
2166 "type": "string"
2167 },
2168 "type": "array"
2169 },
2170 "position": {
2171 "description": "The position at which this variant occurs (0 -based). This corresponds to the first base of the string of reference bases.",
2172 "format": "int64",
2173 "type": "string"
2174 },
2175 "referenceBases": {
2176 "description": "The reference bases for this variant. They s tart at the given position.",
2177 "type": "string"
2178 },
2179 "variantsetId": {
2180 "description": "The ID of the variantset this variant belong s to.",
2181 "type": "string"
2182 }
2183 },
2184 "type": "object"
2185 }
2186 },
2187 "servicePath": "genomics/v1beta/",
2188 "title": "Genomics API",
2189 "version": "v1beta"
2190 }
OLDNEW
« no previous file with comments | « discovery/googleapis_beta/dns__v1beta1.json ('k') | discovery/googleapis_beta/manager__v1beta2.json » ('j') | pubspec.yaml » ('J')

Powered by Google App Engine
This is Rietveld 408576698