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

Issues Search
    My Issues | Starred     Open | Closed | All

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

Issue 2571553005: Api-roll 43: 2016-12-13 (Closed)
Patch Set: Created 4 years 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__v2beta1.json ('k') | discovery/googleapis_beta/language__v1beta1.json » ('j') | no next file with comments »
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/cloud-platform": {
9 "description": "View and manage your data across Google Clou d Platform services"
10 },
11 "https://www.googleapis.com/auth/devstorage.read_write": {
12 "description": "Manage your data in Google Cloud Storage"
13 },
14 "https://www.googleapis.com/auth/genomics": {
15 "description": "View and manage Genomics data"
16 },
17 "https://www.googleapis.com/auth/genomics.readonly": {
18 "description": "View Genomics data"
19 }
20 }
21 }
22 },
23 "basePath": "/genomics/v1beta2/",
24 "baseUrl": "https://www.googleapis.com/genomics/v1beta2/",
25 "batchPath": "batch",
26 "description": "Provides access to Genomics data.",
27 "discoveryVersion": "v1",
28 "documentationLink": "https://developers.google.com/genomics/v1beta2/referen ce",
29 "etag": "\"C5oy1hgQsABtYOYIOXWcR3BgYqU/g_QaE_FyuylC4ixL3GgHocQz4DE\"",
30 "icons": {
31 "x16": "http://www.google.com/images/icons/product/search-16.gif",
32 "x32": "http://www.google.com/images/icons/product/search-32.gif"
33 },
34 "id": "genomics:v1beta2",
35 "kind": "discovery#restDescription",
36 "name": "genomics",
37 "ownerDomain": "google.com",
38 "ownerName": "Google",
39 "parameters": {
40 "alt": {
41 "default": "json",
42 "description": "Data format for the response.",
43 "enum": [
44 "json"
45 ],
46 "enumDescriptions": [
47 "Responses with Content-Type of application/json"
48 ],
49 "location": "query",
50 "type": "string"
51 },
52 "fields": {
53 "description": "Selector specifying which fields to include in a par tial response.",
54 "location": "query",
55 "type": "string"
56 },
57 "key": {
58 "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.",
59 "location": "query",
60 "type": "string"
61 },
62 "oauth_token": {
63 "description": "OAuth 2.0 token for the current user.",
64 "location": "query",
65 "type": "string"
66 },
67 "prettyPrint": {
68 "default": "true",
69 "description": "Returns response with indentations and line breaks." ,
70 "location": "query",
71 "type": "boolean"
72 },
73 "quotaUser": {
74 "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.",
75 "location": "query",
76 "type": "string"
77 },
78 "userIp": {
79 "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
80 "location": "query",
81 "type": "string"
82 }
83 },
84 "protocol": "rest",
85 "resources": {
86 "annotationSets": {
87 "methods": {
88 "create": {
89 "description": "Creates a new annotation set. Caller must ha ve WRITE permission for the associated dataset.\n\nThe following fields must be provided when creating an annotation set: \n- datasetId \n- referenceSetId \nA ll other fields may be optionally specified, unless documented as being server-g enerated (for example, the id field).",
90 "httpMethod": "POST",
91 "id": "genomics.annotationSets.create",
92 "path": "annotationSets",
93 "request": {
94 "$ref": "AnnotationSet"
95 },
96 "response": {
97 "$ref": "AnnotationSet"
98 },
99 "scopes": [
100 "https://www.googleapis.com/auth/cloud-platform",
101 "https://www.googleapis.com/auth/genomics"
102 ]
103 },
104 "delete": {
105 "description": "Deletes an annotation set. Caller must have WRITE permission for the associated annotation set.",
106 "httpMethod": "DELETE",
107 "id": "genomics.annotationSets.delete",
108 "parameterOrder": [
109 "annotationSetId"
110 ],
111 "parameters": {
112 "annotationSetId": {
113 "description": "The ID of the annotation set to be d eleted.",
114 "location": "path",
115 "required": true,
116 "type": "string"
117 }
118 },
119 "path": "annotationSets/{annotationSetId}",
120 "scopes": [
121 "https://www.googleapis.com/auth/cloud-platform",
122 "https://www.googleapis.com/auth/genomics"
123 ]
124 },
125 "get": {
126 "description": "Gets an annotation set. Caller must have REA D permission for the associated dataset.",
127 "httpMethod": "GET",
128 "id": "genomics.annotationSets.get",
129 "parameterOrder": [
130 "annotationSetId"
131 ],
132 "parameters": {
133 "annotationSetId": {
134 "description": "The ID of the annotation set to be r etrieved.",
135 "location": "path",
136 "required": true,
137 "type": "string"
138 }
139 },
140 "path": "annotationSets/{annotationSetId}",
141 "response": {
142 "$ref": "AnnotationSet"
143 },
144 "scopes": [
145 "https://www.googleapis.com/auth/cloud-platform",
146 "https://www.googleapis.com/auth/genomics",
147 "https://www.googleapis.com/auth/genomics.readonly"
148 ]
149 },
150 "patch": {
151 "description": "Updates an annotation set. The update must r espect all mutability restrictions and other invariants described on the annotat ion set resource. Caller must have WRITE permission for the associated dataset. This method supports patch semantics.",
152 "httpMethod": "PATCH",
153 "id": "genomics.annotationSets.patch",
154 "parameterOrder": [
155 "annotationSetId"
156 ],
157 "parameters": {
158 "annotationSetId": {
159 "description": "The ID of the annotation set to be u pdated.",
160 "location": "path",
161 "required": true,
162 "type": "string"
163 }
164 },
165 "path": "annotationSets/{annotationSetId}",
166 "request": {
167 "$ref": "AnnotationSet"
168 },
169 "response": {
170 "$ref": "AnnotationSet"
171 },
172 "scopes": [
173 "https://www.googleapis.com/auth/cloud-platform",
174 "https://www.googleapis.com/auth/genomics"
175 ]
176 },
177 "search": {
178 "description": "Searches for annotation sets that match the given criteria. Annotation sets are returned in an unspecified order. This order is consistent, such that two queries for the same content (regardless of page s ize) yield annotation sets in the same order across their respective streams of paginated responses. Caller must have READ permission for the queried datasets." ,
179 "httpMethod": "POST",
180 "id": "genomics.annotationSets.search",
181 "path": "annotationSets/search",
182 "request": {
183 "$ref": "SearchAnnotationSetsRequest"
184 },
185 "response": {
186 "$ref": "SearchAnnotationSetsResponse"
187 },
188 "scopes": [
189 "https://www.googleapis.com/auth/cloud-platform",
190 "https://www.googleapis.com/auth/genomics",
191 "https://www.googleapis.com/auth/genomics.readonly"
192 ]
193 },
194 "update": {
195 "description": "Updates an annotation set. The update must r espect all mutability restrictions and other invariants described on the annotat ion set resource. Caller must have WRITE permission for the associated dataset." ,
196 "httpMethod": "PUT",
197 "id": "genomics.annotationSets.update",
198 "parameterOrder": [
199 "annotationSetId"
200 ],
201 "parameters": {
202 "annotationSetId": {
203 "description": "The ID of the annotation set to be u pdated.",
204 "location": "path",
205 "required": true,
206 "type": "string"
207 }
208 },
209 "path": "annotationSets/{annotationSetId}",
210 "request": {
211 "$ref": "AnnotationSet"
212 },
213 "response": {
214 "$ref": "AnnotationSet"
215 },
216 "scopes": [
217 "https://www.googleapis.com/auth/cloud-platform",
218 "https://www.googleapis.com/auth/genomics"
219 ]
220 }
221 }
222 },
223 "annotations": {
224 "methods": {
225 "batchCreate": {
226 "description": "Creates one or more new annotations atomical ly. All annotations must belong to the same annotation set. Caller must have WRI TE permission for this annotation set. For optimal performance, batch positional ly adjacent annotations together.\n\n\nIf the request has a systemic issue, such as an attempt to write to an inaccessible annotation set, the entire RPC will f ail accordingly. For lesser data issues, when possible an error will be isolated to the corresponding batch entry in the response; the remaining well formed ann otations will be created normally.\n\n\nFor details on the requirements for each individual annotation resource, see annotations.create.",
227 "httpMethod": "POST",
228 "id": "genomics.annotations.batchCreate",
229 "path": "annotations:batchCreate",
230 "request": {
231 "$ref": "BatchCreateAnnotationsRequest"
232 },
233 "response": {
234 "$ref": "BatchAnnotationsResponse"
235 },
236 "scopes": [
237 "https://www.googleapis.com/auth/cloud-platform",
238 "https://www.googleapis.com/auth/genomics"
239 ]
240 },
241 "create": {
242 "description": "Creates a new annotation. Caller must have W RITE permission for the associated annotation set.\n\n\nThe following fields mus t be provided when creating an annotation: \n- annotationSetId \n- position.ref erenceName or position.referenceId Transcripts \nFor annotations of type TRANS CRIPT, the following fields of annotation.transcript must be provided: \n- exon s.start \n- exons.end \nAll other fields may be optionally specified, unless do cumented as being server-generated (for example, the id field). The annotated ra nge must be no longer than 100Mbp (mega base pairs). See the annotation resource for additional restrictions on each field.",
243 "httpMethod": "POST",
244 "id": "genomics.annotations.create",
245 "path": "annotations",
246 "request": {
247 "$ref": "Annotation"
248 },
249 "response": {
250 "$ref": "Annotation"
251 },
252 "scopes": [
253 "https://www.googleapis.com/auth/cloud-platform",
254 "https://www.googleapis.com/auth/genomics"
255 ]
256 },
257 "delete": {
258 "description": "Deletes an annotation. Caller must have WRIT E permission for the associated annotation set.",
259 "httpMethod": "DELETE",
260 "id": "genomics.annotations.delete",
261 "parameterOrder": [
262 "annotationId"
263 ],
264 "parameters": {
265 "annotationId": {
266 "description": "The ID of the annotation to be delet ed.",
267 "location": "path",
268 "required": true,
269 "type": "string"
270 }
271 },
272 "path": "annotations/{annotationId}",
273 "scopes": [
274 "https://www.googleapis.com/auth/cloud-platform",
275 "https://www.googleapis.com/auth/genomics"
276 ]
277 },
278 "get": {
279 "description": "Gets an annotation. Caller must have READ pe rmission for the associated annotation set.",
280 "httpMethod": "GET",
281 "id": "genomics.annotations.get",
282 "parameterOrder": [
283 "annotationId"
284 ],
285 "parameters": {
286 "annotationId": {
287 "description": "The ID of the annotation to be retri eved.",
288 "location": "path",
289 "required": true,
290 "type": "string"
291 }
292 },
293 "path": "annotations/{annotationId}",
294 "response": {
295 "$ref": "Annotation"
296 },
297 "scopes": [
298 "https://www.googleapis.com/auth/cloud-platform",
299 "https://www.googleapis.com/auth/genomics",
300 "https://www.googleapis.com/auth/genomics.readonly"
301 ]
302 },
303 "patch": {
304 "description": "Updates an annotation. The update must respe ct all mutability restrictions and other invariants described on the annotation resource. Caller must have WRITE permission for the associated dataset. This met hod supports patch semantics.",
305 "httpMethod": "PATCH",
306 "id": "genomics.annotations.patch",
307 "parameterOrder": [
308 "annotationId"
309 ],
310 "parameters": {
311 "annotationId": {
312 "description": "The ID of the annotation to be updat ed.",
313 "location": "path",
314 "required": true,
315 "type": "string"
316 }
317 },
318 "path": "annotations/{annotationId}",
319 "request": {
320 "$ref": "Annotation"
321 },
322 "response": {
323 "$ref": "Annotation"
324 },
325 "scopes": [
326 "https://www.googleapis.com/auth/cloud-platform",
327 "https://www.googleapis.com/auth/genomics"
328 ]
329 },
330 "search": {
331 "description": "Searches for annotations that match the give n criteria. Results are ordered by genomic coordinate (by reference sequence, th en position). Annotations with equivalent genomic coordinates are returned in an unspecified order. This order is consistent, such that two queries for the same content (regardless of page size) yield annotations in the same order across th eir respective streams of paginated responses. Caller must have READ permission for the queried annotation sets.",
332 "httpMethod": "POST",
333 "id": "genomics.annotations.search",
334 "path": "annotations/search",
335 "request": {
336 "$ref": "SearchAnnotationsRequest"
337 },
338 "response": {
339 "$ref": "SearchAnnotationsResponse"
340 },
341 "scopes": [
342 "https://www.googleapis.com/auth/cloud-platform",
343 "https://www.googleapis.com/auth/genomics",
344 "https://www.googleapis.com/auth/genomics.readonly"
345 ]
346 },
347 "update": {
348 "description": "Updates an annotation. The update must respe ct all mutability restrictions and other invariants described on the annotation resource. Caller must have WRITE permission for the associated dataset.",
349 "httpMethod": "PUT",
350 "id": "genomics.annotations.update",
351 "parameterOrder": [
352 "annotationId"
353 ],
354 "parameters": {
355 "annotationId": {
356 "description": "The ID of the annotation to be updat ed.",
357 "location": "path",
358 "required": true,
359 "type": "string"
360 }
361 },
362 "path": "annotations/{annotationId}",
363 "request": {
364 "$ref": "Annotation"
365 },
366 "response": {
367 "$ref": "Annotation"
368 },
369 "scopes": [
370 "https://www.googleapis.com/auth/cloud-platform",
371 "https://www.googleapis.com/auth/genomics"
372 ]
373 }
374 }
375 },
376 "callsets": {
377 "methods": {
378 "create": {
379 "description": "Creates a new call set.",
380 "httpMethod": "POST",
381 "id": "genomics.callsets.create",
382 "path": "callsets",
383 "request": {
384 "$ref": "CallSet"
385 },
386 "response": {
387 "$ref": "CallSet"
388 },
389 "scopes": [
390 "https://www.googleapis.com/auth/cloud-platform",
391 "https://www.googleapis.com/auth/genomics"
392 ]
393 },
394 "delete": {
395 "description": "Deletes a call set.",
396 "httpMethod": "DELETE",
397 "id": "genomics.callsets.delete",
398 "parameterOrder": [
399 "callSetId"
400 ],
401 "parameters": {
402 "callSetId": {
403 "description": "The ID of the call set to be deleted .",
404 "location": "path",
405 "required": true,
406 "type": "string"
407 }
408 },
409 "path": "callsets/{callSetId}",
410 "scopes": [
411 "https://www.googleapis.com/auth/cloud-platform",
412 "https://www.googleapis.com/auth/genomics"
413 ]
414 },
415 "get": {
416 "description": "Gets a call set by ID.",
417 "httpMethod": "GET",
418 "id": "genomics.callsets.get",
419 "parameterOrder": [
420 "callSetId"
421 ],
422 "parameters": {
423 "callSetId": {
424 "description": "The ID of the call set.",
425 "location": "path",
426 "required": true,
427 "type": "string"
428 }
429 },
430 "path": "callsets/{callSetId}",
431 "response": {
432 "$ref": "CallSet"
433 },
434 "scopes": [
435 "https://www.googleapis.com/auth/cloud-platform",
436 "https://www.googleapis.com/auth/genomics",
437 "https://www.googleapis.com/auth/genomics.readonly"
438 ]
439 },
440 "patch": {
441 "description": "Updates a call set. This method supports pat ch semantics.",
442 "httpMethod": "PATCH",
443 "id": "genomics.callsets.patch",
444 "parameterOrder": [
445 "callSetId"
446 ],
447 "parameters": {
448 "callSetId": {
449 "description": "Required. The ID of the call set to be updated.",
450 "location": "path",
451 "required": true,
452 "type": "string"
453 }
454 },
455 "path": "callsets/{callSetId}",
456 "request": {
457 "$ref": "CallSet"
458 },
459 "response": {
460 "$ref": "CallSet"
461 },
462 "scopes": [
463 "https://www.googleapis.com/auth/cloud-platform",
464 "https://www.googleapis.com/auth/genomics"
465 ]
466 },
467 "search": {
468 "description": "Gets a list of call sets matching the criter ia.\n\nImplements GlobalAllianceApi.searchCallSets.",
469 "httpMethod": "POST",
470 "id": "genomics.callsets.search",
471 "path": "callsets/search",
472 "request": {
473 "$ref": "SearchCallSetsRequest"
474 },
475 "response": {
476 "$ref": "SearchCallSetsResponse"
477 },
478 "scopes": [
479 "https://www.googleapis.com/auth/cloud-platform",
480 "https://www.googleapis.com/auth/genomics",
481 "https://www.googleapis.com/auth/genomics.readonly"
482 ]
483 },
484 "update": {
485 "description": "Updates a call set.",
486 "httpMethod": "PUT",
487 "id": "genomics.callsets.update",
488 "parameterOrder": [
489 "callSetId"
490 ],
491 "parameters": {
492 "callSetId": {
493 "description": "Required. The ID of the call set to be updated.",
494 "location": "path",
495 "required": true,
496 "type": "string"
497 }
498 },
499 "path": "callsets/{callSetId}",
500 "request": {
501 "$ref": "CallSet"
502 },
503 "response": {
504 "$ref": "CallSet"
505 },
506 "scopes": [
507 "https://www.googleapis.com/auth/cloud-platform",
508 "https://www.googleapis.com/auth/genomics"
509 ]
510 }
511 }
512 },
513 "datasets": {
514 "methods": {
515 "create": {
516 "description": "Creates a new dataset.",
517 "httpMethod": "POST",
518 "id": "genomics.datasets.create",
519 "path": "datasets",
520 "request": {
521 "$ref": "Dataset"
522 },
523 "response": {
524 "$ref": "Dataset"
525 },
526 "scopes": [
527 "https://www.googleapis.com/auth/cloud-platform",
528 "https://www.googleapis.com/auth/genomics"
529 ]
530 },
531 "delete": {
532 "description": "Deletes a dataset and all of its contents (a ll read group sets, reference sets, variant sets, call sets, annotation sets, et c.) This is reversible (up to one week after the deletion) via the UndeleteDatas et operation.",
533 "httpMethod": "DELETE",
534 "id": "genomics.datasets.delete",
535 "parameterOrder": [
536 "datasetId"
537 ],
538 "parameters": {
539 "datasetId": {
540 "description": "The ID of the dataset to be deleted. ",
541 "location": "path",
542 "required": true,
543 "type": "string"
544 }
545 },
546 "path": "datasets/{datasetId}",
547 "scopes": [
548 "https://www.googleapis.com/auth/cloud-platform",
549 "https://www.googleapis.com/auth/genomics"
550 ]
551 },
552 "get": {
553 "description": "Gets a dataset by ID.",
554 "httpMethod": "GET",
555 "id": "genomics.datasets.get",
556 "parameterOrder": [
557 "datasetId"
558 ],
559 "parameters": {
560 "datasetId": {
561 "description": "The ID of the dataset.",
562 "location": "path",
563 "required": true,
564 "type": "string"
565 }
566 },
567 "path": "datasets/{datasetId}",
568 "response": {
569 "$ref": "Dataset"
570 },
571 "scopes": [
572 "https://www.googleapis.com/auth/cloud-platform",
573 "https://www.googleapis.com/auth/genomics",
574 "https://www.googleapis.com/auth/genomics.readonly"
575 ]
576 },
577 "list": {
578 "description": "Lists datasets within a project.",
579 "httpMethod": "GET",
580 "id": "genomics.datasets.list",
581 "parameters": {
582 "pageSize": {
583 "description": "The maximum number of results to ret urn in a single page. If unspecified, defaults to 50. The maximum value is 1024. ",
584 "format": "int32",
585 "location": "query",
586 "type": "integer"
587 },
588 "pageToken": {
589 "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.",
590 "location": "query",
591 "type": "string"
592 },
593 "projectNumber": {
594 "description": "Required. The project to list datase ts for.",
595 "format": "int64",
596 "location": "query",
597 "type": "string"
598 }
599 },
600 "path": "datasets",
601 "response": {
602 "$ref": "ListDatasetsResponse"
603 },
604 "scopes": [
605 "https://www.googleapis.com/auth/cloud-platform",
606 "https://www.googleapis.com/auth/genomics",
607 "https://www.googleapis.com/auth/genomics.readonly"
608 ]
609 },
610 "patch": {
611 "description": "Updates a dataset. This method supports patc h semantics.",
612 "httpMethod": "PATCH",
613 "id": "genomics.datasets.patch",
614 "parameterOrder": [
615 "datasetId"
616 ],
617 "parameters": {
618 "datasetId": {
619 "description": "The ID of the dataset to be updated. ",
620 "location": "path",
621 "required": true,
622 "type": "string"
623 }
624 },
625 "path": "datasets/{datasetId}",
626 "request": {
627 "$ref": "Dataset"
628 },
629 "response": {
630 "$ref": "Dataset"
631 },
632 "scopes": [
633 "https://www.googleapis.com/auth/cloud-platform",
634 "https://www.googleapis.com/auth/genomics"
635 ]
636 },
637 "undelete": {
638 "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.",
639 "httpMethod": "POST",
640 "id": "genomics.datasets.undelete",
641 "parameterOrder": [
642 "datasetId"
643 ],
644 "parameters": {
645 "datasetId": {
646 "description": "The ID of the dataset to be undelete d.",
647 "location": "path",
648 "required": true,
649 "type": "string"
650 }
651 },
652 "path": "datasets/{datasetId}/undelete",
653 "response": {
654 "$ref": "Dataset"
655 },
656 "scopes": [
657 "https://www.googleapis.com/auth/cloud-platform",
658 "https://www.googleapis.com/auth/genomics"
659 ]
660 },
661 "update": {
662 "description": "Updates a dataset.",
663 "httpMethod": "PUT",
664 "id": "genomics.datasets.update",
665 "parameterOrder": [
666 "datasetId"
667 ],
668 "parameters": {
669 "datasetId": {
670 "description": "The ID of the dataset to be updated. ",
671 "location": "path",
672 "required": true,
673 "type": "string"
674 }
675 },
676 "path": "datasets/{datasetId}",
677 "request": {
678 "$ref": "Dataset"
679 },
680 "response": {
681 "$ref": "Dataset"
682 },
683 "scopes": [
684 "https://www.googleapis.com/auth/cloud-platform",
685 "https://www.googleapis.com/auth/genomics"
686 ]
687 }
688 }
689 },
690 "experimental": {
691 "resources": {
692 "jobs": {
693 "methods": {
694 "create": {
695 "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.",
696 "httpMethod": "POST",
697 "id": "genomics.experimental.jobs.create",
698 "path": "experimental/jobs/create",
699 "request": {
700 "$ref": "ExperimentalCreateJobRequest"
701 },
702 "response": {
703 "$ref": "ExperimentalCreateJobResponse"
704 },
705 "scopes": [
706 "https://www.googleapis.com/auth/cloud-platform" ,
707 "https://www.googleapis.com/auth/devstorage.read _write",
708 "https://www.googleapis.com/auth/genomics"
709 ]
710 }
711 }
712 }
713 }
714 },
715 "jobs": {
716 "methods": {
717 "cancel": {
718 "description": "Cancels a job by ID. Note that it is possibl e for partial results to be generated and stored for cancelled jobs.",
719 "httpMethod": "POST",
720 "id": "genomics.jobs.cancel",
721 "parameterOrder": [
722 "jobId"
723 ],
724 "parameters": {
725 "jobId": {
726 "description": "Required. The ID of the job.",
727 "location": "path",
728 "required": true,
729 "type": "string"
730 }
731 },
732 "path": "jobs/{jobId}/cancel",
733 "scopes": [
734 "https://www.googleapis.com/auth/cloud-platform",
735 "https://www.googleapis.com/auth/genomics"
736 ]
737 },
738 "get": {
739 "description": "Gets a job by ID.",
740 "httpMethod": "GET",
741 "id": "genomics.jobs.get",
742 "parameterOrder": [
743 "jobId"
744 ],
745 "parameters": {
746 "jobId": {
747 "description": "Required. The ID of the job.",
748 "location": "path",
749 "required": true,
750 "type": "string"
751 }
752 },
753 "path": "jobs/{jobId}",
754 "response": {
755 "$ref": "Job"
756 },
757 "scopes": [
758 "https://www.googleapis.com/auth/cloud-platform",
759 "https://www.googleapis.com/auth/genomics",
760 "https://www.googleapis.com/auth/genomics.readonly"
761 ]
762 },
763 "search": {
764 "description": "Gets a list of jobs matching the criteria.",
765 "httpMethod": "POST",
766 "id": "genomics.jobs.search",
767 "path": "jobs/search",
768 "request": {
769 "$ref": "SearchJobsRequest"
770 },
771 "response": {
772 "$ref": "SearchJobsResponse"
773 },
774 "scopes": [
775 "https://www.googleapis.com/auth/cloud-platform",
776 "https://www.googleapis.com/auth/genomics",
777 "https://www.googleapis.com/auth/genomics.readonly"
778 ]
779 }
780 }
781 },
782 "readgroupsets": {
783 "methods": {
784 "delete": {
785 "description": "Deletes a read group set.",
786 "httpMethod": "DELETE",
787 "id": "genomics.readgroupsets.delete",
788 "parameterOrder": [
789 "readGroupSetId"
790 ],
791 "parameters": {
792 "readGroupSetId": {
793 "description": "The ID of the read group set to be d eleted. The caller must have WRITE permissions to the dataset associated with th is read group set.",
794 "location": "path",
795 "required": true,
796 "type": "string"
797 }
798 },
799 "path": "readgroupsets/{readGroupSetId}",
800 "scopes": [
801 "https://www.googleapis.com/auth/cloud-platform",
802 "https://www.googleapis.com/auth/genomics"
803 ]
804 },
805 "export": {
806 "description": "Exports read group sets to a BAM file in Goo gle Cloud Storage.\n\nNote that currently there may be some differences between exported BAM files and the original BAM file at the time of import. See ImportRe adGroupSets for details.",
807 "httpMethod": "POST",
808 "id": "genomics.readgroupsets.export",
809 "path": "readgroupsets/export",
810 "request": {
811 "$ref": "ExportReadGroupSetsRequest"
812 },
813 "response": {
814 "$ref": "ExportReadGroupSetsResponse"
815 },
816 "scopes": [
817 "https://www.googleapis.com/auth/cloud-platform",
818 "https://www.googleapis.com/auth/devstorage.read_write",
819 "https://www.googleapis.com/auth/genomics"
820 ]
821 },
822 "get": {
823 "description": "Gets a read group set by ID.",
824 "httpMethod": "GET",
825 "id": "genomics.readgroupsets.get",
826 "parameterOrder": [
827 "readGroupSetId"
828 ],
829 "parameters": {
830 "readGroupSetId": {
831 "description": "The ID of the read group set.",
832 "location": "path",
833 "required": true,
834 "type": "string"
835 }
836 },
837 "path": "readgroupsets/{readGroupSetId}",
838 "response": {
839 "$ref": "ReadGroupSet"
840 },
841 "scopes": [
842 "https://www.googleapis.com/auth/cloud-platform",
843 "https://www.googleapis.com/auth/genomics",
844 "https://www.googleapis.com/auth/genomics.readonly"
845 ]
846 },
847 "import": {
848 "description": "Creates read group sets by asynchronously im porting the provided information. The caller must have WRITE permissions to the dataset.\n\nNotes on BAM import: \n- Tags will be converted to strings - tag ty pes are not preserved\n- Comments (@CO) in the input file header are not importe d\n- Original order of reference headers is not preserved\n- Any reverse strande d unmapped reads will be reverse complemented, and their qualities (also the \"B Q\" and \"OQ\" tags, if any) will be reversed\n- Unmapped reads will be stripped of positional information (referenceName and position)",
849 "httpMethod": "POST",
850 "id": "genomics.readgroupsets.import",
851 "path": "readgroupsets/import",
852 "request": {
853 "$ref": "ImportReadGroupSetsRequest"
854 },
855 "response": {
856 "$ref": "ImportReadGroupSetsResponse"
857 },
858 "scopes": [
859 "https://www.googleapis.com/auth/cloud-platform",
860 "https://www.googleapis.com/auth/devstorage.read_write",
861 "https://www.googleapis.com/auth/genomics"
862 ]
863 },
864 "patch": {
865 "description": "Updates a read group set. This method suppor ts patch semantics.",
866 "httpMethod": "PATCH",
867 "id": "genomics.readgroupsets.patch",
868 "parameterOrder": [
869 "readGroupSetId"
870 ],
871 "parameters": {
872 "readGroupSetId": {
873 "description": "The ID of the read group set to be u pdated. The caller must have WRITE permissions to the dataset associated with th is read group set.",
874 "location": "path",
875 "required": true,
876 "type": "string"
877 }
878 },
879 "path": "readgroupsets/{readGroupSetId}",
880 "request": {
881 "$ref": "ReadGroupSet"
882 },
883 "response": {
884 "$ref": "ReadGroupSet"
885 },
886 "scopes": [
887 "https://www.googleapis.com/auth/cloud-platform",
888 "https://www.googleapis.com/auth/genomics"
889 ]
890 },
891 "search": {
892 "description": "Searches for read group sets matching the cr iteria.\n\nImplements GlobalAllianceApi.searchReadGroupSets.",
893 "httpMethod": "POST",
894 "id": "genomics.readgroupsets.search",
895 "path": "readgroupsets/search",
896 "request": {
897 "$ref": "SearchReadGroupSetsRequest"
898 },
899 "response": {
900 "$ref": "SearchReadGroupSetsResponse"
901 },
902 "scopes": [
903 "https://www.googleapis.com/auth/cloud-platform",
904 "https://www.googleapis.com/auth/genomics",
905 "https://www.googleapis.com/auth/genomics.readonly"
906 ]
907 },
908 "update": {
909 "description": "Updates a read group set.",
910 "httpMethod": "PUT",
911 "id": "genomics.readgroupsets.update",
912 "parameterOrder": [
913 "readGroupSetId"
914 ],
915 "parameters": {
916 "readGroupSetId": {
917 "description": "The ID of the read group set to be u pdated. The caller must have WRITE permissions to the dataset associated with th is read group set.",
918 "location": "path",
919 "required": true,
920 "type": "string"
921 }
922 },
923 "path": "readgroupsets/{readGroupSetId}",
924 "request": {
925 "$ref": "ReadGroupSet"
926 },
927 "response": {
928 "$ref": "ReadGroupSet"
929 },
930 "scopes": [
931 "https://www.googleapis.com/auth/cloud-platform",
932 "https://www.googleapis.com/auth/genomics"
933 ]
934 }
935 },
936 "resources": {
937 "coveragebuckets": {
938 "methods": {
939 "list": {
940 "description": "Lists fixed width coverage buckets f or a read group set, each of which correspond to a range of a reference sequence . Each bucket summarizes coverage information across its corresponding genomic r ange.\n\nCoverage is defined as the number of reads which are aligned to a given base in the reference sequence. Coverage buckets are available at several preco mputed bucket widths, enabling retrieval of various coverage 'zoom levels'. The caller must have READ permissions for the target read group set.",
941 "httpMethod": "GET",
942 "id": "genomics.readgroupsets.coveragebuckets.list",
943 "parameterOrder": [
944 "readGroupSetId"
945 ],
946 "parameters": {
947 "pageSize": {
948 "description": "The maximum number of result s to return in a single page. If unspecified, defaults to 1024. The maximum valu e is 2048.",
949 "format": "int32",
950 "location": "query",
951 "type": "integer"
952 },
953 "pageToken": {
954 "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.",
955 "location": "query",
956 "type": "string"
957 },
958 "range.end": {
959 "description": "The end position of the rang e on the reference, 0-based exclusive. If specified, referenceName must also be specified.",
960 "format": "int64",
961 "location": "query",
962 "type": "string"
963 },
964 "range.referenceName": {
965 "description": "The reference sequence name, for example chr1, 1, or chrX.",
966 "location": "query",
967 "type": "string"
968 },
969 "range.start": {
970 "description": "The start position of the ra nge on the reference, 0-based inclusive. If specified, referenceName must also b e specified.",
971 "format": "int64",
972 "location": "query",
973 "type": "string"
974 },
975 "readGroupSetId": {
976 "description": "Required. The ID of the read group set over which coverage is requested.",
977 "location": "path",
978 "required": true,
979 "type": "string"
980 },
981 "targetBucketWidth": {
982 "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 bucketWidth in the re sponse. Defaults to infinity (each bucket spans an entire reference sequence) or the length of the target range, if specified. The smallest precomputed bucketWi dth is currently 2048 base pairs; this is subject to change.",
983 "format": "int64",
984 "location": "query",
985 "type": "string"
986 }
987 },
988 "path": "readgroupsets/{readGroupSetId}/coveragebuck ets",
989 "response": {
990 "$ref": "ListCoverageBucketsResponse"
991 },
992 "scopes": [
993 "https://www.googleapis.com/auth/cloud-platform" ,
994 "https://www.googleapis.com/auth/genomics",
995 "https://www.googleapis.com/auth/genomics.readon ly"
996 ]
997 }
998 }
999 }
1000 }
1001 },
1002 "reads": {
1003 "methods": {
1004 "search": {
1005 "description": "Gets a list of reads for one or more read gr oup sets. Reads search operates over a genomic coordinate space of reference seq uence & position defined over the reference sequences to which the requested rea d group sets are aligned.\n\nIf a target positional range is specified, search r eturns all reads whose alignment to the reference genome overlap the range. A qu ery which specifies only read group set IDs yields all reads in those read group sets, including unmapped reads.\n\nAll reads returned (including reads on subse quent pages) are ordered by genomic coordinate (by reference sequence, then posi tion). Reads with equivalent genomic coordinates are returned in an unspecified order. This order is consistent, such that two queries for the same content (reg ardless of page size) yield reads in the same order across their respective stre ams of paginated responses.\n\nImplements GlobalAllianceApi.searchReads.",
1006 "httpMethod": "POST",
1007 "id": "genomics.reads.search",
1008 "path": "reads/search",
1009 "request": {
1010 "$ref": "SearchReadsRequest"
1011 },
1012 "response": {
1013 "$ref": "SearchReadsResponse"
1014 },
1015 "scopes": [
1016 "https://www.googleapis.com/auth/cloud-platform",
1017 "https://www.googleapis.com/auth/genomics",
1018 "https://www.googleapis.com/auth/genomics.readonly"
1019 ]
1020 }
1021 }
1022 },
1023 "references": {
1024 "methods": {
1025 "get": {
1026 "description": "Gets a reference.\n\nImplements GlobalAllian ceApi.getReference.",
1027 "httpMethod": "GET",
1028 "id": "genomics.references.get",
1029 "parameterOrder": [
1030 "referenceId"
1031 ],
1032 "parameters": {
1033 "referenceId": {
1034 "description": "The ID of the reference.",
1035 "location": "path",
1036 "required": true,
1037 "type": "string"
1038 }
1039 },
1040 "path": "references/{referenceId}",
1041 "response": {
1042 "$ref": "Reference"
1043 },
1044 "scopes": [
1045 "https://www.googleapis.com/auth/cloud-platform",
1046 "https://www.googleapis.com/auth/genomics",
1047 "https://www.googleapis.com/auth/genomics.readonly"
1048 ]
1049 },
1050 "search": {
1051 "description": "Searches for references which match the give n criteria.\n\nImplements GlobalAllianceApi.searchReferences.",
1052 "httpMethod": "POST",
1053 "id": "genomics.references.search",
1054 "path": "references/search",
1055 "request": {
1056 "$ref": "SearchReferencesRequest"
1057 },
1058 "response": {
1059 "$ref": "SearchReferencesResponse"
1060 },
1061 "scopes": [
1062 "https://www.googleapis.com/auth/cloud-platform",
1063 "https://www.googleapis.com/auth/genomics",
1064 "https://www.googleapis.com/auth/genomics.readonly"
1065 ]
1066 }
1067 },
1068 "resources": {
1069 "bases": {
1070 "methods": {
1071 "list": {
1072 "description": "Lists the bases in a reference, opti onally restricted to a range.\n\nImplements GlobalAllianceApi.getReferenceBases. ",
1073 "httpMethod": "GET",
1074 "id": "genomics.references.bases.list",
1075 "parameterOrder": [
1076 "referenceId"
1077 ],
1078 "parameters": {
1079 "end": {
1080 "description": "The end position (0-based, e xclusive) of this query. Defaults to the length of this reference.",
1081 "format": "int64",
1082 "location": "query",
1083 "type": "string"
1084 },
1085 "pageSize": {
1086 "description": "The maximum number of bases to return in a single page. If unspecified, defaults to 200Kbp (kilo base pairs) . The maximum value is 10Mbp (mega base pairs).",
1087 "format": "int32",
1088 "location": "query",
1089 "type": "integer"
1090 },
1091 "pageToken": {
1092 "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.",
1093 "location": "query",
1094 "type": "string"
1095 },
1096 "referenceId": {
1097 "description": "The ID of the reference.",
1098 "location": "path",
1099 "required": true,
1100 "type": "string"
1101 },
1102 "start": {
1103 "description": "The start position (0-based) of this query. Defaults to 0.",
1104 "format": "int64",
1105 "location": "query",
1106 "type": "string"
1107 }
1108 },
1109 "path": "references/{referenceId}/bases",
1110 "response": {
1111 "$ref": "ListBasesResponse"
1112 },
1113 "scopes": [
1114 "https://www.googleapis.com/auth/cloud-platform" ,
1115 "https://www.googleapis.com/auth/genomics",
1116 "https://www.googleapis.com/auth/genomics.readon ly"
1117 ]
1118 }
1119 }
1120 }
1121 }
1122 },
1123 "referencesets": {
1124 "methods": {
1125 "get": {
1126 "description": "Gets a reference set.\n\nImplements GlobalAl lianceApi.getReferenceSet.",
1127 "httpMethod": "GET",
1128 "id": "genomics.referencesets.get",
1129 "parameterOrder": [
1130 "referenceSetId"
1131 ],
1132 "parameters": {
1133 "referenceSetId": {
1134 "description": "The ID of the reference set.",
1135 "location": "path",
1136 "required": true,
1137 "type": "string"
1138 }
1139 },
1140 "path": "referencesets/{referenceSetId}",
1141 "response": {
1142 "$ref": "ReferenceSet"
1143 },
1144 "scopes": [
1145 "https://www.googleapis.com/auth/cloud-platform",
1146 "https://www.googleapis.com/auth/genomics",
1147 "https://www.googleapis.com/auth/genomics.readonly"
1148 ]
1149 },
1150 "search": {
1151 "description": "Searches for reference sets which match the given criteria.\n\nImplements GlobalAllianceApi.searchReferenceSets.",
1152 "httpMethod": "POST",
1153 "id": "genomics.referencesets.search",
1154 "path": "referencesets/search",
1155 "request": {
1156 "$ref": "SearchReferenceSetsRequest"
1157 },
1158 "response": {
1159 "$ref": "SearchReferenceSetsResponse"
1160 },
1161 "scopes": [
1162 "https://www.googleapis.com/auth/cloud-platform",
1163 "https://www.googleapis.com/auth/genomics",
1164 "https://www.googleapis.com/auth/genomics.readonly"
1165 ]
1166 }
1167 }
1168 },
1169 "variants": {
1170 "methods": {
1171 "create": {
1172 "description": "Creates a new variant.",
1173 "httpMethod": "POST",
1174 "id": "genomics.variants.create",
1175 "path": "variants",
1176 "request": {
1177 "$ref": "Variant"
1178 },
1179 "response": {
1180 "$ref": "Variant"
1181 },
1182 "scopes": [
1183 "https://www.googleapis.com/auth/cloud-platform",
1184 "https://www.googleapis.com/auth/genomics"
1185 ]
1186 },
1187 "delete": {
1188 "description": "Deletes a variant.",
1189 "httpMethod": "DELETE",
1190 "id": "genomics.variants.delete",
1191 "parameterOrder": [
1192 "variantId"
1193 ],
1194 "parameters": {
1195 "variantId": {
1196 "description": "The ID of the variant to be deleted. ",
1197 "location": "path",
1198 "required": true,
1199 "type": "string"
1200 }
1201 },
1202 "path": "variants/{variantId}",
1203 "scopes": [
1204 "https://www.googleapis.com/auth/cloud-platform",
1205 "https://www.googleapis.com/auth/genomics"
1206 ]
1207 },
1208 "get": {
1209 "description": "Gets a variant by ID.",
1210 "httpMethod": "GET",
1211 "id": "genomics.variants.get",
1212 "parameterOrder": [
1213 "variantId"
1214 ],
1215 "parameters": {
1216 "variantId": {
1217 "description": "Required.",
1218 "location": "path",
1219 "required": true,
1220 "type": "string"
1221 }
1222 },
1223 "path": "variants/{variantId}",
1224 "response": {
1225 "$ref": "Variant"
1226 },
1227 "scopes": [
1228 "https://www.googleapis.com/auth/cloud-platform",
1229 "https://www.googleapis.com/auth/genomics",
1230 "https://www.googleapis.com/auth/genomics.readonly"
1231 ]
1232 },
1233 "search": {
1234 "description": "Gets a list of variants matching the criteri a.\n\nImplements GlobalAllianceApi.searchVariants.",
1235 "httpMethod": "POST",
1236 "id": "genomics.variants.search",
1237 "path": "variants/search",
1238 "request": {
1239 "$ref": "SearchVariantsRequest"
1240 },
1241 "response": {
1242 "$ref": "SearchVariantsResponse"
1243 },
1244 "scopes": [
1245 "https://www.googleapis.com/auth/cloud-platform",
1246 "https://www.googleapis.com/auth/genomics",
1247 "https://www.googleapis.com/auth/genomics.readonly"
1248 ]
1249 },
1250 "update": {
1251 "description": "Updates a variant's names and info fields. A ll other modifications are silently ignored. Returns the modified variant withou t its calls.",
1252 "httpMethod": "PUT",
1253 "id": "genomics.variants.update",
1254 "parameterOrder": [
1255 "variantId"
1256 ],
1257 "parameters": {
1258 "variantId": {
1259 "description": "The ID of the variant to be updated. ",
1260 "location": "path",
1261 "required": true,
1262 "type": "string"
1263 }
1264 },
1265 "path": "variants/{variantId}",
1266 "request": {
1267 "$ref": "Variant"
1268 },
1269 "response": {
1270 "$ref": "Variant"
1271 },
1272 "scopes": [
1273 "https://www.googleapis.com/auth/cloud-platform",
1274 "https://www.googleapis.com/auth/genomics"
1275 ]
1276 }
1277 }
1278 },
1279 "variantsets": {
1280 "methods": {
1281 "create": {
1282 "description": "Creates a new variant set (only necessary in v1).\n\nThe provided variant set must have a valid datasetId set - all other fi elds are optional. Note that the id field will be ignored, as this is assigned b y the server.",
1283 "httpMethod": "POST",
1284 "id": "genomics.variantsets.create",
1285 "path": "variantsets",
1286 "request": {
1287 "$ref": "VariantSet"
1288 },
1289 "response": {
1290 "$ref": "VariantSet"
1291 },
1292 "scopes": [
1293 "https://www.googleapis.com/auth/cloud-platform",
1294 "https://www.googleapis.com/auth/genomics"
1295 ]
1296 },
1297 "delete": {
1298 "description": "Deletes a variant set including all variants , call sets, and calls within. This is not reversible.",
1299 "httpMethod": "DELETE",
1300 "id": "genomics.variantsets.delete",
1301 "parameterOrder": [
1302 "variantSetId"
1303 ],
1304 "parameters": {
1305 "variantSetId": {
1306 "description": "The ID of the variant set to be dele ted. Required.",
1307 "location": "path",
1308 "required": true,
1309 "type": "string"
1310 }
1311 },
1312 "path": "variantsets/{variantSetId}",
1313 "scopes": [
1314 "https://www.googleapis.com/auth/cloud-platform",
1315 "https://www.googleapis.com/auth/genomics"
1316 ]
1317 },
1318 "export": {
1319 "description": "Exports variant set data to an external dest ination.",
1320 "httpMethod": "POST",
1321 "id": "genomics.variantsets.export",
1322 "parameterOrder": [
1323 "variantSetId"
1324 ],
1325 "parameters": {
1326 "variantSetId": {
1327 "description": "The ID of the variant set that conta ins variant data which should be exported. Required. The caller must have READ a ccess to this variant set.",
1328 "location": "path",
1329 "required": true,
1330 "type": "string"
1331 }
1332 },
1333 "path": "variantsets/{variantSetId}/export",
1334 "request": {
1335 "$ref": "ExportVariantSetRequest"
1336 },
1337 "response": {
1338 "$ref": "ExportVariantSetResponse"
1339 },
1340 "scopes": [
1341 "https://www.googleapis.com/auth/bigquery",
1342 "https://www.googleapis.com/auth/cloud-platform",
1343 "https://www.googleapis.com/auth/genomics"
1344 ]
1345 },
1346 "get": {
1347 "description": "Gets a variant set by ID.",
1348 "httpMethod": "GET",
1349 "id": "genomics.variantsets.get",
1350 "parameterOrder": [
1351 "variantSetId"
1352 ],
1353 "parameters": {
1354 "variantSetId": {
1355 "description": "The ID of the variant set. Required. ",
1356 "location": "path",
1357 "required": true,
1358 "type": "string"
1359 }
1360 },
1361 "path": "variantsets/{variantSetId}",
1362 "response": {
1363 "$ref": "VariantSet"
1364 },
1365 "scopes": [
1366 "https://www.googleapis.com/auth/cloud-platform",
1367 "https://www.googleapis.com/auth/genomics",
1368 "https://www.googleapis.com/auth/genomics.readonly"
1369 ]
1370 },
1371 "importVariants": {
1372 "description": "Creates variant data by asynchronously impor ting the provided information.\n\nThe variants for import will be merged with an y existing data and each other according to the behavior of mergeVariants. In pa rticular, this means for merged VCF variants that have conflicting info fields, some data will be arbitrarily discarded unless otherwise specified in the InfoMe rgeConfig field of ImportVariantsRequest. As a special case, for single-sample V CF files, QUAL and FILTER fields will be moved to the call level; these are some times interpreted in a call-specific context. Imported VCF headers are appended to the metadata already in a variant set.",
1373 "httpMethod": "POST",
1374 "id": "genomics.variantsets.importVariants",
1375 "parameterOrder": [
1376 "variantSetId"
1377 ],
1378 "parameters": {
1379 "variantSetId": {
1380 "description": "Required. The variant set to which v ariant data should be imported.",
1381 "location": "path",
1382 "required": true,
1383 "type": "string"
1384 }
1385 },
1386 "path": "variantsets/{variantSetId}/importVariants",
1387 "request": {
1388 "$ref": "ImportVariantsRequest"
1389 },
1390 "response": {
1391 "$ref": "ImportVariantsResponse"
1392 },
1393 "scopes": [
1394 "https://www.googleapis.com/auth/cloud-platform",
1395 "https://www.googleapis.com/auth/devstorage.read_write",
1396 "https://www.googleapis.com/auth/genomics"
1397 ]
1398 },
1399 "mergeVariants": {
1400 "description": "Merges the given variants with existing vari ants. Each variant will be merged with an existing variant that matches its refe rence sequence, start, end, reference bases, and alternative bases. If no such v ariant exists, a new one will be created.\n\nWhen variants are merged, the call information from the new variant is added to the existing variant. Variant info fields are merged as specified in the InfoMergeConfig field of the MergeVariants Request.",
1401 "httpMethod": "POST",
1402 "id": "genomics.variantsets.mergeVariants",
1403 "parameterOrder": [
1404 "variantSetId"
1405 ],
1406 "parameters": {
1407 "variantSetId": {
1408 "description": "The destination variant set.",
1409 "location": "path",
1410 "required": true,
1411 "type": "string"
1412 }
1413 },
1414 "path": "variantsets/{variantSetId}/mergeVariants",
1415 "request": {
1416 "$ref": "MergeVariantsRequest"
1417 },
1418 "scopes": [
1419 "https://www.googleapis.com/auth/cloud-platform",
1420 "https://www.googleapis.com/auth/genomics"
1421 ]
1422 },
1423 "patch": {
1424 "description": "Updates a variant set's metadata. All other modifications are silently ignored. This method supports patch semantics.",
1425 "httpMethod": "PATCH",
1426 "id": "genomics.variantsets.patch",
1427 "parameterOrder": [
1428 "variantSetId"
1429 ],
1430 "parameters": {
1431 "variantSetId": {
1432 "description": "The ID of the variant set to be upda ted (must already exist).",
1433 "location": "path",
1434 "required": true,
1435 "type": "string"
1436 }
1437 },
1438 "path": "variantsets/{variantSetId}",
1439 "request": {
1440 "$ref": "VariantSet"
1441 },
1442 "response": {
1443 "$ref": "VariantSet"
1444 },
1445 "scopes": [
1446 "https://www.googleapis.com/auth/cloud-platform",
1447 "https://www.googleapis.com/auth/genomics"
1448 ]
1449 },
1450 "search": {
1451 "description": "Returns a list of all variant sets matching search criteria.\n\nImplements GlobalAllianceApi.searchVariantSets.",
1452 "httpMethod": "POST",
1453 "id": "genomics.variantsets.search",
1454 "path": "variantsets/search",
1455 "request": {
1456 "$ref": "SearchVariantSetsRequest"
1457 },
1458 "response": {
1459 "$ref": "SearchVariantSetsResponse"
1460 },
1461 "scopes": [
1462 "https://www.googleapis.com/auth/cloud-platform",
1463 "https://www.googleapis.com/auth/genomics",
1464 "https://www.googleapis.com/auth/genomics.readonly"
1465 ]
1466 },
1467 "update": {
1468 "description": "Updates a variant set's metadata. All other modifications are silently ignored.",
1469 "httpMethod": "PUT",
1470 "id": "genomics.variantsets.update",
1471 "parameterOrder": [
1472 "variantSetId"
1473 ],
1474 "parameters": {
1475 "variantSetId": {
1476 "description": "The ID of the variant set to be upda ted (must already exist).",
1477 "location": "path",
1478 "required": true,
1479 "type": "string"
1480 }
1481 },
1482 "path": "variantsets/{variantSetId}",
1483 "request": {
1484 "$ref": "VariantSet"
1485 },
1486 "response": {
1487 "$ref": "VariantSet"
1488 },
1489 "scopes": [
1490 "https://www.googleapis.com/auth/cloud-platform",
1491 "https://www.googleapis.com/auth/genomics"
1492 ]
1493 }
1494 }
1495 }
1496 },
1497 "revision": "20161026",
1498 "rootUrl": "https://www.googleapis.com/",
1499 "schemas": {
1500 "Annotation": {
1501 "description": "An annotation describes a region of reference genome . The value of an annotation may be one of several canonical types, supplemented by arbitrary info tags. An annotation is not inherently associated with a speci fic sample or individual (though a client could choose to use annotations in thi s way). Example canonical annotation types are GENE and VARIANT.",
1502 "id": "Annotation",
1503 "properties": {
1504 "annotationSetId": {
1505 "description": "The annotation set to which this annotation belongs.",
1506 "type": "string"
1507 },
1508 "id": {
1509 "description": "The server-generated annotation ID, unique a cross all annotations.",
1510 "type": "string"
1511 },
1512 "info": {
1513 "additionalProperties": {
1514 "description": "A string which maps to an array of value s.",
1515 "items": {
1516 "type": "string"
1517 },
1518 "type": "array"
1519 },
1520 "description": "A string which maps to an array of values.",
1521 "type": "object"
1522 },
1523 "name": {
1524 "description": "The display name of this annotation.",
1525 "type": "string"
1526 },
1527 "position": {
1528 "$ref": "RangePosition",
1529 "description": "The position of this annotation on the refer ence sequence."
1530 },
1531 "transcript": {
1532 "$ref": "Transcript",
1533 "description": "A transcript value represents the assertion that a particular region of the reference genome may be transcribed as RNA. An a lternative splicing pattern would be represented as a separate transcript object . This field is only set for annotations of type TRANSCRIPT."
1534 },
1535 "type": {
1536 "description": "The data type for this annotation. Must matc h the containing annotation set's type.",
1537 "enum": [
1538 "GENE",
1539 "GENERIC",
1540 "TRANSCRIPT",
1541 "VARIANT"
1542 ],
1543 "enumDescriptions": [
1544 "",
1545 "",
1546 "",
1547 ""
1548 ],
1549 "type": "string"
1550 },
1551 "variant": {
1552 "$ref": "VariantAnnotation",
1553 "description": "A variant annotation, which describes the ef fect of a variant on the genome, the coding sequence, and/or higher level conseq uences at the organism level e.g. pathogenicity. This field is only set for anno tations of type VARIANT."
1554 }
1555 },
1556 "type": "object"
1557 },
1558 "AnnotationSet": {
1559 "description": "An annotation set is a logical grouping of annotatio ns that share consistent type information and provenance. Examples of annotation sets include 'all genes from refseq', and 'all variant annotations from ClinVar '.",
1560 "id": "AnnotationSet",
1561 "properties": {
1562 "datasetId": {
1563 "description": "The dataset to which this annotation set bel ongs.",
1564 "type": "string"
1565 },
1566 "id": {
1567 "description": "The server-generated annotation set ID, uniq ue across all annotation sets.",
1568 "type": "string"
1569 },
1570 "info": {
1571 "additionalProperties": {
1572 "description": "A string which maps to an array of value s.",
1573 "items": {
1574 "type": "string"
1575 },
1576 "type": "array"
1577 },
1578 "description": "A string which maps to an array of values.",
1579 "type": "object"
1580 },
1581 "name": {
1582 "description": "The display name for this annotation set.",
1583 "type": "string"
1584 },
1585 "referenceSetId": {
1586 "description": "The ID of the reference set that defines the coordinate space for this set's annotations.",
1587 "type": "string"
1588 },
1589 "sourceUri": {
1590 "description": "The source URI describing the file from whic h this annotation set was generated, if any.",
1591 "type": "string"
1592 },
1593 "type": {
1594 "description": "The type of annotations contained within thi s set.",
1595 "enum": [
1596 "GENE",
1597 "GENERIC",
1598 "TRANSCRIPT",
1599 "VARIANT"
1600 ],
1601 "enumDescriptions": [
1602 "",
1603 "",
1604 "",
1605 ""
1606 ],
1607 "type": "string"
1608 }
1609 },
1610 "type": "object"
1611 },
1612 "BatchAnnotationsResponse": {
1613 "id": "BatchAnnotationsResponse",
1614 "properties": {
1615 "entries": {
1616 "description": "The resulting per-annotation entries, ordere d consistently with the original request.",
1617 "items": {
1618 "$ref": "BatchAnnotationsResponseEntry"
1619 },
1620 "type": "array"
1621 }
1622 },
1623 "type": "object"
1624 },
1625 "BatchAnnotationsResponseEntry": {
1626 "id": "BatchAnnotationsResponseEntry",
1627 "properties": {
1628 "annotation": {
1629 "$ref": "Annotation",
1630 "description": "The annotation, if any."
1631 },
1632 "status": {
1633 "$ref": "BatchAnnotationsResponseEntryStatus",
1634 "description": "The resulting status for this annotation ope ration."
1635 }
1636 },
1637 "type": "object"
1638 },
1639 "BatchAnnotationsResponseEntryStatus": {
1640 "description": "",
1641 "id": "BatchAnnotationsResponseEntryStatus",
1642 "properties": {
1643 "code": {
1644 "description": "The HTTP status code for this operation.",
1645 "format": "int32",
1646 "type": "integer"
1647 },
1648 "message": {
1649 "description": "Error message for this status, if any.",
1650 "type": "string"
1651 }
1652 },
1653 "type": "object"
1654 },
1655 "BatchCreateAnnotationsRequest": {
1656 "id": "BatchCreateAnnotationsRequest",
1657 "properties": {
1658 "annotations": {
1659 "description": "The annotations to be created. At most 4096 can be specified in a single request.",
1660 "items": {
1661 "$ref": "Annotation"
1662 },
1663 "type": "array"
1664 }
1665 },
1666 "type": "object"
1667 },
1668 "Call": {
1669 "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 call set with the name NA12345.",
1670 "id": "Call",
1671 "properties": {
1672 "callSetId": {
1673 "description": "The ID of the call set this variant call bel ongs to.",
1674 "type": "string"
1675 },
1676 "callSetName": {
1677 "description": "The name of the call set this variant call b elongs to.",
1678 "type": "string"
1679 },
1680 "genotype": {
1681 "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 value of T and an alternateB ases value of [\"A\", \"C\"], and the genotype was [2, 1], that would mean the c all represented the heterozygous value CA for this variant. If the genotype was instead [0, 1], the represented value would be TA. Ordering of the genotype valu es is important if the phaseset is present. If a genotype is not called (that is , a . is present in the GT string) -1 is returned.",
1682 "items": {
1683 "format": "int32",
1684 "type": "integer"
1685 },
1686 "type": "array"
1687 },
1688 "genotypeLikelihood": {
1689 "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. If Phred-scaled ge notype likelihood scores (PL) are available and log10(P) genotype likelihood sco res (GL) are not, PL scores are converted to GL scores. If both are available, P L scores are stored in info.",
1690 "items": {
1691 "format": "double",
1692 "type": "number"
1693 },
1694 "type": "array"
1695 },
1696 "info": {
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 string which maps to an array of values.",
1705 "type": "object"
1706 },
1707 "phaseset": {
1708 "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 in the same reference sequence which have the same phaseset va lue. When importing data from VCF, if the genotype data was phased but no phase set was specified this field will be set to *.",
1709 "type": "string"
1710 }
1711 },
1712 "type": "object"
1713 },
1714 "CallSet": {
1715 "description": "A call set is a collection of variant calls, typical ly for one sample. It belongs to a variant set.",
1716 "id": "CallSet",
1717 "properties": {
1718 "created": {
1719 "description": "The date this call set was created in millis econds from the epoch.",
1720 "format": "int64",
1721 "type": "string"
1722 },
1723 "id": {
1724 "description": "The Google generated ID of the call set, imm utable.",
1725 "type": "string"
1726 },
1727 "info": {
1728 "additionalProperties": {
1729 "description": "A string which maps to an array of value s.",
1730 "items": {
1731 "type": "string"
1732 },
1733 "type": "array"
1734 },
1735 "description": "A string which maps to an array of values.",
1736 "type": "object"
1737 },
1738 "name": {
1739 "description": "The call set name.",
1740 "type": "string"
1741 },
1742 "sampleId": {
1743 "description": "The sample ID this call set corresponds to." ,
1744 "type": "string"
1745 },
1746 "variantSetIds": {
1747 "description": "The IDs of the variant sets this call set be longs to.",
1748 "items": {
1749 "type": "string"
1750 },
1751 "type": "array"
1752 }
1753 },
1754 "type": "object"
1755 },
1756 "CigarUnit": {
1757 "description": "A single CIGAR operation.",
1758 "id": "CigarUnit",
1759 "properties": {
1760 "operation": {
1761 "enum": [
1762 "ALIGNMENT_MATCH",
1763 "CLIP_HARD",
1764 "CLIP_SOFT",
1765 "DELETE",
1766 "INSERT",
1767 "OPERATION_UNSPECIFIED",
1768 "PAD",
1769 "SEQUENCE_MATCH",
1770 "SEQUENCE_MISMATCH",
1771 "SKIP"
1772 ],
1773 "enumDescriptions": [
1774 "",
1775 "",
1776 "",
1777 "",
1778 "",
1779 "",
1780 "",
1781 "",
1782 "",
1783 ""
1784 ],
1785 "type": "string"
1786 },
1787 "operationLength": {
1788 "description": "The number of bases that the operation runs for. Required.",
1789 "format": "int64",
1790 "type": "string"
1791 },
1792 "referenceSequence": {
1793 "description": "referenceSequence is only used at mismatches (SEQUENCE_MISMATCH) and deletions (DELETE). Filling this field replaces SAM's M D tag. If the relevant information is not available, this field is unset.",
1794 "type": "string"
1795 }
1796 },
1797 "type": "object"
1798 },
1799 "CoverageBucket": {
1800 "description": "A bucket over which read coverage has been precomput ed. A bucket corresponds to a specific range of the reference sequence.",
1801 "id": "CoverageBucket",
1802 "properties": {
1803 "meanCoverage": {
1804 "description": "The average number of reads which are aligne d to each individual reference base in this bucket.",
1805 "format": "float",
1806 "type": "number"
1807 },
1808 "range": {
1809 "$ref": "Range",
1810 "description": "The genomic coordinate range spanned by this bucket."
1811 }
1812 },
1813 "type": "object"
1814 },
1815 "Dataset": {
1816 "description": "A Dataset is a collection of genomic data.",
1817 "id": "Dataset",
1818 "properties": {
1819 "createTime": {
1820 "description": "The time this dataset was created, in second s from the epoch.",
1821 "format": "int64",
1822 "type": "string"
1823 },
1824 "id": {
1825 "description": "The Google generated ID of the dataset, immu table.",
1826 "type": "string"
1827 },
1828 "isPublic": {
1829 "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.",
1830 "type": "boolean"
1831 },
1832 "name": {
1833 "description": "The dataset name.",
1834 "type": "string"
1835 },
1836 "projectNumber": {
1837 "description": "The Google Developers Console project number that this dataset belongs to.",
1838 "format": "int64",
1839 "type": "string"
1840 }
1841 },
1842 "type": "object"
1843 },
1844 "ExperimentalCreateJobRequest": {
1845 "description": "The job creation request.",
1846 "id": "ExperimentalCreateJobRequest",
1847 "properties": {
1848 "align": {
1849 "description": "Specifies whether or not to run the alignmen t pipeline. Either align or callVariants must be set.",
1850 "type": "boolean"
1851 },
1852 "callVariants": {
1853 "description": "Specifies whether or not to run the variant calling pipeline. Either align or callVariants must be set.",
1854 "type": "boolean"
1855 },
1856 "gcsOutputPath": {
1857 "description": "Specifies where to copy the results of certa in pipelines. This should be in the form of gs://bucket/path.",
1858 "type": "string"
1859 },
1860 "pairedSourceUris": {
1861 "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.",
1862 "items": {
1863 "type": "string"
1864 },
1865 "type": "array"
1866 },
1867 "projectNumber": {
1868 "description": "Required. The Google Cloud Project ID with w hich to associate the request.",
1869 "format": "int64",
1870 "type": "string"
1871 },
1872 "sourceUris": {
1873 "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.",
1874 "items": {
1875 "type": "string"
1876 },
1877 "type": "array"
1878 }
1879 },
1880 "type": "object"
1881 },
1882 "ExperimentalCreateJobResponse": {
1883 "description": "The job creation response.",
1884 "id": "ExperimentalCreateJobResponse",
1885 "properties": {
1886 "jobId": {
1887 "description": "A job ID that can be used to get status info rmation.",
1888 "type": "string"
1889 }
1890 },
1891 "type": "object"
1892 },
1893 "ExportReadGroupSetsRequest": {
1894 "description": "The read group set export request.",
1895 "id": "ExportReadGroupSetsRequest",
1896 "properties": {
1897 "exportUri": {
1898 "description": "Required. A Google Cloud Storage URI for the exported BAM file. The currently authenticated user must have write access to t he new file. An error will be returned if the URI already contains data.",
1899 "type": "string"
1900 },
1901 "projectNumber": {
1902 "description": "Required. The Google Developers Console proj ect number that owns this export. The caller must have WRITE access to this proj ect.",
1903 "format": "int64",
1904 "type": "string"
1905 },
1906 "readGroupSetIds": {
1907 "description": "Required. The IDs of the read group sets to export. The caller must have READ access to these read group sets.",
1908 "items": {
1909 "type": "string"
1910 },
1911 "type": "array"
1912 },
1913 "referenceNames": {
1914 "description": "The reference names to export. If this is no t specified, all reference sequences, including unmapped reads, are exported. Us e * to export only unmapped reads.",
1915 "items": {
1916 "type": "string"
1917 },
1918 "type": "array"
1919 }
1920 },
1921 "type": "object"
1922 },
1923 "ExportReadGroupSetsResponse": {
1924 "description": "The read group set export response.",
1925 "id": "ExportReadGroupSetsResponse",
1926 "properties": {
1927 "jobId": {
1928 "description": "A job ID that can be used to get status info rmation.",
1929 "type": "string"
1930 }
1931 },
1932 "type": "object"
1933 },
1934 "ExportVariantSetRequest": {
1935 "description": "The variant data export request.",
1936 "id": "ExportVariantSetRequest",
1937 "properties": {
1938 "bigqueryDataset": {
1939 "description": "Required. The BigQuery dataset to export dat a to. This dataset must already exist. Note that this is distinct from the Genom ics concept of \"dataset\".",
1940 "type": "string"
1941 },
1942 "bigqueryTable": {
1943 "description": "Required. The BigQuery table to export data to. If the table doesn't exist, it will be created. If it already exists, it wil l be overwritten.",
1944 "type": "string"
1945 },
1946 "callSetIds": {
1947 "description": "If provided, only variant call information f rom the specified call sets will be exported. By default all variant calls are e xported.",
1948 "items": {
1949 "type": "string"
1950 },
1951 "type": "array"
1952 },
1953 "format": {
1954 "description": "The format for the exported data.",
1955 "enum": [
1956 "BIGQUERY"
1957 ],
1958 "enumDescriptions": [
1959 ""
1960 ],
1961 "type": "string"
1962 },
1963 "projectNumber": {
1964 "description": "Required. The Google Cloud project number th at owns the destination BigQuery dataset. The caller must have WRITE access to t his project. This project will also own the resulting export job.",
1965 "format": "int64",
1966 "type": "string"
1967 }
1968 },
1969 "type": "object"
1970 },
1971 "ExportVariantSetResponse": {
1972 "description": "The variant data export response.",
1973 "id": "ExportVariantSetResponse",
1974 "properties": {
1975 "jobId": {
1976 "description": "A job ID that can be used to get status info rmation.",
1977 "type": "string"
1978 }
1979 },
1980 "type": "object"
1981 },
1982 "ExternalId": {
1983 "id": "ExternalId",
1984 "properties": {
1985 "id": {
1986 "description": "The id used by the source of this data.",
1987 "type": "string"
1988 },
1989 "sourceName": {
1990 "description": "The name of the source of this data.",
1991 "type": "string"
1992 }
1993 },
1994 "type": "object"
1995 },
1996 "ImportReadGroupSetsRequest": {
1997 "description": "The read group set import request.",
1998 "id": "ImportReadGroupSetsRequest",
1999 "properties": {
2000 "datasetId": {
2001 "description": "Required. The ID of the dataset these read g roup sets will belong to. The caller must have WRITE permissions to this dataset .",
2002 "type": "string"
2003 },
2004 "partitionStrategy": {
2005 "description": "The partition strategy describes how read gr oups are partitioned into read group sets.",
2006 "enum": [
2007 "MERGE_ALL",
2008 "PER_FILE_PER_SAMPLE"
2009 ],
2010 "enumDescriptions": [
2011 "",
2012 ""
2013 ],
2014 "type": "string"
2015 },
2016 "referenceSetId": {
2017 "description": "The reference set to which the imported read group sets are aligned to, if any. The reference names of this reference set mu st be a superset of those found in the imported file headers. If no reference se t id is provided, a best effort is made to associate with a matching reference s et.",
2018 "type": "string"
2019 },
2020 "sourceUris": {
2021 "description": "A list of URIs pointing at BAM files in Goog le Cloud Storage.",
2022 "items": {
2023 "type": "string"
2024 },
2025 "type": "array"
2026 }
2027 },
2028 "type": "object"
2029 },
2030 "ImportReadGroupSetsResponse": {
2031 "description": "The read group set import response.",
2032 "id": "ImportReadGroupSetsResponse",
2033 "properties": {
2034 "jobId": {
2035 "description": "A job ID that can be used to get status info rmation.",
2036 "type": "string"
2037 }
2038 },
2039 "type": "object"
2040 },
2041 "ImportVariantsRequest": {
2042 "description": "The variant data import request.",
2043 "id": "ImportVariantsRequest",
2044 "properties": {
2045 "format": {
2046 "description": "The format of the variant data being importe d. If unspecified, defaults to \"VCF\".",
2047 "enum": [
2048 "COMPLETE_GENOMICS",
2049 "VCF"
2050 ],
2051 "enumDescriptions": [
2052 "",
2053 ""
2054 ],
2055 "type": "string"
2056 },
2057 "normalizeReferenceNames": {
2058 "description": "Convert reference names to the canonical rep resentation. hg19 haploytypes (those reference names containing \"_hap\") are no t modified in any way. All other reference names are modified according to the f ollowing rules: The reference name is capitalized. The \"chr\" prefix is dropped for all autosomes and sex chromsomes. For example \"chr17\" becomes \"17\" and \"chrX\" becomes \"X\". All mitochondrial chromosomes (\"chrM\", \"chrMT\", etc) become \"MT\".",
2059 "type": "boolean"
2060 },
2061 "sourceUris": {
2062 "description": "A list of URIs referencing variant files in Google Cloud Storage. URIs can include wildcards as described here. Note that re cursive wildcards ('**') are not supported.",
2063 "items": {
2064 "type": "string"
2065 },
2066 "type": "array"
2067 }
2068 },
2069 "type": "object"
2070 },
2071 "ImportVariantsResponse": {
2072 "description": "The variant data import response.",
2073 "id": "ImportVariantsResponse",
2074 "properties": {
2075 "jobId": {
2076 "description": "A job ID that can be used to get status info rmation.",
2077 "type": "string"
2078 }
2079 },
2080 "type": "object"
2081 },
2082 "Int32Value": {
2083 "description": "Wrapper message for `int32`.\n\nThe JSON representat ion for `Int32Value` is JSON number.",
2084 "id": "Int32Value",
2085 "properties": {
2086 "value": {
2087 "description": "The int32 value.",
2088 "format": "int32",
2089 "type": "integer"
2090 }
2091 },
2092 "type": "object"
2093 },
2094 "Job": {
2095 "description": "A Job represents an ongoing process that can be moni tored for status information.",
2096 "id": "Job",
2097 "properties": {
2098 "created": {
2099 "description": "The date this job was created, in millisecon ds from the epoch.",
2100 "format": "int64",
2101 "type": "string"
2102 },
2103 "detailedStatus": {
2104 "description": "A more detailed description of this job's cu rrent status.",
2105 "type": "string"
2106 },
2107 "errors": {
2108 "description": "Any errors that occurred during processing." ,
2109 "items": {
2110 "type": "string"
2111 },
2112 "type": "array"
2113 },
2114 "id": {
2115 "description": "The job ID.",
2116 "type": "string"
2117 },
2118 "importedIds": {
2119 "description": "If this Job represents an import, this field will contain the IDs of the objects that were successfully imported.",
2120 "items": {
2121 "type": "string"
2122 },
2123 "type": "array"
2124 },
2125 "projectNumber": {
2126 "description": "The Google Developers Console project number to which this job belongs.",
2127 "format": "int64",
2128 "type": "string"
2129 },
2130 "request": {
2131 "$ref": "JobRequest",
2132 "description": "A summarized representation of the original service request."
2133 },
2134 "status": {
2135 "description": "The status of this job.",
2136 "enum": [
2137 "CANCELED",
2138 "FAILURE",
2139 "NEW",
2140 "PENDING",
2141 "RUNNING",
2142 "SUCCESS",
2143 "UNKNOWN_STATUS"
2144 ],
2145 "enumDescriptions": [
2146 "",
2147 "",
2148 "",
2149 "",
2150 "",
2151 "",
2152 ""
2153 ],
2154 "type": "string"
2155 },
2156 "warnings": {
2157 "description": "Any warnings that occurred during processing .",
2158 "items": {
2159 "type": "string"
2160 },
2161 "type": "array"
2162 }
2163 },
2164 "type": "object"
2165 },
2166 "JobRequest": {
2167 "description": "A summary representation of the service request that spawned the job.",
2168 "id": "JobRequest",
2169 "properties": {
2170 "destination": {
2171 "description": "The data destination of the request, for exa mple, a Google BigQuery Table or Dataset ID.",
2172 "items": {
2173 "type": "string"
2174 },
2175 "type": "array"
2176 },
2177 "source": {
2178 "description": "The data source of the request, for example, a Google Cloud Storage object path or Readset ID.",
2179 "items": {
2180 "type": "string"
2181 },
2182 "type": "array"
2183 },
2184 "type": {
2185 "description": "The original request type.",
2186 "enum": [
2187 "ALIGN_READSETS",
2188 "CALL_READSETS",
2189 "EXPERIMENTAL_CREATE_JOB",
2190 "EXPORT_READSETS",
2191 "EXPORT_VARIANTS",
2192 "IMPORT_READSETS",
2193 "IMPORT_VARIANTS",
2194 "UNKNOWN_TYPE"
2195 ],
2196 "enumDescriptions": [
2197 "",
2198 "",
2199 "",
2200 "",
2201 "",
2202 "",
2203 "",
2204 ""
2205 ],
2206 "type": "string"
2207 }
2208 },
2209 "type": "object"
2210 },
2211 "KeyValue": {
2212 "description": "Used to hold basic key value information.",
2213 "id": "KeyValue",
2214 "properties": {
2215 "key": {
2216 "description": "A string which maps to an array of values.",
2217 "type": "string"
2218 },
2219 "value": {
2220 "description": "The string values.",
2221 "items": {
2222 "type": "string"
2223 },
2224 "type": "array"
2225 }
2226 },
2227 "type": "object"
2228 },
2229 "LinearAlignment": {
2230 "description": "A linear alignment can be represented by one CIGAR s tring. Describes the mapped position and local alignment of the read to the refe rence.",
2231 "id": "LinearAlignment",
2232 "properties": {
2233 "cigar": {
2234 "description": "Represents the local alignment of this seque nce (alignment matches, indels, etc) against the reference.",
2235 "items": {
2236 "$ref": "CigarUnit"
2237 },
2238 "type": "array"
2239 },
2240 "mappingQuality": {
2241 "description": "The mapping quality of this alignment. Repre sents how likely the read maps to this position as opposed to other locations.\n \nSpecifically, this is -10 log10 Pr(mapping position is wrong), rounded to the nearest integer.",
2242 "format": "int32",
2243 "type": "integer"
2244 },
2245 "position": {
2246 "$ref": "Position",
2247 "description": "The position of this alignment."
2248 }
2249 },
2250 "type": "object"
2251 },
2252 "ListBasesResponse": {
2253 "id": "ListBasesResponse",
2254 "properties": {
2255 "nextPageToken": {
2256 "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.",
2257 "type": "string"
2258 },
2259 "offset": {
2260 "description": "The offset position (0-based) of the given s equence from the start of this Reference. This value will differ for each page i n a paginated request.",
2261 "format": "int64",
2262 "type": "string"
2263 },
2264 "sequence": {
2265 "description": "A substring of the bases that make up this r eference.",
2266 "type": "string"
2267 }
2268 },
2269 "type": "object"
2270 },
2271 "ListCoverageBucketsResponse": {
2272 "id": "ListCoverageBucketsResponse",
2273 "properties": {
2274 "bucketWidth": {
2275 "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 targetBucketWidth).",
2276 "format": "int64",
2277 "type": "string"
2278 },
2279 "coverageBuckets": {
2280 "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 bucketWidth, unless i ts end is the end of the reference sequence.",
2281 "items": {
2282 "$ref": "CoverageBucket"
2283 },
2284 "type": "array"
2285 },
2286 "nextPageToken": {
2287 "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.",
2288 "type": "string"
2289 }
2290 },
2291 "type": "object"
2292 },
2293 "ListDatasetsResponse": {
2294 "description": "The dataset list response.",
2295 "id": "ListDatasetsResponse",
2296 "properties": {
2297 "datasets": {
2298 "description": "The list of matching Datasets.",
2299 "items": {
2300 "$ref": "Dataset"
2301 },
2302 "type": "array"
2303 },
2304 "nextPageToken": {
2305 "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.",
2306 "type": "string"
2307 }
2308 },
2309 "type": "object"
2310 },
2311 "MergeVariantsRequest": {
2312 "id": "MergeVariantsRequest",
2313 "properties": {
2314 "variants": {
2315 "description": "The variants to be merged with existing vari ants.",
2316 "items": {
2317 "$ref": "Variant"
2318 },
2319 "type": "array"
2320 }
2321 },
2322 "type": "object"
2323 },
2324 "Metadata": {
2325 "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." ,
2326 "id": "Metadata",
2327 "properties": {
2328 "description": {
2329 "description": "A textual description of this metadata.",
2330 "type": "string"
2331 },
2332 "id": {
2333 "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.",
2334 "type": "string"
2335 },
2336 "info": {
2337 "additionalProperties": {
2338 "description": "A string which maps to an array of value s.",
2339 "items": {
2340 "type": "string"
2341 },
2342 "type": "array"
2343 },
2344 "description": "A string which maps to an array of values.",
2345 "type": "object"
2346 },
2347 "key": {
2348 "description": "The top-level key.",
2349 "type": "string"
2350 },
2351 "number": {
2352 "description": "The number of values that can be included in a field described by this metadata.",
2353 "type": "string"
2354 },
2355 "type": {
2356 "description": "The type of data. Possible types include: In teger, Float, Flag, Character, and String.",
2357 "enum": [
2358 "CHARACTER",
2359 "FLAG",
2360 "FLOAT",
2361 "INTEGER",
2362 "STRING",
2363 "UNKNOWN_TYPE"
2364 ],
2365 "enumDescriptions": [
2366 "",
2367 "",
2368 "",
2369 "",
2370 "",
2371 ""
2372 ],
2373 "type": "string"
2374 },
2375 "value": {
2376 "description": "The value field for simple metadata",
2377 "type": "string"
2378 }
2379 },
2380 "type": "object"
2381 },
2382 "Position": {
2383 "description": "An abstraction for referring to a genomic position, in relation to some already known reference. For now, represents a genomic posit ion as a reference name, a base number on that reference (0-based), and a determ ination of forward or reverse strand.",
2384 "id": "Position",
2385 "properties": {
2386 "position": {
2387 "description": "The 0-based offset from the start of the for ward strand for that reference.",
2388 "format": "int64",
2389 "type": "string"
2390 },
2391 "referenceName": {
2392 "description": "The name of the reference in whatever refere nce set is being used.",
2393 "type": "string"
2394 },
2395 "reverseStrand": {
2396 "description": "Whether this position is on the reverse stra nd, as opposed to the forward strand.",
2397 "type": "boolean"
2398 }
2399 },
2400 "type": "object"
2401 },
2402 "QueryRange": {
2403 "description": "A 0-based half-open genomic coordinate range for sea rch requests. reference_id or reference_name must be set.",
2404 "id": "QueryRange",
2405 "properties": {
2406 "end": {
2407 "description": "The end position of the range on the referen ce, 0-based exclusive. If specified, referenceId or referenceName must also be s pecified. If unset or 0, defaults to the length of the reference.",
2408 "format": "int64",
2409 "type": "string"
2410 },
2411 "referenceId": {
2412 "description": "The ID of the reference to query.",
2413 "type": "string"
2414 },
2415 "referenceName": {
2416 "description": "The name of the reference to query, within t he reference set associated with this query.",
2417 "type": "string"
2418 },
2419 "start": {
2420 "description": "The start position of the range on the refer ence, 0-based inclusive. If specified, referenceId or referenceName must also be specified. Defaults to 0.",
2421 "format": "int64",
2422 "type": "string"
2423 }
2424 },
2425 "type": "object"
2426 },
2427 "Range": {
2428 "description": "A 0-based half-open genomic coordinate range over a reference sequence.",
2429 "id": "Range",
2430 "properties": {
2431 "end": {
2432 "description": "The end position of the range on the referen ce, 0-based exclusive. If specified, referenceName must also be specified.",
2433 "format": "int64",
2434 "type": "string"
2435 },
2436 "referenceName": {
2437 "description": "The reference sequence name, for example chr 1, 1, or chrX.",
2438 "type": "string"
2439 },
2440 "start": {
2441 "description": "The start position of the range on the refer ence, 0-based inclusive. If specified, referenceName must also be specified.",
2442 "format": "int64",
2443 "type": "string"
2444 }
2445 },
2446 "type": "object"
2447 },
2448 "RangePosition": {
2449 "description": "A 0-based half-open genomic coordinate range over a reference sequence, for representing the position of a genomic resource.",
2450 "id": "RangePosition",
2451 "properties": {
2452 "end": {
2453 "description": "The end position of the range on the referen ce, 0-based exclusive.",
2454 "format": "int64",
2455 "type": "string"
2456 },
2457 "referenceId": {
2458 "description": "The ID of the Google Genomics reference asso ciated with this range.",
2459 "type": "string"
2460 },
2461 "referenceName": {
2462 "description": "The display name corresponding to the refere nce specified by referenceId, for example chr1, 1, or chrX.",
2463 "type": "string"
2464 },
2465 "reverseStrand": {
2466 "description": "Whether this range refers to the reverse str and, as opposed to the forward strand. Note that regardless of this field, the s tart/end position of the range always refer to the forward strand.",
2467 "type": "boolean"
2468 },
2469 "start": {
2470 "description": "The start position of the range on the refer ence, 0-based inclusive.",
2471 "format": "int64",
2472 "type": "string"
2473 }
2474 },
2475 "type": "object"
2476 },
2477 "Read": {
2478 "description": "A read alignment describes a linear alignment of a s tring of DNA to a reference sequence, in addition to metadata about the fragment (the molecule of DNA sequenced) and the read (the bases which were read by the sequencer). A read is equivalent to a line in a SAM file. A read belongs to exac tly one read group and exactly one read group set. Generating a reference-aligne d sequence string When interacting with mapped reads, it's often useful to produ ce a string representing the local alignment of the read to reference. The follo wing pseudocode demonstrates one way of doing this:\nout = \"\" offset = 0 for c in read.alignment.cigar { switch c.operation { case \"ALIGNMENT_MATCH\", \"SEQU ENCE_MATCH\", \"SEQUENCE_MISMATCH\": out += read.alignedSequence[offset:offset+c .operationLength] offset += c.operationLength break case \"CLIP_SOFT\", \"INSERT \": offset += c.operationLength break case \"PAD\": out += repeat(\"*\", c.opera tionLength) break case \"DELETE\": out += repeat(\"-\", c.operationLength) break case \"SKIP\": out += repeat(\" \", c.operationLength) break case \"CLIP_HARD\" : break } } return out\nConverting to SAM's CIGAR string The following pseudocod e generates a SAM CIGAR string from the cigar field. Note that this is a lossy c onversion (cigar.referenceSequence is lost).\ncigarMap = { \"ALIGNMENT_MATCH\": \"M\", \"INSERT\": \"I\", \"DELETE\": \"D\", \"SKIP\": \"N\", \"CLIP_SOFT\": \"S \", \"CLIP_HARD\": \"H\", \"PAD\": \"P\", \"SEQUENCE_MATCH\": \"=\", \"SEQUENCE_ MISMATCH\": \"X\", } cigarStr = \"\" for c in read.alignment.cigar { cigarStr += c.operationLength + cigarMap[c.operation] } return cigarStr",
2479 "id": "Read",
2480 "properties": {
2481 "alignedQuality": {
2482 "description": "The quality of the read sequence contained i n this alignment record. (equivalent to QUAL in SAM). alignedSequence and aligne dQuality may be shorter than the full read sequence and quality. This will occur if the alignment is part of a chimeric alignment, or if the read was trimmed. W hen this occurs, the CIGAR for this read will begin/end with a hard clip operato r that will indicate the length of the excised sequence.",
2483 "items": {
2484 "format": "int32",
2485 "type": "integer"
2486 },
2487 "type": "array"
2488 },
2489 "alignedSequence": {
2490 "description": "The bases of the read sequence contained in this alignment record, without CIGAR operations applied (equivalent to SEQ in SA M). alignedSequence and alignedQuality may be shorter than the full read sequenc e and quality. This will occur if the alignment is part of a chimeric alignment, or if the read was trimmed. When this occurs, the CIGAR for this read will begi n/end with a hard clip operator that will indicate the length of the excised seq uence.",
2491 "type": "string"
2492 },
2493 "alignment": {
2494 "$ref": "LinearAlignment",
2495 "description": "The linear alignment for this alignment reco rd. This field is null for unmapped reads."
2496 },
2497 "duplicateFragment": {
2498 "description": "The fragment is a PCR or optical duplicate ( SAM flag 0x400).",
2499 "type": "boolean"
2500 },
2501 "failedVendorQualityChecks": {
2502 "description": "Whether this read did not pass filters, such as platform or vendor quality controls (SAM flag 0x200).",
2503 "type": "boolean"
2504 },
2505 "fragmentLength": {
2506 "description": "The observed length of the fragment, equival ent to TLEN in SAM.",
2507 "format": "int32",
2508 "type": "integer"
2509 },
2510 "fragmentName": {
2511 "description": "The fragment name. Equivalent to QNAME (quer y template name) in SAM.",
2512 "type": "string"
2513 },
2514 "id": {
2515 "description": "The unique ID for this read. This is a gener ated unique ID, not to be confused with fragmentName.",
2516 "type": "string"
2517 },
2518 "info": {
2519 "additionalProperties": {
2520 "description": "A string which maps to an array of value s.",
2521 "items": {
2522 "type": "string"
2523 },
2524 "type": "array"
2525 },
2526 "description": "A string which maps to an array of values.",
2527 "type": "object"
2528 },
2529 "nextMatePosition": {
2530 "$ref": "Position",
2531 "description": "The position of the primary alignment of the (readNumber+1)%numberReads read in the fragment. It replaces mate position and mate strand in SAM. This field will be unset if that read is unmapped or if the fragment only has a single read."
2532 },
2533 "numberReads": {
2534 "description": "The number of reads in the fragment (extensi on to SAM flag 0x1).",
2535 "format": "int32",
2536 "type": "integer"
2537 },
2538 "properPlacement": {
2539 "description": "The orientation and the distance between rea ds from the fragment are consistent with the sequencing protocol (SAM flag 0x2). ",
2540 "type": "boolean"
2541 },
2542 "readGroupId": {
2543 "description": "The ID of the read group this read belongs t o. A read belongs to exactly one read group. This is a server-generated ID (not SAM's RG tag).",
2544 "type": "string"
2545 },
2546 "readGroupSetId": {
2547 "description": "The ID of the read group set this read belon gs to. A read belongs to exactly one read group set.",
2548 "type": "string"
2549 },
2550 "readNumber": {
2551 "description": "The read number in sequencing. 0-based and l ess than numberReads. This field replaces SAM flag 0x40 and 0x80.",
2552 "format": "int32",
2553 "type": "integer"
2554 },
2555 "secondaryAlignment": {
2556 "description": "Whether this alignment is secondary. Equival ent to SAM flag 0x100. A secondary alignment represents an alternative to the pr imary alignment for this read. Aligners may return secondary alignments if a rea d can map ambiguously to multiple coordinates in the genome. By convention, each read has one and only one alignment where both secondaryAlignment and supplemen taryAlignment are false.",
2557 "type": "boolean"
2558 },
2559 "supplementaryAlignment": {
2560 "description": "Whether this alignment is supplementary. Equ ivalent to SAM flag 0x800. Supplementary alignments are used in the representati on of a chimeric alignment. In a chimeric alignment, a read is split into multip le linear alignments that map to different reference contigs. The first linear a lignment in the read will be designated as the representative alignment; the rem aining linear alignments will be designated as supplementary alignments. These a lignments may have different mapping quality scores. In each linear alignment in a chimeric alignment, the read will be hard clipped. The alignedSequence and al ignedQuality fields in the alignment record will only represent the bases for it s respective linear alignment.",
2561 "type": "boolean"
2562 }
2563 },
2564 "type": "object"
2565 },
2566 "ReadGroup": {
2567 "description": "A read group is all the data that's processed the sa me way by the sequencer.",
2568 "id": "ReadGroup",
2569 "properties": {
2570 "datasetId": {
2571 "description": "The ID of the dataset this read group belong s to.",
2572 "type": "string"
2573 },
2574 "description": {
2575 "description": "A free-form text description of this read gr oup.",
2576 "type": "string"
2577 },
2578 "experiment": {
2579 "$ref": "ReadGroupExperiment",
2580 "description": "The experiment used to generate this read gr oup."
2581 },
2582 "id": {
2583 "description": "The generated unique read group ID. Note: Th is is different than the @RG ID field in the SAM spec. For that value, see the n ame field.",
2584 "type": "string"
2585 },
2586 "info": {
2587 "additionalProperties": {
2588 "description": "A string which maps to an array of value s.",
2589 "items": {
2590 "type": "string"
2591 },
2592 "type": "array"
2593 },
2594 "description": "A string which maps to an array of values.",
2595 "type": "object"
2596 },
2597 "name": {
2598 "description": "The read group name. This corresponds to the @RG ID field in the SAM spec.",
2599 "type": "string"
2600 },
2601 "predictedInsertSize": {
2602 "description": "The predicted insert size of this read group . The insert size is the length the sequenced DNA fragment from end-to-end, not including the adapters.",
2603 "format": "int32",
2604 "type": "integer"
2605 },
2606 "programs": {
2607 "description": "The programs used to generate this read grou p. Programs are always identical for all read groups within a read group set. Fo r this reason, only the first read group in a returned set will have this field populated.",
2608 "items": {
2609 "$ref": "ReadGroupProgram"
2610 },
2611 "type": "array"
2612 },
2613 "referenceSetId": {
2614 "description": "The reference set to which the reads in this read group are aligned.",
2615 "type": "string"
2616 },
2617 "sampleId": {
2618 "description": "The sample this read group's data was genera ted from. Note: This is not an actual ID within this repository, but rather an i dentifier for a sample which may be meaningful to some external system.",
2619 "type": "string"
2620 }
2621 },
2622 "type": "object"
2623 },
2624 "ReadGroupExperiment": {
2625 "id": "ReadGroupExperiment",
2626 "properties": {
2627 "instrumentModel": {
2628 "description": "The instrument model used as part of this ex periment. This maps to sequencing technology in BAM.",
2629 "type": "string"
2630 },
2631 "libraryId": {
2632 "description": "The library used as part of this experiment. Note: This is not an actual ID within this repository, but rather an identifier for a library which may be meaningful to some external system.",
2633 "type": "string"
2634 },
2635 "platformUnit": {
2636 "description": "The platform unit used as part of this exper iment e.g. flowcell-barcode.lane for Illumina or slide for SOLiD. Corresponds to the",
2637 "type": "string"
2638 },
2639 "sequencingCenter": {
2640 "description": "The sequencing center used as part of this e xperiment.",
2641 "type": "string"
2642 }
2643 },
2644 "type": "object"
2645 },
2646 "ReadGroupProgram": {
2647 "id": "ReadGroupProgram",
2648 "properties": {
2649 "commandLine": {
2650 "description": "The command line used to run this program.",
2651 "type": "string"
2652 },
2653 "id": {
2654 "description": "The user specified locally unique ID of the program. Used along with prevProgramId to define an ordering between programs.",
2655 "type": "string"
2656 },
2657 "name": {
2658 "description": "The display name of the program. This is typ ically the colloquial name of the tool used, for example 'bwa' or 'picard'.",
2659 "type": "string"
2660 },
2661 "prevProgramId": {
2662 "description": "The ID of the program run before this one.",
2663 "type": "string"
2664 },
2665 "version": {
2666 "description": "The version of the program run.",
2667 "type": "string"
2668 }
2669 },
2670 "type": "object"
2671 },
2672 "ReadGroupSet": {
2673 "description": "A read group set is a logical collection of read gro ups, which are collections of reads produced by a sequencer. A read group set ty pically models reads corresponding to one sample, sequenced one way, and aligned one way. \n- A read group set belongs to one dataset.\n- A read group belongs to one read group set.\n- A read belongs to one read group.",
2674 "id": "ReadGroupSet",
2675 "properties": {
2676 "datasetId": {
2677 "description": "The dataset ID.",
2678 "type": "string"
2679 },
2680 "filename": {
2681 "description": "The filename of the original source file for this read group set, if any.",
2682 "type": "string"
2683 },
2684 "id": {
2685 "description": "The read group set ID.",
2686 "type": "string"
2687 },
2688 "info": {
2689 "additionalProperties": {
2690 "description": "A string which maps to an array of value s.",
2691 "items": {
2692 "type": "string"
2693 },
2694 "type": "array"
2695 },
2696 "description": "A string which maps to an array of values.",
2697 "type": "object"
2698 },
2699 "name": {
2700 "description": "The read group set name. By default this wil l be initialized to the sample name of the sequenced data contained in this set. ",
2701 "type": "string"
2702 },
2703 "readGroups": {
2704 "description": "The read groups in this set. There are typic ally 1-10 read groups in a read group set.",
2705 "items": {
2706 "$ref": "ReadGroup"
2707 },
2708 "type": "array"
2709 },
2710 "referenceSetId": {
2711 "description": "The reference set the reads in this read gro up set are aligned to.",
2712 "type": "string"
2713 }
2714 },
2715 "type": "object"
2716 },
2717 "Reference": {
2718 "description": "A reference is a canonical assembled DNA sequence, i ntended to act as a reference coordinate space for other genomic annotations. A single reference might represent the human chromosome 1 or mitochandrial DNA, fo r instance. A reference belongs to one or more reference sets.",
2719 "id": "Reference",
2720 "properties": {
2721 "id": {
2722 "description": "The Google generated immutable ID of the ref erence.",
2723 "type": "string"
2724 },
2725 "length": {
2726 "description": "The length of this reference's sequence.",
2727 "format": "int64",
2728 "type": "string"
2729 },
2730 "md5checksum": {
2731 "description": "MD5 of the upper-case sequence excluding all whitespace characters (this is equivalent to SQ:M5 in SAM). This value is repre sented in lower case hexadecimal format.",
2732 "type": "string"
2733 },
2734 "name": {
2735 "description": "The name of this reference, for example 22." ,
2736 "type": "string"
2737 },
2738 "ncbiTaxonId": {
2739 "description": "ID from http://www.ncbi.nlm.nih.gov/taxonomy . For example, 9606 for human.",
2740 "format": "int32",
2741 "type": "integer"
2742 },
2743 "sourceAccessions": {
2744 "description": "All known corresponding accession IDs in INS DC (GenBank/ENA/DDBJ) ideally with a version number, for example GCF_000001405.2 6.",
2745 "items": {
2746 "type": "string"
2747 },
2748 "type": "array"
2749 },
2750 "sourceURI": {
2751 "description": "The URI from which the sequence was obtained . Typically specifies a FASTA format file.",
2752 "type": "string"
2753 }
2754 },
2755 "type": "object"
2756 },
2757 "ReferenceBound": {
2758 "description": "ReferenceBound records an upper bound for the starti ng coordinate of variants in a particular reference.",
2759 "id": "ReferenceBound",
2760 "properties": {
2761 "referenceName": {
2762 "description": "The name of the reference associated with th is reference bound.",
2763 "type": "string"
2764 },
2765 "upperBound": {
2766 "description": "An upper bound (inclusive) on the starting c oordinate of any variant in the reference sequence.",
2767 "format": "int64",
2768 "type": "string"
2769 }
2770 },
2771 "type": "object"
2772 },
2773 "ReferenceSet": {
2774 "description": "A reference set is a set of references which typical ly comprise a reference assembly for a species, such as GRCh38 which is represen tative of the human genome. A reference set defines a common coordinate space fo r comparing reference-aligned experimental data. A reference set contains 1 or m ore references.",
2775 "id": "ReferenceSet",
2776 "properties": {
2777 "assemblyId": {
2778 "description": "Public id of this reference set, such as GRC h37.",
2779 "type": "string"
2780 },
2781 "description": {
2782 "description": "Free text description of this reference set. ",
2783 "type": "string"
2784 },
2785 "id": {
2786 "description": "The Google generated immutable ID of the ref erence set.",
2787 "type": "string"
2788 },
2789 "md5checksum": {
2790 "description": "Order-independent MD5 checksum which identif ies this reference set. The checksum is computed by sorting all lower case hexid ecimal string reference.md5checksum (for all reference in this set) in ascending lexicographic order, concatenating, and taking the MD5 of that value. The resul ting value is represented in lower case hexadecimal format.",
2791 "type": "string"
2792 },
2793 "ncbiTaxonId": {
2794 "description": "ID from http://www.ncbi.nlm.nih.gov/taxonomy (for example, 9606 for human) indicating the species which this reference set i s intended to model. Note that contained references may specify a different ncbi TaxonId, as assemblies may contain reference sequences which do not belong to th e modeled species, for example EBV in a human reference genome.",
2795 "format": "int32",
2796 "type": "integer"
2797 },
2798 "referenceIds": {
2799 "description": "The IDs of the reference objects that are pa rt of this set. Reference.md5checksum must be unique within this set.",
2800 "items": {
2801 "type": "string"
2802 },
2803 "type": "array"
2804 },
2805 "sourceAccessions": {
2806 "description": "All known corresponding accession IDs in INS DC (GenBank/ENA/DDBJ) ideally with a version number, for example NC_000001.11.",
2807 "items": {
2808 "type": "string"
2809 },
2810 "type": "array"
2811 },
2812 "sourceURI": {
2813 "description": "The URI from which the references were obtai ned.",
2814 "type": "string"
2815 }
2816 },
2817 "type": "object"
2818 },
2819 "SearchAnnotationSetsRequest": {
2820 "id": "SearchAnnotationSetsRequest",
2821 "properties": {
2822 "datasetIds": {
2823 "description": "The dataset IDs to search within. Caller mus t have READ access to these datasets.",
2824 "items": {
2825 "type": "string"
2826 },
2827 "type": "array"
2828 },
2829 "name": {
2830 "description": "Only return annotations sets for which a sub string of the name matches this string (case insensitive).",
2831 "type": "string"
2832 },
2833 "pageSize": {
2834 "description": "The maximum number of results to return in a single page. If unspecified, defaults to 128. The maximum value is 1024.",
2835 "format": "int32",
2836 "type": "integer"
2837 },
2838 "pageToken": {
2839 "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.",
2840 "type": "string"
2841 },
2842 "referenceSetId": {
2843 "description": "If specified, only annotation sets associate d with the given reference set are returned.",
2844 "type": "string"
2845 },
2846 "types": {
2847 "description": "If specified, only annotation sets that have any of these types are returned.",
2848 "items": {
2849 "enum": [
2850 "GENE",
2851 "GENERIC",
2852 "TRANSCRIPT",
2853 "VARIANT"
2854 ],
2855 "enumDescriptions": [
2856 "",
2857 "",
2858 "",
2859 ""
2860 ],
2861 "type": "string"
2862 },
2863 "type": "array"
2864 }
2865 },
2866 "type": "object"
2867 },
2868 "SearchAnnotationSetsResponse": {
2869 "id": "SearchAnnotationSetsResponse",
2870 "properties": {
2871 "annotationSets": {
2872 "description": "The matching annotation sets.",
2873 "items": {
2874 "$ref": "AnnotationSet"
2875 },
2876 "type": "array"
2877 },
2878 "nextPageToken": {
2879 "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.",
2880 "type": "string"
2881 }
2882 },
2883 "type": "object"
2884 },
2885 "SearchAnnotationsRequest": {
2886 "id": "SearchAnnotationsRequest",
2887 "properties": {
2888 "annotationSetIds": {
2889 "description": "The annotation sets to search within. The ca ller must have READ access to these annotation sets. Required. All queried annot ation sets must have the same type.",
2890 "items": {
2891 "type": "string"
2892 },
2893 "type": "array"
2894 },
2895 "pageSize": {
2896 "description": "The maximum number of results to return in a single page. If unspecified, defaults to 256. The maximum value is 2048.",
2897 "format": "int32",
2898 "type": "integer"
2899 },
2900 "pageToken": {
2901 "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.",
2902 "type": "string"
2903 },
2904 "range": {
2905 "$ref": "QueryRange",
2906 "description": "If specified, this query matches only annota tions that overlap this range."
2907 }
2908 },
2909 "type": "object"
2910 },
2911 "SearchAnnotationsResponse": {
2912 "id": "SearchAnnotationsResponse",
2913 "properties": {
2914 "annotations": {
2915 "description": "The matching annotations.",
2916 "items": {
2917 "$ref": "Annotation"
2918 },
2919 "type": "array"
2920 },
2921 "nextPageToken": {
2922 "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.",
2923 "type": "string"
2924 }
2925 },
2926 "type": "object"
2927 },
2928 "SearchCallSetsRequest": {
2929 "description": "The call set search request.",
2930 "id": "SearchCallSetsRequest",
2931 "properties": {
2932 "name": {
2933 "description": "Only return call sets for which a substring of the name matches this string.",
2934 "type": "string"
2935 },
2936 "pageSize": {
2937 "description": "The maximum number of results to return in a single page. If unspecified, defaults to 1024.",
2938 "format": "int32",
2939 "type": "integer"
2940 },
2941 "pageToken": {
2942 "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.",
2943 "type": "string"
2944 },
2945 "variantSetIds": {
2946 "description": "Restrict the query to call sets within the g iven variant sets. At least one ID must be provided.",
2947 "items": {
2948 "type": "string"
2949 },
2950 "type": "array"
2951 }
2952 },
2953 "type": "object"
2954 },
2955 "SearchCallSetsResponse": {
2956 "description": "The call set search response.",
2957 "id": "SearchCallSetsResponse",
2958 "properties": {
2959 "callSets": {
2960 "description": "The list of matching call sets.",
2961 "items": {
2962 "$ref": "CallSet"
2963 },
2964 "type": "array"
2965 },
2966 "nextPageToken": {
2967 "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.",
2968 "type": "string"
2969 }
2970 },
2971 "type": "object"
2972 },
2973 "SearchJobsRequest": {
2974 "description": "The jobs search request.",
2975 "id": "SearchJobsRequest",
2976 "properties": {
2977 "createdAfter": {
2978 "description": "If specified, only jobs created on or after this date, given in milliseconds since Unix epoch, will be returned.",
2979 "format": "int64",
2980 "type": "string"
2981 },
2982 "createdBefore": {
2983 "description": "If specified, only jobs created prior to thi s date, given in milliseconds since Unix epoch, will be returned.",
2984 "format": "int64",
2985 "type": "string"
2986 },
2987 "pageSize": {
2988 "description": "The maximum number of results to return in a single page. If unspecified, defaults to 128. The maximum value is 256.",
2989 "format": "int32",
2990 "type": "integer"
2991 },
2992 "pageToken": {
2993 "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.",
2994 "type": "string"
2995 },
2996 "projectNumber": {
2997 "description": "Required. Only return jobs which belong to t his Google Developers Console project.",
2998 "format": "int64",
2999 "type": "string"
3000 },
3001 "status": {
3002 "description": "Only return jobs which have a matching statu s.",
3003 "items": {
3004 "enum": [
3005 "CANCELED",
3006 "FAILURE",
3007 "NEW",
3008 "PENDING",
3009 "RUNNING",
3010 "SUCCESS",
3011 "UNKNOWN_STATUS"
3012 ],
3013 "enumDescriptions": [
3014 "",
3015 "",
3016 "",
3017 "",
3018 "",
3019 "",
3020 ""
3021 ],
3022 "type": "string"
3023 },
3024 "type": "array"
3025 }
3026 },
3027 "type": "object"
3028 },
3029 "SearchJobsResponse": {
3030 "description": "The job search response.",
3031 "id": "SearchJobsResponse",
3032 "properties": {
3033 "jobs": {
3034 "description": "The list of jobs results, ordered newest to oldest.",
3035 "items": {
3036 "$ref": "Job"
3037 },
3038 "type": "array"
3039 },
3040 "nextPageToken": {
3041 "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 .",
3042 "type": "string"
3043 }
3044 },
3045 "type": "object"
3046 },
3047 "SearchReadGroupSetsRequest": {
3048 "description": "The read group set search request.",
3049 "id": "SearchReadGroupSetsRequest",
3050 "properties": {
3051 "datasetIds": {
3052 "description": "Restricts this query to read group sets with in the given datasets. At least one ID must be provided.",
3053 "items": {
3054 "type": "string"
3055 },
3056 "type": "array"
3057 },
3058 "name": {
3059 "description": "Only return read group sets for which a subs tring of the name matches this string.",
3060 "type": "string"
3061 },
3062 "pageSize": {
3063 "description": "The maximum number of results to return in a single page. If unspecified, defaults to 256. The maximum value is 1024.",
3064 "format": "int32",
3065 "type": "integer"
3066 },
3067 "pageToken": {
3068 "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.",
3069 "type": "string"
3070 }
3071 },
3072 "type": "object"
3073 },
3074 "SearchReadGroupSetsResponse": {
3075 "description": "The read group set search response.",
3076 "id": "SearchReadGroupSetsResponse",
3077 "properties": {
3078 "nextPageToken": {
3079 "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.",
3080 "type": "string"
3081 },
3082 "readGroupSets": {
3083 "description": "The list of matching read group sets.",
3084 "items": {
3085 "$ref": "ReadGroupSet"
3086 },
3087 "type": "array"
3088 }
3089 },
3090 "type": "object"
3091 },
3092 "SearchReadsRequest": {
3093 "description": "The read search request.",
3094 "id": "SearchReadsRequest",
3095 "properties": {
3096 "end": {
3097 "description": "The end position of the range on the referen ce, 0-based exclusive. If specified, referenceName must also be specified.",
3098 "format": "int64",
3099 "type": "string"
3100 },
3101 "pageSize": {
3102 "description": "The maximum number of results to return in a single page. If unspecified, defaults to 256. The maximum value is 2048.",
3103 "format": "int32",
3104 "type": "integer"
3105 },
3106 "pageToken": {
3107 "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.",
3108 "type": "string"
3109 },
3110 "readGroupIds": {
3111 "description": "The IDs of the read groups within which to s earch for reads. All specified read groups must belong to the same read group se ts. Must specify one of readGroupSetIds or readGroupIds.",
3112 "items": {
3113 "type": "string"
3114 },
3115 "type": "array"
3116 },
3117 "readGroupSetIds": {
3118 "description": "The IDs of the read groups sets within which to search for reads. All specified read group sets must be aligned against a co mmon set of reference sequences; this defines the genomic coordinates for the qu ery. Must specify one of readGroupSetIds or readGroupIds.",
3119 "items": {
3120 "type": "string"
3121 },
3122 "type": "array"
3123 },
3124 "referenceName": {
3125 "description": "The reference sequence name, for example chr 1, 1, or chrX. If set to *, only unmapped reads are returned. If unspecified, al l reads (mapped and unmapped) returned.",
3126 "type": "string"
3127 },
3128 "start": {
3129 "description": "The start position of the range on the refer ence, 0-based inclusive. If specified, referenceName must also be specified.",
3130 "format": "int64",
3131 "type": "string"
3132 }
3133 },
3134 "type": "object"
3135 },
3136 "SearchReadsResponse": {
3137 "description": "The read search response.",
3138 "id": "SearchReadsResponse",
3139 "properties": {
3140 "alignments": {
3141 "description": "The list of matching alignments sorted by ma pped genomic coordinate, if any, ascending in position within the same reference . Unmapped reads, which have no position, are returned contiguously and are sort ed in ascending lexicographic order by fragment name.",
3142 "items": {
3143 "$ref": "Read"
3144 },
3145 "type": "array"
3146 },
3147 "nextPageToken": {
3148 "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.",
3149 "type": "string"
3150 }
3151 },
3152 "type": "object"
3153 },
3154 "SearchReferenceSetsRequest": {
3155 "id": "SearchReferenceSetsRequest",
3156 "properties": {
3157 "accessions": {
3158 "description": "If present, return references for which the accession matches any of these strings. Best to give a version number, for examp le GCF_000001405.26. If only the main accession number is given then all records with that main accession will be returned, whichever version. Note that differe nt versions will have different sequences.",
3159 "items": {
3160 "type": "string"
3161 },
3162 "type": "array"
3163 },
3164 "assemblyId": {
3165 "description": "If present, return reference sets for which a substring of their assemblyId matches this string (case insensitive).",
3166 "type": "string"
3167 },
3168 "md5checksums": {
3169 "description": "If present, return references for which the md5checksum matches. See ReferenceSet.md5checksum for details.",
3170 "items": {
3171 "type": "string"
3172 },
3173 "type": "array"
3174 },
3175 "pageSize": {
3176 "description": "The maximum number of results to return in a single page. If unspecified, defaults to 1024. The maximum value is 4096.",
3177 "format": "int32",
3178 "type": "integer"
3179 },
3180 "pageToken": {
3181 "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.",
3182 "type": "string"
3183 }
3184 },
3185 "type": "object"
3186 },
3187 "SearchReferenceSetsResponse": {
3188 "id": "SearchReferenceSetsResponse",
3189 "properties": {
3190 "nextPageToken": {
3191 "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.",
3192 "type": "string"
3193 },
3194 "referenceSets": {
3195 "description": "The matching references sets.",
3196 "items": {
3197 "$ref": "ReferenceSet"
3198 },
3199 "type": "array"
3200 }
3201 },
3202 "type": "object"
3203 },
3204 "SearchReferencesRequest": {
3205 "id": "SearchReferencesRequest",
3206 "properties": {
3207 "accessions": {
3208 "description": "If present, return references for which the accession matches this string. Best to give a version number, for example GCF_00 0001405.26. If only the main accession number is given then all records with tha t main accession will be returned, whichever version. Note that different versio ns will have different sequences.",
3209 "items": {
3210 "type": "string"
3211 },
3212 "type": "array"
3213 },
3214 "md5checksums": {
3215 "description": "If present, return references for which the md5checksum matches. See Reference.md5checksum for construction details.",
3216 "items": {
3217 "type": "string"
3218 },
3219 "type": "array"
3220 },
3221 "pageSize": {
3222 "description": "The maximum number of results to return in a single page. If unspecified, defaults to 1024. The maximum value is 4096.",
3223 "format": "int32",
3224 "type": "integer"
3225 },
3226 "pageToken": {
3227 "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.",
3228 "type": "string"
3229 },
3230 "referenceSetId": {
3231 "description": "If present, return only references which bel ong to this reference set.",
3232 "type": "string"
3233 }
3234 },
3235 "type": "object"
3236 },
3237 "SearchReferencesResponse": {
3238 "id": "SearchReferencesResponse",
3239 "properties": {
3240 "nextPageToken": {
3241 "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.",
3242 "type": "string"
3243 },
3244 "references": {
3245 "description": "The matching references.",
3246 "items": {
3247 "$ref": "Reference"
3248 },
3249 "type": "array"
3250 }
3251 },
3252 "type": "object"
3253 },
3254 "SearchVariantSetsRequest": {
3255 "description": "The search variant sets request.",
3256 "id": "SearchVariantSetsRequest",
3257 "properties": {
3258 "datasetIds": {
3259 "description": "Exactly one dataset ID must be provided here . Only variant sets which belong to this dataset will be returned.",
3260 "items": {
3261 "type": "string"
3262 },
3263 "type": "array"
3264 },
3265 "pageSize": {
3266 "description": "The maximum number of results to return in a single page. If unspecified, defaults to 1024.",
3267 "format": "int32",
3268 "type": "integer"
3269 },
3270 "pageToken": {
3271 "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.",
3272 "type": "string"
3273 }
3274 },
3275 "type": "object"
3276 },
3277 "SearchVariantSetsResponse": {
3278 "description": "The search variant sets response.",
3279 "id": "SearchVariantSetsResponse",
3280 "properties": {
3281 "nextPageToken": {
3282 "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.",
3283 "type": "string"
3284 },
3285 "variantSets": {
3286 "description": "The variant sets belonging to the requested dataset.",
3287 "items": {
3288 "$ref": "VariantSet"
3289 },
3290 "type": "array"
3291 }
3292 },
3293 "type": "object"
3294 },
3295 "SearchVariantsRequest": {
3296 "description": "The variant search request.",
3297 "id": "SearchVariantsRequest",
3298 "properties": {
3299 "callSetIds": {
3300 "description": "Only return variant calls which belong to ca ll sets with these ids. Leaving this blank returns all variant calls. If a varia nt has no calls belonging to any of these call sets, it won't be returned at all .",
3301 "items": {
3302 "type": "string"
3303 },
3304 "type": "array"
3305 },
3306 "end": {
3307 "description": "The end of the window, 0-based exclusive. If unspecified or 0, defaults to the length of the reference.",
3308 "format": "int64",
3309 "type": "string"
3310 },
3311 "maxCalls": {
3312 "description": "The maximum number of calls to return in a s ingle page. Note that this limit may be exceeded in the event that a matching va riant contains more calls than the requested maximum. If unspecified, defaults t o 5000. The maximum value is 10000.",
3313 "format": "int32",
3314 "type": "integer"
3315 },
3316 "pageSize": {
3317 "description": "The maximum number of variants to return in a single page. If unspecified, defaults to 5000. The maximum value is 10000.",
3318 "format": "int32",
3319 "type": "integer"
3320 },
3321 "pageToken": {
3322 "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.",
3323 "type": "string"
3324 },
3325 "referenceName": {
3326 "description": "Required. Only return variants in this refer ence sequence.",
3327 "type": "string"
3328 },
3329 "start": {
3330 "description": "The beginning of the window (0-based, inclus ive) for which overlapping variants should be returned. If unspecified, defaults to 0.",
3331 "format": "int64",
3332 "type": "string"
3333 },
3334 "variantName": {
3335 "description": "Only return variants which have exactly this name.",
3336 "type": "string"
3337 },
3338 "variantSetIds": {
3339 "description": "At most one variant set ID must be provided. Only variants from this variant set will be returned. If omitted, a call set id must be included in the request. Both this and call_set_ids may be set.",
3340 "items": {
3341 "type": "string"
3342 },
3343 "type": "array"
3344 }
3345 },
3346 "type": "object"
3347 },
3348 "SearchVariantsResponse": {
3349 "description": "The variant search response.",
3350 "id": "SearchVariantsResponse",
3351 "properties": {
3352 "nextPageToken": {
3353 "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.",
3354 "type": "string"
3355 },
3356 "variants": {
3357 "description": "The list of matching Variants.",
3358 "items": {
3359 "$ref": "Variant"
3360 },
3361 "type": "array"
3362 }
3363 },
3364 "type": "object"
3365 },
3366 "Transcript": {
3367 "description": "A transcript represents the assertion that a particu lar region of the reference genome may be transcribed as RNA.",
3368 "id": "Transcript",
3369 "properties": {
3370 "codingSequence": {
3371 "$ref": "TranscriptCodingSequence",
3372 "description": "The range of the coding sequence for this tr anscript, if any. To determine the exact ranges of coding sequence, intersect th is range with those of the exons, if any. If there are any exons, the codingSequ ence must start and end within them.\n\nNote that in some cases, the reference g enome will not exactly match the observed mRNA transcript e.g. due to variance i n the source genome from reference. In these cases, exon.frame will not necessar ily match the expected reference reading frame and coding exon reference bases c annot necessarily be concatenated to produce the original transcript mRNA."
3373 },
3374 "exons": {
3375 "description": "The exons that compose this transcript. This field should be unset for genomes where transcript splicing does not occur, for example prokaryotes.\n\n\nIntrons are regions of the transcript that are not in cluded in the spliced RNA product. Though not explicitly modeled here, intron ra nges can be deduced; all regions of this transcript that are not exons are intro ns.\n\n\nExonic sequences do not necessarily code for a translational product (a mino acids). Only the regions of exons bounded by the codingSequence correspond to coding DNA sequence.\n\n\nExons are ordered by start position and may not ove rlap.",
3376 "items": {
3377 "$ref": "TranscriptExon"
3378 },
3379 "type": "array"
3380 },
3381 "geneId": {
3382 "description": "The annotation ID of the gene from which thi s transcript is transcribed.",
3383 "type": "string"
3384 }
3385 },
3386 "type": "object"
3387 },
3388 "TranscriptCodingSequence": {
3389 "id": "TranscriptCodingSequence",
3390 "properties": {
3391 "end": {
3392 "description": "The end of the coding sequence on this annot ation's reference sequence, 0-based exclusive. Note that this position is relati ve to the reference start, and not the containing annotation start.",
3393 "format": "int64",
3394 "type": "string"
3395 },
3396 "start": {
3397 "description": "The start of the coding sequence on this ann otation's reference sequence, 0-based inclusive. Note that this position is rela tive to the reference start, and not the containing annotation start.",
3398 "format": "int64",
3399 "type": "string"
3400 }
3401 },
3402 "type": "object"
3403 },
3404 "TranscriptExon": {
3405 "id": "TranscriptExon",
3406 "properties": {
3407 "end": {
3408 "description": "The end position of the exon on this annotat ion's reference sequence, 0-based exclusive. Note that this is relative to the r eference start, and not the containing annotation start.",
3409 "format": "int64",
3410 "type": "string"
3411 },
3412 "frame": {
3413 "$ref": "Int32Value",
3414 "description": "The frame of this exon. Contains a value of 0, 1, or 2, which indicates the offset of the first coding base of the exon with in the reading frame of the coding DNA sequence, if any. This field is dependent on the strandedness of this annotation (see Annotation.position.reverseStrand). For forward stranded annotations, this offset is relative to the exon.start. Fo r reverse strand annotations, this offset is relative to the exon.end-1.\n\nUnse t if this exon does not intersect the coding sequence. Upon creation of a transc ript, the frame must be populated for all or none of the coding exons."
3415 },
3416 "start": {
3417 "description": "The start position of the exon on this annot ation's reference sequence, 0-based inclusive. Note that this is relative to the reference start, and not the containing annotation start.",
3418 "format": "int64",
3419 "type": "string"
3420 }
3421 },
3422 "type": "object"
3423 },
3424 "Variant": {
3425 "description": "A variant represents a change in DNA sequence relati ve to a reference sequence. For example, a variant could represent a SNP or an i nsertion. Variants belong to a variant set. Each of the calls on a variant repre sent a determination of genotype with respect to that variant. For example, a ca ll might assign probability of 0.32 to the occurrence of a SNP named rs1234 in a sample named NA12345. A call belongs to a call set, which contains related call s typically from one sample.",
3426 "id": "Variant",
3427 "properties": {
3428 "alternateBases": {
3429 "description": "The bases that appear instead of the referen ce bases.",
3430 "items": {
3431 "type": "string"
3432 },
3433 "type": "array"
3434 },
3435 "calls": {
3436 "description": "The variant calls for this particular varian t. Each one represents the determination of genotype with respect to this varian t.",
3437 "items": {
3438 "$ref": "Call"
3439 },
3440 "type": "array"
3441 },
3442 "created": {
3443 "description": "The date this variant was created, in millis econds from the epoch.",
3444 "format": "int64",
3445 "type": "string"
3446 },
3447 "end": {
3448 "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 - start). This is useful for vari ants that don't explicitly give alternate bases, for example large deletions.",
3449 "format": "int64",
3450 "type": "string"
3451 },
3452 "filter": {
3453 "description": "A list of filters (normally quality filters) this variant has failed. PASS indicates this variant has passed all filters.",
3454 "items": {
3455 "type": "string"
3456 },
3457 "type": "array"
3458 },
3459 "id": {
3460 "description": "The Google generated ID of the variant, immu table.",
3461 "type": "string"
3462 },
3463 "info": {
3464 "additionalProperties": {
3465 "description": "A string which maps to an array of value s.",
3466 "items": {
3467 "type": "string"
3468 },
3469 "type": "array"
3470 },
3471 "description": "A string which maps to an array of values.",
3472 "type": "object"
3473 },
3474 "names": {
3475 "description": "Names for the variant, for example a RefSNP ID.",
3476 "items": {
3477 "type": "string"
3478 },
3479 "type": "array"
3480 },
3481 "quality": {
3482 "description": "A measure of how likely this variant is to b e real. A higher value is better.",
3483 "format": "double",
3484 "type": "number"
3485 },
3486 "referenceBases": {
3487 "description": "The reference bases for this variant. They s tart at the given position.",
3488 "type": "string"
3489 },
3490 "referenceName": {
3491 "description": "The reference on which this variant occurs. (such as chr20 or X)",
3492 "type": "string"
3493 },
3494 "start": {
3495 "description": "The position at which this variant occurs (0 -based). This corresponds to the first base of the string of reference bases.",
3496 "format": "int64",
3497 "type": "string"
3498 },
3499 "variantSetId": {
3500 "description": "The ID of the variant set this variant belon gs to.",
3501 "type": "string"
3502 }
3503 },
3504 "type": "object"
3505 },
3506 "VariantAnnotation": {
3507 "description": "A Variant annotation.",
3508 "id": "VariantAnnotation",
3509 "properties": {
3510 "alternateBases": {
3511 "description": "The alternate allele for this variant. If mu ltiple alternate alleles exist at this location, create a separate variant for e ach one, as they may represent distinct conditions.",
3512 "type": "string"
3513 },
3514 "clinicalSignificance": {
3515 "description": "Describes the clinical significance of a var iant. It is adapted from the ClinVar controlled vocabulary for clinical signific ance described at: http://www.ncbi.nlm.nih.gov/clinvar/docs/clinsig/",
3516 "enum": [
3517 "ASSOCIATION",
3518 "BENIGN",
3519 "CLINICAL_SIGNIFICANCE_UNSPECIFIED",
3520 "CONFERS_SENSITIVITY",
3521 "DRUG_RESPONSE",
3522 "HISTOCOMPATIBILITY",
3523 "LIKELY_BENIGN",
3524 "LIKELY_PATHOGENIC",
3525 "MULTIPLE_REPORTED",
3526 "OTHER",
3527 "PATHOGENIC",
3528 "PROTECTIVE",
3529 "RISK_FACTOR",
3530 "UNCERTAIN"
3531 ],
3532 "enumDescriptions": [
3533 "",
3534 "",
3535 "",
3536 "",
3537 "",
3538 "",
3539 "",
3540 "",
3541 "",
3542 "",
3543 "",
3544 "",
3545 "",
3546 ""
3547 ],
3548 "type": "string"
3549 },
3550 "conditions": {
3551 "description": "The set of conditions associated with this v ariant. A condition describes the way a variant influences human health.",
3552 "items": {
3553 "$ref": "VariantAnnotationCondition"
3554 },
3555 "type": "array"
3556 },
3557 "effect": {
3558 "description": "Effect of the variant on the coding sequence .",
3559 "enum": [
3560 "EFFECT_UNSPECIFIED",
3561 "FRAMESHIFT",
3562 "FRAME_PRESERVING_INDEL",
3563 "NONSYNONYMOUS_SNP",
3564 "OTHER",
3565 "SPLICE_SITE_DISRUPTION",
3566 "STOP_GAIN",
3567 "STOP_LOSS",
3568 "SYNONYMOUS_SNP"
3569 ],
3570 "enumDescriptions": [
3571 "",
3572 "",
3573 "",
3574 "",
3575 "",
3576 "",
3577 "",
3578 "",
3579 ""
3580 ],
3581 "type": "string"
3582 },
3583 "geneId": {
3584 "description": "Google annotation ID of the gene affected by this variant. This should be provided when the variant is created.",
3585 "type": "string"
3586 },
3587 "transcriptIds": {
3588 "description": "Google annotation IDs of the transcripts aff ected by this variant. These should be provided when the variant is created.",
3589 "items": {
3590 "type": "string"
3591 },
3592 "type": "array"
3593 },
3594 "type": {
3595 "description": "Type has been adapted from ClinVar's list of variant types.",
3596 "enum": [
3597 "CNV",
3598 "DELETION",
3599 "INSERTION",
3600 "OTHER",
3601 "SNP",
3602 "STRUCTURAL",
3603 "SUBSTITUTION",
3604 "TYPE_UNSPECIFIED"
3605 ],
3606 "enumDescriptions": [
3607 "",
3608 "",
3609 "",
3610 "",
3611 "",
3612 "",
3613 "",
3614 ""
3615 ],
3616 "type": "string"
3617 }
3618 },
3619 "type": "object"
3620 },
3621 "VariantAnnotationCondition": {
3622 "id": "VariantAnnotationCondition",
3623 "properties": {
3624 "conceptId": {
3625 "description": "The MedGen concept id associated with this g ene. Search for these IDs at http://www.ncbi.nlm.nih.gov/medgen/",
3626 "type": "string"
3627 },
3628 "externalIds": {
3629 "description": "The set of external IDs for this condition." ,
3630 "items": {
3631 "$ref": "ExternalId"
3632 },
3633 "type": "array"
3634 },
3635 "names": {
3636 "description": "A set of names for the condition.",
3637 "items": {
3638 "type": "string"
3639 },
3640 "type": "array"
3641 },
3642 "omimId": {
3643 "description": "The OMIM id for this condition. Search for t hese IDs at http://omim.org/",
3644 "type": "string"
3645 }
3646 },
3647 "type": "object"
3648 },
3649 "VariantSet": {
3650 "description": "A variant set is a collection of call sets and varia nts. It contains summary statistics of those contents. A variant set belongs to a dataset.",
3651 "id": "VariantSet",
3652 "properties": {
3653 "datasetId": {
3654 "description": "The dataset to which this variant set belong s. Immutable.",
3655 "type": "string"
3656 },
3657 "description": {
3658 "description": "A textual description of this variant set.",
3659 "type": "string"
3660 },
3661 "id": {
3662 "description": "The Google-generated ID of the variant set. Immutable.",
3663 "type": "string"
3664 },
3665 "metadata": {
3666 "description": "The metadata associated with this variant se t.",
3667 "items": {
3668 "$ref": "Metadata"
3669 },
3670 "type": "array"
3671 },
3672 "name": {
3673 "description": "User-specified, mutable name.",
3674 "type": "string"
3675 },
3676 "referenceBounds": {
3677 "description": "A list of all references used by the variant s in a variant set with associated coordinate upper bounds for each one.",
3678 "items": {
3679 "$ref": "ReferenceBound"
3680 },
3681 "type": "array"
3682 },
3683 "referenceSetId": {
3684 "description": "The reference set to which the variant set i s mapped. The reference set describes the alignment provenance of the variant se t, while the referenceBounds describe the shape of the actual variant data. The reference set's reference names are a superset of those found in the referenceBo unds.\n\nFor example, given a variant set that is mapped to the GRCh38 reference set and contains a single variant on reference 'X', referenceBounds would conta in only an entry for 'X', while the associated reference set enumerates all poss ible references: '1', '2', 'X', 'Y', 'MT', etc.",
3685 "type": "string"
3686 }
3687 },
3688 "type": "object"
3689 }
3690 },
3691 "servicePath": "genomics/v1beta2/",
3692 "title": "Genomics API",
3693 "version": "v1beta2"
3694 }
OLDNEW
« no previous file with comments | « discovery/googleapis_beta/dns__v2beta1.json ('k') | discovery/googleapis_beta/language__v1beta1.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698