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

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

Issue 698403003: Api roll 5: 2014-11-05 (Closed) Base URL: git@github.com:dart-lang/googleapis.git@master
Patch Set: Created 6 years, 1 month 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
OLDNEW
1 { 1 {
2 "auth": { 2 "auth": {
3 "oauth2": { 3 "oauth2": {
4 "scopes": { 4 "scopes": {
5 "https://www.googleapis.com/auth/bigquery": { 5 "https://www.googleapis.com/auth/bigquery": {
6 "description": "View and manage your data in Google BigQuery " 6 "description": "View and manage your data in Google BigQuery "
7 }, 7 },
8 "https://www.googleapis.com/auth/devstorage.read_write": { 8 "https://www.googleapis.com/auth/devstorage.read_write": {
9 "description": "Manage your data in Google Cloud Storage" 9 "description": "Manage your data in Google Cloud Storage"
10 }, 10 },
11 "https://www.googleapis.com/auth/genomics": { 11 "https://www.googleapis.com/auth/genomics": {
12 "description": "View and manage Genomics data" 12 "description": "View and manage Genomics data"
13 }, 13 },
14 "https://www.googleapis.com/auth/genomics.readonly": { 14 "https://www.googleapis.com/auth/genomics.readonly": {
15 "description": "View Genomics data" 15 "description": "View Genomics data"
16 } 16 }
17 } 17 }
18 } 18 }
19 }, 19 },
20 "basePath": "/genomics/v1beta/", 20 "basePath": "/genomics/v1beta2/",
21 "baseUrl": "https://www.googleapis.com/genomics/v1beta/", 21 "baseUrl": "https://www.googleapis.com/genomics/v1beta2/",
22 "batchPath": "batch", 22 "batchPath": "batch",
23 "description": "Provides access to Genomics data.", 23 "description": "Provides access to Genomics data.",
24 "discoveryVersion": "v1", 24 "discoveryVersion": "v1",
25 "documentationLink": "https://developers.google.com/genomics/v1beta/referenc e", 25 "documentationLink": "https://developers.google.com/genomics/v1beta2/referen ce",
26 "etag": "\"l66ggWbucbkBw9Lpos72oziyefE/QFkFkv2LMi0ob1p4dyYfQYJIVYc\"", 26 "etag": "\"l66ggWbucbkBw9Lpos72oziyefE/EKP2HqTiCFaMtGY4TKqgoDAIFBQ\"",
27 "icons": { 27 "icons": {
28 "x16": "http://www.google.com/images/icons/product/search-16.gif", 28 "x16": "http://www.google.com/images/icons/product/search-16.gif",
29 "x32": "http://www.google.com/images/icons/product/search-32.gif" 29 "x32": "http://www.google.com/images/icons/product/search-32.gif"
30 }, 30 },
31 "id": "genomics:v1beta", 31 "id": "genomics:v1beta2",
32 "kind": "discovery#restDescription", 32 "kind": "discovery#restDescription",
33 "name": "genomics", 33 "name": "genomics",
34 "ownerDomain": "google.com", 34 "ownerDomain": "google.com",
35 "ownerName": "Google", 35 "ownerName": "Google",
36 "parameters": { 36 "parameters": {
37 "alt": { 37 "alt": {
38 "default": "json", 38 "default": "json",
39 "description": "Data format for the response.", 39 "description": "Data format for the response.",
40 "enum": [ 40 "enum": [
41 "json" 41 "json"
(...skipping 31 matching lines...) Expand 10 before | Expand all | Expand 10 after
73 "type": "string" 73 "type": "string"
74 }, 74 },
75 "userIp": { 75 "userIp": {
76 "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", 76 "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
77 "location": "query", 77 "location": "query",
78 "type": "string" 78 "type": "string"
79 } 79 }
80 }, 80 },
81 "protocol": "rest", 81 "protocol": "rest",
82 "resources": { 82 "resources": {
83 "beacons": {
84 "methods": {
85 "get": {
86 "description": "This is an experimental API that provides a Global Alliance for Genomics and Health Beacon. It may change at any time.",
87 "httpMethod": "GET",
88 "id": "genomics.beacons.get",
89 "parameterOrder": [
90 "variantSetId"
91 ],
92 "parameters": {
93 "allele": {
94 "description": "Required. The allele to look for ('A ', 'C', 'G' or 'T').",
95 "location": "query",
96 "type": "string"
97 },
98 "position": {
99 "description": "Required. The 0-based position to qu ery.",
100 "format": "int64",
101 "location": "query",
102 "type": "string"
103 },
104 "referenceName": {
105 "description": "Required. The reference to query ove r.",
106 "location": "query",
107 "type": "string"
108 },
109 "variantSetId": {
110 "description": "The ID of the variant set to query o ver. It must be public. Private variant sets will return an unauthorized excepti on.",
111 "location": "path",
112 "required": true,
113 "type": "string"
114 }
115 },
116 "path": "beacons/{variantSetId}",
117 "response": {
118 "$ref": "Beacon"
119 }
120 }
121 }
122 },
123 "callsets": { 83 "callsets": {
124 "methods": { 84 "methods": {
125 "create": { 85 "create": {
126 "description": "Creates a new call set.", 86 "description": "Creates a new call set.",
127 "httpMethod": "POST", 87 "httpMethod": "POST",
128 "id": "genomics.callsets.create", 88 "id": "genomics.callsets.create",
129 "path": "callsets", 89 "path": "callsets",
130 "request": { 90 "request": {
131 "$ref": "CallSet" 91 "$ref": "CallSet"
132 }, 92 },
133 "response": { 93 "response": {
134 "$ref": "CallSet" 94 "$ref": "CallSet"
135 }, 95 },
136 "scopes": [ 96 "scopes": [
137 "https://www.googleapis.com/auth/genomics" 97 "https://www.googleapis.com/auth/genomics"
138 ] 98 ]
139 }, 99 },
140 "delete": { 100 "delete": {
141 "description": "Deletes a call set.", 101 "description": "Deletes a call set.",
142 "httpMethod": "DELETE", 102 "httpMethod": "DELETE",
143 "id": "genomics.callsets.delete", 103 "id": "genomics.callsets.delete",
144 "parameterOrder": [ 104 "parameterOrder": [
145 "callSetId" 105 "callSetId"
146 ], 106 ],
147 "parameters": { 107 "parameters": {
148 "callSetId": { 108 "callSetId": {
149 "description": "The ID of the callset to be deleted. ", 109 "description": "The ID of the call set to be deleted .",
150 "location": "path", 110 "location": "path",
151 "required": true, 111 "required": true,
152 "type": "string" 112 "type": "string"
153 } 113 }
154 }, 114 },
155 "path": "callsets/{callSetId}", 115 "path": "callsets/{callSetId}",
156 "scopes": [ 116 "scopes": [
157 "https://www.googleapis.com/auth/genomics" 117 "https://www.googleapis.com/auth/genomics"
158 ] 118 ]
159 }, 119 },
160 "get": { 120 "get": {
161 "description": "Gets a call set by ID.", 121 "description": "Gets a call set by ID.",
162 "httpMethod": "GET", 122 "httpMethod": "GET",
163 "id": "genomics.callsets.get", 123 "id": "genomics.callsets.get",
164 "parameterOrder": [ 124 "parameterOrder": [
165 "callSetId" 125 "callSetId"
166 ], 126 ],
167 "parameters": { 127 "parameters": {
168 "callSetId": { 128 "callSetId": {
169 "description": "The ID of the callset.", 129 "description": "The ID of the call set.",
170 "location": "path", 130 "location": "path",
171 "required": true, 131 "required": true,
172 "type": "string" 132 "type": "string"
173 } 133 }
174 }, 134 },
175 "path": "callsets/{callSetId}", 135 "path": "callsets/{callSetId}",
176 "response": { 136 "response": {
177 "$ref": "CallSet" 137 "$ref": "CallSet"
178 }, 138 },
179 "scopes": [ 139 "scopes": [
180 "https://www.googleapis.com/auth/genomics", 140 "https://www.googleapis.com/auth/genomics",
181 "https://www.googleapis.com/auth/genomics.readonly" 141 "https://www.googleapis.com/auth/genomics.readonly"
182 ] 142 ]
183 }, 143 },
184 "patch": { 144 "patch": {
185 "description": "Updates a call set. This method supports pat ch semantics.", 145 "description": "Updates a call set. This method supports pat ch semantics.",
186 "httpMethod": "PATCH", 146 "httpMethod": "PATCH",
187 "id": "genomics.callsets.patch", 147 "id": "genomics.callsets.patch",
188 "parameterOrder": [ 148 "parameterOrder": [
189 "callSetId" 149 "callSetId"
190 ], 150 ],
191 "parameters": { 151 "parameters": {
192 "callSetId": { 152 "callSetId": {
193 "description": "The ID of the callset to be updated. ", 153 "description": "The ID of the call set to be updated .",
194 "location": "path", 154 "location": "path",
195 "required": true, 155 "required": true,
196 "type": "string" 156 "type": "string"
197 } 157 }
198 }, 158 },
199 "path": "callsets/{callSetId}", 159 "path": "callsets/{callSetId}",
200 "request": { 160 "request": {
201 "$ref": "CallSet" 161 "$ref": "CallSet"
202 }, 162 },
203 "response": { 163 "response": {
204 "$ref": "CallSet" 164 "$ref": "CallSet"
205 }, 165 },
206 "scopes": [ 166 "scopes": [
207 "https://www.googleapis.com/auth/genomics" 167 "https://www.googleapis.com/auth/genomics"
208 ] 168 ]
209 }, 169 },
210 "search": { 170 "search": {
211 "description": "Gets a list of call sets matching the criter ia.", 171 "description": "Gets a list of call sets matching the criter ia.\n\nImplements GlobalAllianceApi.searchCallSets.",
212 "httpMethod": "POST", 172 "httpMethod": "POST",
213 "id": "genomics.callsets.search", 173 "id": "genomics.callsets.search",
214 "path": "callsets/search", 174 "path": "callsets/search",
215 "request": { 175 "request": {
216 "$ref": "SearchCallSetsRequest" 176 "$ref": "SearchCallSetsRequest"
217 }, 177 },
218 "response": { 178 "response": {
219 "$ref": "SearchCallSetsResponse" 179 "$ref": "SearchCallSetsResponse"
220 }, 180 },
221 "scopes": [ 181 "scopes": [
222 "https://www.googleapis.com/auth/genomics", 182 "https://www.googleapis.com/auth/genomics",
223 "https://www.googleapis.com/auth/genomics.readonly" 183 "https://www.googleapis.com/auth/genomics.readonly"
224 ] 184 ]
225 }, 185 },
226 "update": { 186 "update": {
227 "description": "Updates a call set.", 187 "description": "Updates a call set.",
228 "httpMethod": "PUT", 188 "httpMethod": "PUT",
229 "id": "genomics.callsets.update", 189 "id": "genomics.callsets.update",
230 "parameterOrder": [ 190 "parameterOrder": [
231 "callSetId" 191 "callSetId"
232 ], 192 ],
233 "parameters": { 193 "parameters": {
234 "callSetId": { 194 "callSetId": {
235 "description": "The ID of the callset to be updated. ", 195 "description": "The ID of the call set to be updated .",
236 "location": "path", 196 "location": "path",
237 "required": true, 197 "required": true,
238 "type": "string" 198 "type": "string"
239 } 199 }
240 }, 200 },
241 "path": "callsets/{callSetId}", 201 "path": "callsets/{callSetId}",
242 "request": { 202 "request": {
243 "$ref": "CallSet" 203 "$ref": "CallSet"
244 }, 204 },
245 "response": { 205 "response": {
(...skipping 64 matching lines...) Expand 10 before | Expand all | Expand 10 after
310 "scopes": [ 270 "scopes": [
311 "https://www.googleapis.com/auth/genomics", 271 "https://www.googleapis.com/auth/genomics",
312 "https://www.googleapis.com/auth/genomics.readonly" 272 "https://www.googleapis.com/auth/genomics.readonly"
313 ] 273 ]
314 }, 274 },
315 "list": { 275 "list": {
316 "description": "Lists all datasets.", 276 "description": "Lists all datasets.",
317 "httpMethod": "GET", 277 "httpMethod": "GET",
318 "id": "genomics.datasets.list", 278 "id": "genomics.datasets.list",
319 "parameters": { 279 "parameters": {
320 "maxResults": { 280 "pageSize": {
321 "default": "50", 281 "default": "50",
322 "description": "The maximum number of results return ed by this request.", 282 "description": "The maximum number of results return ed by this request.",
323 "format": "uint64", 283 "format": "int32",
324 "location": "query", 284 "location": "query",
325 "type": "string" 285 "type": "integer"
326 }, 286 },
327 "pageToken": { 287 "pageToken": {
328 "description": "The continuation token, which is use d to page through large result sets. To get the next page of results, set this p arameter to the value of nextPageToken from the previous response.", 288 "description": "The continuation token, which is use d to page through large result sets. To get the next page of results, set this p arameter to the value of nextPageToken from the previous response.",
329 "location": "query", 289 "location": "query",
330 "type": "string" 290 "type": "string"
331 }, 291 },
332 "projectId": { 292 "projectNumber": {
333 "description": "Only return datasets which belong to this Google Developers Console project. Only accepts project numbers. Returns a ll public projects if no project number is specified.", 293 "description": "Only return datasets which belong to this Google Developers Console project. Only accepts project numbers. Returns a ll public projects if no project number is specified.",
334 "format": "int64", 294 "format": "int64",
335 "location": "query", 295 "location": "query",
336 "type": "string" 296 "type": "string"
337 } 297 }
338 }, 298 },
339 "path": "datasets", 299 "path": "datasets",
340 "response": { 300 "response": {
341 "$ref": "ListDatasetsResponse" 301 "$ref": "ListDatasetsResponse"
342 }, 302 },
(...skipping 160 matching lines...) Expand 10 before | Expand all | Expand 10 after
503 "response": { 463 "response": {
504 "$ref": "SearchJobsResponse" 464 "$ref": "SearchJobsResponse"
505 }, 465 },
506 "scopes": [ 466 "scopes": [
507 "https://www.googleapis.com/auth/genomics", 467 "https://www.googleapis.com/auth/genomics",
508 "https://www.googleapis.com/auth/genomics.readonly" 468 "https://www.googleapis.com/auth/genomics.readonly"
509 ] 469 ]
510 } 470 }
511 } 471 }
512 }, 472 },
513 "reads": { 473 "readgroupsets": {
514 "methods": { 474 "methods": {
515 "search": { 475 "align": {
516 "description": "Gets a list of reads for one or more readset s. Reads search operates over a genomic coordinate space of reference sequence & position defined over the reference sequences to which the requested readsets a re aligned. If a target positional range is specified, search returns all reads whose alignment to the reference genome overlap the range. A query which specifi es only readset IDs yields all reads in those readsets, including unmapped reads . All reads returned (including reads on subsequent pages) are ordered by genomi c coordinate (reference sequence & position). Reads with equivalent genomic coor dinates are returned in a deterministic order.", 476 "description": "Aligns read data from existing read group se ts or files from Google Cloud Storage. See the alignment and variant calling do cumentation for more details.",
517 "httpMethod": "POST", 477 "httpMethod": "POST",
518 "id": "genomics.reads.search", 478 "id": "genomics.readgroupsets.align",
519 "path": "reads/search", 479 "path": "readgroupsets/align",
520 "request": { 480 "request": {
521 "$ref": "SearchReadsRequest" 481 "$ref": "AlignReadGroupSetsRequest"
522 }, 482 },
523 "response": { 483 "response": {
524 "$ref": "SearchReadsResponse" 484 "$ref": "AlignReadGroupSetsResponse"
525 }, 485 },
526 "scopes": [ 486 "scopes": [
527 "https://www.googleapis.com/auth/genomics", 487 "https://www.googleapis.com/auth/genomics"
528 "https://www.googleapis.com/auth/genomics.readonly"
529 ] 488 ]
530 } 489 },
531 } 490 "call": {
532 }, 491 "description": "Calls variants on read data from existing re ad group sets or files from Google Cloud Storage. See the alignment and variant calling documentation for more details.",
533 "readsets": { 492 "httpMethod": "POST",
534 "methods": { 493 "id": "genomics.readgroupsets.call",
494 "path": "readgroupsets/call",
495 "request": {
496 "$ref": "CallReadGroupSetsRequest"
497 },
498 "response": {
499 "$ref": "CallReadGroupSetsResponse"
500 },
501 "scopes": [
502 "https://www.googleapis.com/auth/genomics"
503 ]
504 },
535 "delete": { 505 "delete": {
536 "description": "Deletes a readset.", 506 "description": "Deletes a read group set.",
537 "httpMethod": "DELETE", 507 "httpMethod": "DELETE",
538 "id": "genomics.readsets.delete", 508 "id": "genomics.readgroupsets.delete",
539 "parameterOrder": [ 509 "parameterOrder": [
540 "readsetId" 510 "readGroupSetId"
541 ], 511 ],
542 "parameters": { 512 "parameters": {
543 "readsetId": { 513 "readGroupSetId": {
544 "description": "The ID of the readset to be deleted. The caller must have WRITE permissions to the dataset associated with this read set.", 514 "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.",
545 "location": "path", 515 "location": "path",
546 "required": true, 516 "required": true,
547 "type": "string" 517 "type": "string"
548 } 518 }
549 }, 519 },
550 "path": "readsets/{readsetId}", 520 "path": "readgroupsets/{readGroupSetId}",
551 "scopes": [ 521 "scopes": [
552 "https://www.googleapis.com/auth/genomics" 522 "https://www.googleapis.com/auth/genomics"
553 ] 523 ]
554 }, 524 },
555 "export": { 525 "export": {
556 "description": "Exports readsets to a BAM file in Google Clo ud Storage. Note that currently there may be some differences between exported B AM files and the original BAM file at the time of import. In particular, comment s in the input file header will not be preserved, and some custom tags will be c onverted to strings.", 526 "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. In particula r, comments in the input file header will not be preserved, and some custom tags will be converted to strings.",
557 "httpMethod": "POST", 527 "httpMethod": "POST",
558 "id": "genomics.readsets.export", 528 "id": "genomics.readgroupsets.export",
559 "path": "readsets/export", 529 "path": "readgroupsets/export",
560 "request": { 530 "request": {
561 "$ref": "ExportReadsetsRequest" 531 "$ref": "ExportReadGroupSetsRequest"
562 }, 532 },
563 "response": { 533 "response": {
564 "$ref": "ExportReadsetsResponse" 534 "$ref": "ExportReadGroupSetsResponse"
565 }, 535 },
566 "scopes": [ 536 "scopes": [
567 "https://www.googleapis.com/auth/devstorage.read_write", 537 "https://www.googleapis.com/auth/devstorage.read_write",
568 "https://www.googleapis.com/auth/genomics" 538 "https://www.googleapis.com/auth/genomics"
569 ] 539 ]
570 }, 540 },
571 "get": { 541 "get": {
572 "description": "Gets a readset by ID.", 542 "description": "Gets a read group set by ID.",
573 "httpMethod": "GET", 543 "httpMethod": "GET",
574 "id": "genomics.readsets.get", 544 "id": "genomics.readgroupsets.get",
575 "parameterOrder": [ 545 "parameterOrder": [
576 "readsetId" 546 "readGroupSetId"
577 ], 547 ],
578 "parameters": { 548 "parameters": {
579 "readsetId": { 549 "readGroupSetId": {
580 "description": "The ID of the readset.", 550 "description": "The ID of the read group set.",
581 "location": "path", 551 "location": "path",
582 "required": true, 552 "required": true,
583 "type": "string" 553 "type": "string"
584 } 554 }
585 }, 555 },
586 "path": "readsets/{readsetId}", 556 "path": "readgroupsets/{readGroupSetId}",
587 "response": { 557 "response": {
588 "$ref": "Readset" 558 "$ref": "ReadGroupSet"
589 }, 559 },
590 "scopes": [ 560 "scopes": [
591 "https://www.googleapis.com/auth/genomics", 561 "https://www.googleapis.com/auth/genomics",
592 "https://www.googleapis.com/auth/genomics.readonly" 562 "https://www.googleapis.com/auth/genomics.readonly"
593 ] 563 ]
594 }, 564 },
595 "import": { 565 "import": {
596 "description": "Creates readsets by asynchronously importing the provided information. Note that currently comments in the input file header are not imported and some custom tags will be converted to strings, rather than preserving tag types. The caller must have WRITE permissions to the dataset.", 566 "description": "Creates read group sets by asynchronously im porting the provided information.\n\nNote that currently comments in the input f ile header are not imported and some custom tags will be converted to strings, r ather than preserving tag types. The caller must have WRITE permissions to the d ataset.",
597 "httpMethod": "POST", 567 "httpMethod": "POST",
598 "id": "genomics.readsets.import", 568 "id": "genomics.readgroupsets.import",
599 "path": "readsets/import", 569 "path": "readgroupsets/import",
600 "request": { 570 "request": {
601 "$ref": "ImportReadsetsRequest" 571 "$ref": "ImportReadGroupSetsRequest"
602 }, 572 },
603 "response": { 573 "response": {
604 "$ref": "ImportReadsetsResponse" 574 "$ref": "ImportReadGroupSetsResponse"
605 }, 575 },
606 "scopes": [ 576 "scopes": [
607 "https://www.googleapis.com/auth/devstorage.read_write", 577 "https://www.googleapis.com/auth/devstorage.read_write",
608 "https://www.googleapis.com/auth/genomics" 578 "https://www.googleapis.com/auth/genomics"
609 ] 579 ]
610 }, 580 },
611 "patch": { 581 "patch": {
612 "description": "Updates a readset. This method supports patc h semantics.", 582 "description": "Updates a read group set. This method suppor ts patch semantics.",
613 "httpMethod": "PATCH", 583 "httpMethod": "PATCH",
614 "id": "genomics.readsets.patch", 584 "id": "genomics.readgroupsets.patch",
615 "parameterOrder": [ 585 "parameterOrder": [
616 "readsetId" 586 "readGroupSetId"
617 ], 587 ],
618 "parameters": { 588 "parameters": {
619 "readsetId": { 589 "readGroupSetId": {
620 "description": "The ID of the readset to be updated. The caller must have WRITE permissions to the dataset associated with this read set.", 590 "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.",
621 "location": "path", 591 "location": "path",
622 "required": true, 592 "required": true,
623 "type": "string" 593 "type": "string"
624 } 594 }
625 }, 595 },
626 "path": "readsets/{readsetId}", 596 "path": "readgroupsets/{readGroupSetId}",
627 "request": { 597 "request": {
628 "$ref": "Readset" 598 "$ref": "ReadGroupSet"
629 }, 599 },
630 "response": { 600 "response": {
631 "$ref": "Readset" 601 "$ref": "ReadGroupSet"
632 }, 602 },
633 "scopes": [ 603 "scopes": [
634 "https://www.googleapis.com/auth/genomics" 604 "https://www.googleapis.com/auth/genomics"
635 ] 605 ]
636 }, 606 },
637 "search": { 607 "search": {
638 "description": "Gets a list of readsets matching the criteri a.", 608 "description": "Searches for read group sets matching the cr iteria.\n\nImplements GlobalAllianceApi.searchReadGroupSets.",
639 "httpMethod": "POST", 609 "httpMethod": "POST",
640 "id": "genomics.readsets.search", 610 "id": "genomics.readgroupsets.search",
641 "path": "readsets/search", 611 "path": "readgroupsets/search",
642 "request": { 612 "request": {
643 "$ref": "SearchReadsetsRequest" 613 "$ref": "SearchReadGroupSetsRequest"
644 }, 614 },
645 "response": { 615 "response": {
646 "$ref": "SearchReadsetsResponse" 616 "$ref": "SearchReadGroupSetsResponse"
647 }, 617 },
648 "scopes": [ 618 "scopes": [
649 "https://www.googleapis.com/auth/genomics", 619 "https://www.googleapis.com/auth/genomics",
650 "https://www.googleapis.com/auth/genomics.readonly" 620 "https://www.googleapis.com/auth/genomics.readonly"
651 ] 621 ]
652 }, 622 },
653 "update": { 623 "update": {
654 "description": "Updates a readset.", 624 "description": "Updates a read group set.",
655 "httpMethod": "PUT", 625 "httpMethod": "PUT",
656 "id": "genomics.readsets.update", 626 "id": "genomics.readgroupsets.update",
657 "parameterOrder": [ 627 "parameterOrder": [
658 "readsetId" 628 "readGroupSetId"
659 ], 629 ],
660 "parameters": { 630 "parameters": {
661 "readsetId": { 631 "readGroupSetId": {
662 "description": "The ID of the readset to be updated. The caller must have WRITE permissions to the dataset associated with this read set.", 632 "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.",
663 "location": "path", 633 "location": "path",
664 "required": true, 634 "required": true,
665 "type": "string" 635 "type": "string"
666 } 636 }
667 }, 637 },
668 "path": "readsets/{readsetId}", 638 "path": "readgroupsets/{readGroupSetId}",
669 "request": { 639 "request": {
670 "$ref": "Readset" 640 "$ref": "ReadGroupSet"
671 }, 641 },
672 "response": { 642 "response": {
673 "$ref": "Readset" 643 "$ref": "ReadGroupSet"
674 }, 644 },
675 "scopes": [ 645 "scopes": [
676 "https://www.googleapis.com/auth/genomics" 646 "https://www.googleapis.com/auth/genomics"
677 ] 647 ]
678 } 648 }
679 }, 649 },
680 "resources": { 650 "resources": {
681 "coveragebuckets": { 651 "coveragebuckets": {
682 "methods": { 652 "methods": {
683 "list": { 653 "list": {
684 "description": "Lists fixed width coverage buckets f or a readset, each of which correspond to a range of a reference sequence. Each bucket summarizes coverage information across its corresponding genomic range. C overage is defined as the number of reads which are aligned to a given base in t he reference sequence. Coverage buckets are available at various bucket widths, enabling various coverage \"zoom levels\". The caller must have READ permissions for the target readset.", 654 "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.",
685 "httpMethod": "GET", 655 "httpMethod": "GET",
686 "id": "genomics.readsets.coveragebuckets.list", 656 "id": "genomics.readgroupsets.coveragebuckets.list",
687 "parameterOrder": [ 657 "parameterOrder": [
688 "readsetId" 658 "readGroupSetId"
689 ], 659 ],
690 "parameters": { 660 "parameters": {
691 "maxResults": { 661 "pageSize": {
692 "default": "1024", 662 "default": "1024",
693 "description": "The maximum number of result s to return in a single page. If unspecified, defaults to 1024. The maximum valu e is 2048.", 663 "description": "The maximum number of result s to return in a single page. If unspecified, defaults to 1024. The maximum valu e is 2048.",
694 "format": "uint64", 664 "format": "int32",
695 "location": "query", 665 "location": "query",
696 "type": "string" 666 "type": "integer"
697 }, 667 },
698 "pageToken": { 668 "pageToken": {
699 "description": "The continuation token, whic h is used to page through large result sets. To get the next page of results, se t this parameter to the value of nextPageToken from the previous response.", 669 "description": "The continuation token, whic h is used to page through large result sets. To get the next page of results, se t this parameter to the value of nextPageToken from the previous response.",
700 "location": "query", 670 "location": "query",
701 "type": "string" 671 "type": "string"
702 }, 672 },
703 "range.sequenceEnd": { 673 "range.end": {
704 "description": "The end position of the rang e on the reference, 1-based exclusive. If specified, sequenceName must also be s pecified.", 674 "description": "The end position of the rang e on the reference, 0-based exclusive. If specified, referenceName must also be specified.",
705 "format": "uint64", 675 "format": "int64",
706 "location": "query", 676 "location": "query",
707 "type": "string" 677 "type": "string"
708 }, 678 },
709 "range.sequenceName": { 679 "range.referenceName": {
710 "description": "The reference sequence name, for example chr1, 1, or chrX.", 680 "description": "The reference sequence name, for example chr1, 1, or chrX.",
711 "location": "query", 681 "location": "query",
712 "type": "string" 682 "type": "string"
713 }, 683 },
714 "range.sequenceStart": { 684 "range.start": {
715 "description": "The start position of the ra nge on the reference, 1-based inclusive. If specified, sequenceName must also be specified.", 685 "description": "The start position of the ra nge on the reference, 0-based inclusive. If specified, referenceName must also b e specified.",
716 "format": "uint64", 686 "format": "int64",
717 "location": "query", 687 "location": "query",
718 "type": "string" 688 "type": "string"
719 }, 689 },
720 "readsetId": { 690 "readGroupSetId": {
721 "description": "Required. The ID of the read set over which coverage is requested.", 691 "description": "Required. The ID of the read group set over which coverage is requested.",
722 "location": "path", 692 "location": "path",
723 "required": true, 693 "required": true,
724 "type": "string" 694 "type": "string"
725 }, 695 },
726 "targetBucketWidth": { 696 "targetBucketWidth": {
727 "description": "The desired width of each re ported coverage bucket in base pairs. This will be rounded down to the nearest p recomputed bucket width; the value of which is returned as 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.", 697 "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.",
728 "format": "uint64", 698 "format": "int64",
729 "location": "query", 699 "location": "query",
730 "type": "string" 700 "type": "string"
731 } 701 }
732 }, 702 },
733 "path": "readsets/{readsetId}/coveragebuckets", 703 "path": "readgroupsets/{readGroupSetId}/coveragebuck ets",
734 "response": { 704 "response": {
735 "$ref": "ListCoverageBucketsResponse" 705 "$ref": "ListCoverageBucketsResponse"
736 }, 706 },
737 "scopes": [ 707 "scopes": [
738 "https://www.googleapis.com/auth/genomics", 708 "https://www.googleapis.com/auth/genomics",
739 "https://www.googleapis.com/auth/genomics.readon ly" 709 "https://www.googleapis.com/auth/genomics.readon ly"
740 ] 710 ]
741 } 711 }
742 } 712 }
743 } 713 }
744 } 714 }
745 }, 715 },
716 "reads": {
717 "methods": {
718 "search": {
719 "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 (reference sequence & position). Reads with equivalent genomic coordinates are returned in a deterministic order. \n\nImplements GlobalAllianceApi.searchReads.",
720 "httpMethod": "POST",
721 "id": "genomics.reads.search",
722 "path": "reads/search",
723 "request": {
724 "$ref": "SearchReadsRequest"
725 },
726 "response": {
727 "$ref": "SearchReadsResponse"
728 },
729 "scopes": [
730 "https://www.googleapis.com/auth/genomics",
731 "https://www.googleapis.com/auth/genomics.readonly"
732 ]
733 }
734 }
735 },
736 "references": {
737 "methods": {
738 "get": {
739 "description": "Gets a reference.\n\nImplements GlobalAllian ceApi.getReference.",
740 "httpMethod": "GET",
741 "id": "genomics.references.get",
742 "parameterOrder": [
743 "referenceId"
744 ],
745 "parameters": {
746 "referenceId": {
747 "description": "The ID of the reference.",
748 "location": "path",
749 "required": true,
750 "type": "string"
751 }
752 },
753 "path": "references/{referenceId}",
754 "response": {
755 "$ref": "Reference"
756 },
757 "scopes": [
758 "https://www.googleapis.com/auth/genomics",
759 "https://www.googleapis.com/auth/genomics.readonly"
760 ]
761 },
762 "search": {
763 "description": "Searches for references which match the give n criteria.\n\nImplements GlobalAllianceApi.searchReferences.",
764 "httpMethod": "POST",
765 "id": "genomics.references.search",
766 "path": "references/search",
767 "request": {
768 "$ref": "SearchReferencesRequest"
769 },
770 "response": {
771 "$ref": "SearchReferencesResponse"
772 },
773 "scopes": [
774 "https://www.googleapis.com/auth/genomics",
775 "https://www.googleapis.com/auth/genomics.readonly"
776 ]
777 }
778 },
779 "resources": {
780 "bases": {
781 "methods": {
782 "list": {
783 "description": "Lists the bases in a reference, opti onally restricted to a range.\n\nImplements GlobalAllianceApi.getReferenceBases. ",
784 "httpMethod": "GET",
785 "id": "genomics.references.bases.list",
786 "parameterOrder": [
787 "referenceId"
788 ],
789 "parameters": {
790 "end": {
791 "description": "The end position (0-based, e xclusive) of this query. Defaults to the length of this reference.",
792 "format": "int64",
793 "location": "query",
794 "type": "string"
795 },
796 "pageSize": {
797 "default": "200000",
798 "description": "Specifies the maximum number of bases to return in a single page.",
799 "format": "int32",
800 "location": "query",
801 "type": "integer"
802 },
803 "pageToken": {
804 "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.",
805 "location": "query",
806 "type": "string"
807 },
808 "referenceId": {
809 "description": "The ID of the reference.",
810 "location": "path",
811 "required": true,
812 "type": "string"
813 },
814 "start": {
815 "description": "The start position (0-based) of this query. Defaults to 0.",
816 "format": "int64",
817 "location": "query",
818 "type": "string"
819 }
820 },
821 "path": "references/{referenceId}/bases",
822 "response": {
823 "$ref": "ListBasesResponse"
824 },
825 "scopes": [
826 "https://www.googleapis.com/auth/genomics",
827 "https://www.googleapis.com/auth/genomics.readon ly"
828 ]
829 }
830 }
831 }
832 }
833 },
834 "referencesets": {
835 "methods": {
836 "get": {
837 "description": "Gets a reference set.\n\nImplements GlobalAl lianceApi.getReferenceSet.",
838 "httpMethod": "GET",
839 "id": "genomics.referencesets.get",
840 "parameterOrder": [
841 "referenceSetId"
842 ],
843 "parameters": {
844 "referenceSetId": {
845 "description": "The ID of the reference set.",
846 "location": "path",
847 "required": true,
848 "type": "string"
849 }
850 },
851 "path": "referencesets/{referenceSetId}",
852 "response": {
853 "$ref": "ReferenceSet"
854 },
855 "scopes": [
856 "https://www.googleapis.com/auth/genomics",
857 "https://www.googleapis.com/auth/genomics.readonly"
858 ]
859 },
860 "search": {
861 "description": "Searches for reference sets which match the given criteria.\n\nImplements GlobalAllianceApi.searchReferenceSets.",
862 "httpMethod": "POST",
863 "id": "genomics.referencesets.search",
864 "path": "referencesets/search",
865 "request": {
866 "$ref": "SearchReferenceSetsRequest"
867 },
868 "response": {
869 "$ref": "SearchReferenceSetsResponse"
870 },
871 "scopes": [
872 "https://www.googleapis.com/auth/genomics",
873 "https://www.googleapis.com/auth/genomics.readonly"
874 ]
875 }
876 }
877 },
746 "variants": { 878 "variants": {
747 "methods": { 879 "methods": {
748 "create": { 880 "create": {
749 "description": "Creates a new variant.", 881 "description": "Creates a new variant.",
750 "httpMethod": "POST", 882 "httpMethod": "POST",
751 "id": "genomics.variants.create", 883 "id": "genomics.variants.create",
752 "path": "variants", 884 "path": "variants",
753 "request": { 885 "request": {
754 "$ref": "Variant" 886 "$ref": "Variant"
755 }, 887 },
(...skipping 17 matching lines...) Expand all
773 "location": "path", 905 "location": "path",
774 "required": true, 906 "required": true,
775 "type": "string" 907 "type": "string"
776 } 908 }
777 }, 909 },
778 "path": "variants/{variantId}", 910 "path": "variants/{variantId}",
779 "scopes": [ 911 "scopes": [
780 "https://www.googleapis.com/auth/genomics" 912 "https://www.googleapis.com/auth/genomics"
781 ] 913 ]
782 }, 914 },
783 "export": {
784 "description": "Exports variant data to an external destinat ion.",
785 "httpMethod": "POST",
786 "id": "genomics.variants.export",
787 "path": "variants/export",
788 "request": {
789 "$ref": "ExportVariantsRequest"
790 },
791 "response": {
792 "$ref": "ExportVariantsResponse"
793 },
794 "scopes": [
795 "https://www.googleapis.com/auth/bigquery",
796 "https://www.googleapis.com/auth/genomics"
797 ]
798 },
799 "get": { 915 "get": {
800 "description": "Gets a variant by ID.", 916 "description": "Gets a variant by ID.",
801 "httpMethod": "GET", 917 "httpMethod": "GET",
802 "id": "genomics.variants.get", 918 "id": "genomics.variants.get",
803 "parameterOrder": [ 919 "parameterOrder": [
804 "variantId" 920 "variantId"
805 ], 921 ],
806 "parameters": { 922 "parameters": {
807 "variantId": { 923 "variantId": {
808 "description": "The ID of the variant.", 924 "description": "The ID of the variant.",
809 "location": "path", 925 "location": "path",
810 "required": true, 926 "required": true,
811 "type": "string" 927 "type": "string"
812 } 928 }
813 }, 929 },
814 "path": "variants/{variantId}", 930 "path": "variants/{variantId}",
815 "response": { 931 "response": {
816 "$ref": "Variant" 932 "$ref": "Variant"
817 }, 933 },
818 "scopes": [ 934 "scopes": [
819 "https://www.googleapis.com/auth/genomics", 935 "https://www.googleapis.com/auth/genomics",
820 "https://www.googleapis.com/auth/genomics.readonly" 936 "https://www.googleapis.com/auth/genomics.readonly"
821 ] 937 ]
822 }, 938 },
823 "import": {
824 "description": "Creates variant data by asynchronously impor ting the provided information. The variants for import will be merged with any e xisting data and each other according to the behavior of mergeVariants. In parti cular, this means for merged VCF variants that have conflicting INFO fields, som e data will be arbitrarily discarded. As a special case, for single-sample VCF f iles, QUAL and FILTER fields will be moved to the call level; these are sometime s interpreted in a call-specific context. Imported VCF headers are appended to t he metadata already in a VariantSet.",
825 "httpMethod": "POST",
826 "id": "genomics.variants.import",
827 "path": "variants/import",
828 "request": {
829 "$ref": "ImportVariantsRequest"
830 },
831 "response": {
832 "$ref": "ImportVariantsResponse"
833 },
834 "scopes": [
835 "https://www.googleapis.com/auth/devstorage.read_write",
836 "https://www.googleapis.com/auth/genomics"
837 ]
838 },
839 "search": { 939 "search": {
840 "description": "Gets a list of variants matching the criteri a.", 940 "description": "Gets a list of variants matching the criteri a.\n\nImplements GlobalAllianceApi.searchVariants.",
841 "httpMethod": "POST", 941 "httpMethod": "POST",
842 "id": "genomics.variants.search", 942 "id": "genomics.variants.search",
843 "path": "variants/search", 943 "path": "variants/search",
844 "request": { 944 "request": {
845 "$ref": "SearchVariantsRequest" 945 "$ref": "SearchVariantsRequest"
846 }, 946 },
847 "response": { 947 "response": {
848 "$ref": "SearchVariantsResponse" 948 "$ref": "SearchVariantsResponse"
849 }, 949 },
850 "scopes": [ 950 "scopes": [
(...skipping 44 matching lines...) Expand 10 before | Expand all | Expand 10 after
895 "location": "path", 995 "location": "path",
896 "required": true, 996 "required": true,
897 "type": "string" 997 "type": "string"
898 } 998 }
899 }, 999 },
900 "path": "variantsets/{variantSetId}", 1000 "path": "variantsets/{variantSetId}",
901 "scopes": [ 1001 "scopes": [
902 "https://www.googleapis.com/auth/genomics" 1002 "https://www.googleapis.com/auth/genomics"
903 ] 1003 ]
904 }, 1004 },
1005 "export": {
1006 "description": "Exports variant set data to an external dest ination.",
1007 "httpMethod": "POST",
1008 "id": "genomics.variantsets.export",
1009 "parameterOrder": [
1010 "variantSetId"
1011 ],
1012 "parameters": {
1013 "variantSetId": {
1014 "description": "Required. The ID of the variant set that contains variant data which should be exported. The caller must have READ a ccess to this variant set.",
1015 "location": "path",
1016 "required": true,
1017 "type": "string"
1018 }
1019 },
1020 "path": "variantsets/{variantSetId}/export",
1021 "request": {
1022 "$ref": "ExportVariantSetRequest"
1023 },
1024 "response": {
1025 "$ref": "ExportVariantSetResponse"
1026 },
1027 "scopes": [
1028 "https://www.googleapis.com/auth/bigquery",
1029 "https://www.googleapis.com/auth/genomics"
1030 ]
1031 },
905 "get": { 1032 "get": {
906 "description": "Gets a variant set by ID.", 1033 "description": "Gets a variant set by ID.",
907 "httpMethod": "GET", 1034 "httpMethod": "GET",
908 "id": "genomics.variantsets.get", 1035 "id": "genomics.variantsets.get",
909 "parameterOrder": [ 1036 "parameterOrder": [
910 "variantSetId" 1037 "variantSetId"
911 ], 1038 ],
912 "parameters": { 1039 "parameters": {
913 "variantSetId": { 1040 "variantSetId": {
914 "description": "Required. The ID of the variant set. ", 1041 "description": "Required. The ID of the variant set. ",
915 "location": "path", 1042 "location": "path",
916 "required": true, 1043 "required": true,
917 "type": "string" 1044 "type": "string"
918 } 1045 }
919 }, 1046 },
920 "path": "variantsets/{variantSetId}", 1047 "path": "variantsets/{variantSetId}",
921 "response": { 1048 "response": {
922 "$ref": "VariantSet" 1049 "$ref": "VariantSet"
923 }, 1050 },
924 "scopes": [ 1051 "scopes": [
925 "https://www.googleapis.com/auth/genomics", 1052 "https://www.googleapis.com/auth/genomics",
926 "https://www.googleapis.com/auth/genomics.readonly" 1053 "https://www.googleapis.com/auth/genomics.readonly"
927 ] 1054 ]
928 }, 1055 },
1056 "importVariants": {
1057 "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. As a special case, for single-sample VC F files, QUAL and FILTER fields will be moved to the call level; these are somet imes interpreted in a call-specific context. Imported VCF headers are appended t o the metadata already in a variant set.",
1058 "httpMethod": "POST",
1059 "id": "genomics.variantsets.importVariants",
1060 "parameterOrder": [
1061 "variantSetId"
1062 ],
1063 "parameters": {
1064 "variantSetId": {
1065 "description": "Required. The variant set to which v ariant data should be imported.",
1066 "location": "path",
1067 "required": true,
1068 "type": "string"
1069 }
1070 },
1071 "path": "variantsets/{variantSetId}/importVariants",
1072 "request": {
1073 "$ref": "ImportVariantsRequest"
1074 },
1075 "response": {
1076 "$ref": "ImportVariantsResponse"
1077 },
1078 "scopes": [
1079 "https://www.googleapis.com/auth/devstorage.read_write",
1080 "https://www.googleapis.com/auth/genomics"
1081 ]
1082 },
929 "mergeVariants": { 1083 "mergeVariants": {
930 "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, and other fie lds (such as key/value pairs) are discarded.", 1084 "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, and other fie lds (such as key/value pairs) are discarded.",
931 "httpMethod": "POST", 1085 "httpMethod": "POST",
932 "id": "genomics.variantsets.mergeVariants", 1086 "id": "genomics.variantsets.mergeVariants",
933 "parameterOrder": [ 1087 "parameterOrder": [
934 "variantSetId" 1088 "variantSetId"
935 ], 1089 ],
936 "parameters": { 1090 "parameters": {
937 "variantSetId": { 1091 "variantSetId": {
938 "description": "The destination variant set.", 1092 "description": "The destination variant set.",
939 "location": "path", 1093 "location": "path",
940 "required": true, 1094 "required": true,
941 "type": "string" 1095 "type": "string"
942 } 1096 }
943 }, 1097 },
944 "path": "variantsets/{variantSetId}/mergeVariants", 1098 "path": "variantsets/{variantSetId}/mergeVariants",
945 "request": { 1099 "request": {
946 "$ref": "MergeVariantsRequest" 1100 "$ref": "MergeVariantsRequest"
947 } 1101 }
948 }, 1102 },
949 "patch": { 1103 "patch": {
950 "description": "Updates a variant set's metadata. All other modifications are silently ignored. Returns the modified variant set. This metho d supports patch semantics.", 1104 "description": "Updates a variant set's metadata. All other modifications are silently ignored. This method supports patch semantics.",
951 "httpMethod": "PATCH", 1105 "httpMethod": "PATCH",
952 "id": "genomics.variantsets.patch", 1106 "id": "genomics.variantsets.patch",
953 "parameterOrder": [ 1107 "parameterOrder": [
954 "variantSetId" 1108 "variantSetId"
955 ], 1109 ],
956 "parameters": { 1110 "parameters": {
957 "variantSetId": { 1111 "variantSetId": {
958 "description": "The ID of the variant to be updated. ", 1112 "description": "The ID of the variant to be updated. ",
959 "location": "path", 1113 "location": "path",
960 "required": true, 1114 "required": true,
961 "type": "string" 1115 "type": "string"
962 } 1116 }
963 }, 1117 },
964 "path": "variantsets/{variantSetId}", 1118 "path": "variantsets/{variantSetId}",
965 "request": { 1119 "request": {
966 "$ref": "VariantSet" 1120 "$ref": "VariantSet"
967 }, 1121 },
968 "response": { 1122 "response": {
969 "$ref": "VariantSet" 1123 "$ref": "VariantSet"
970 }, 1124 },
971 "scopes": [ 1125 "scopes": [
972 "https://www.googleapis.com/auth/genomics" 1126 "https://www.googleapis.com/auth/genomics"
973 ] 1127 ]
974 }, 1128 },
975 "search": { 1129 "search": {
976 "description": "Returns a list of all variant sets matching search criteria.", 1130 "description": "Returns a list of all variant sets matching search criteria.\n\nImplements GlobalAllianceApi.searchVariantSets.",
977 "httpMethod": "POST", 1131 "httpMethod": "POST",
978 "id": "genomics.variantsets.search", 1132 "id": "genomics.variantsets.search",
979 "path": "variantsets/search", 1133 "path": "variantsets/search",
980 "request": { 1134 "request": {
981 "$ref": "SearchVariantSetsRequest" 1135 "$ref": "SearchVariantSetsRequest"
982 }, 1136 },
983 "response": { 1137 "response": {
984 "$ref": "SearchVariantSetsResponse" 1138 "$ref": "SearchVariantSetsResponse"
985 }, 1139 },
986 "scopes": [ 1140 "scopes": [
987 "https://www.googleapis.com/auth/genomics", 1141 "https://www.googleapis.com/auth/genomics",
988 "https://www.googleapis.com/auth/genomics.readonly" 1142 "https://www.googleapis.com/auth/genomics.readonly"
989 ] 1143 ]
990 }, 1144 },
991 "update": { 1145 "update": {
992 "description": "Updates a variant set's metadata. All other modifications are silently ignored. Returns the modified variant set.", 1146 "description": "Updates a variant set's metadata. All other modifications are silently ignored.",
993 "httpMethod": "PUT", 1147 "httpMethod": "PUT",
994 "id": "genomics.variantsets.update", 1148 "id": "genomics.variantsets.update",
995 "parameterOrder": [ 1149 "parameterOrder": [
996 "variantSetId" 1150 "variantSetId"
997 ], 1151 ],
998 "parameters": { 1152 "parameters": {
999 "variantSetId": { 1153 "variantSetId": {
1000 "description": "The ID of the variant to be updated. ", 1154 "description": "The ID of the variant to be updated. ",
1001 "location": "path", 1155 "location": "path",
1002 "required": true, 1156 "required": true,
1003 "type": "string" 1157 "type": "string"
1004 } 1158 }
1005 }, 1159 },
1006 "path": "variantsets/{variantSetId}", 1160 "path": "variantsets/{variantSetId}",
1007 "request": { 1161 "request": {
1008 "$ref": "VariantSet" 1162 "$ref": "VariantSet"
1009 }, 1163 },
1010 "response": { 1164 "response": {
1011 "$ref": "VariantSet" 1165 "$ref": "VariantSet"
1012 }, 1166 },
1013 "scopes": [ 1167 "scopes": [
1014 "https://www.googleapis.com/auth/genomics" 1168 "https://www.googleapis.com/auth/genomics"
1015 ] 1169 ]
1016 } 1170 }
1017 } 1171 }
1018 } 1172 }
1019 }, 1173 },
1020 "revision": "20141015", 1174 "revision": "20141028",
1021 "rootUrl": "https://www.googleapis.com/", 1175 "rootUrl": "https://www.googleapis.com/",
1022 "schemas": { 1176 "schemas": {
1023 "Beacon": { 1177 "AlignReadGroupSetsRequest": {
1024 "description": "A beacon represents whether any variant call in a va riant set has a specific allele at a particular position.", 1178 "description": "The read group set align request.",
1025 "id": "Beacon", 1179 "id": "AlignReadGroupSetsRequest",
1026 "properties": { 1180 "properties": {
1027 "exists": { 1181 "bamSourceUris": {
1028 "description": "True if the allele exists on any variant cal l, false otherwise.", 1182 "description": "The BAM source files for alignment. Exactly one of readGroupSetIds, bamSourceUris, interleavedFastqSource or pairedFastqSour ce must be provided. The caller must have READ permissions for these files.",
1029 "type": "boolean" 1183 "items": {
1184 "type": "string"
1185 },
1186 "type": "array"
1187 },
1188 "datasetId": {
1189 "description": "Required. The ID of the dataset the newly al igned read group sets will belong to. The caller must have WRITE permissions to this dataset.",
1190 "type": "string"
1191 },
1192 "interleavedFastqSource": {
1193 "$ref": "InterleavedFastqSource",
1194 "description": "The interleaved FASTQ source files for align ment, where both members of each pair of reads are found on consecutive records within the same FASTQ file. Exactly one of readGroupSetIds, bamSourceUris, inter leavedFastqSource or pairedFastqSource must be provided."
1195 },
1196 "pairedFastqSource": {
1197 "$ref": "PairedFastqSource",
1198 "description": "The paired end FASTQ source files for alignm ent, where each member of a pair of reads are found in separate files. Exactly o ne of readGroupSetIds, bamSourceUris, interleavedFastqSource or pairedFastqSourc e must be provided."
1199 },
1200 "readGroupSetIds": {
1201 "description": "The IDs of the read group sets which will be aligned. New read group sets will be generated to hold the aligned data, the or iginals will not be modified. The caller must have READ permissions for these re ad group sets. Exactly one of readGroupSetIds, bamSourceUris, interleavedFastqSo urce or pairedFastqSource must be provided.",
1202 "items": {
1203 "type": "string"
1204 },
1205 "type": "array"
1206 }
1207 },
1208 "type": "object"
1209 },
1210 "AlignReadGroupSetsResponse": {
1211 "description": "The read group set align response.",
1212 "id": "AlignReadGroupSetsResponse",
1213 "properties": {
1214 "jobId": {
1215 "description": "A job ID that can be used to get status info rmation.",
1216 "type": "string"
1030 } 1217 }
1031 }, 1218 },
1032 "type": "object" 1219 "type": "object"
1033 }, 1220 },
1034 "Call": { 1221 "Call": {
1035 "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.", 1222 "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.",
1036 "id": "Call", 1223 "id": "Call",
1037 "properties": { 1224 "properties": {
1038 "callSetId": { 1225 "callSetId": {
1039 "description": "The ID of the call set this variant call bel ongs to.", 1226 "description": "The ID of the call set this variant call bel ongs to.",
1040 "type": "string" 1227 "type": "string"
1041 }, 1228 },
1042 "callSetName": { 1229 "callSetName": {
1043 "description": "The name of the call set this variant call b elongs to.", 1230 "description": "The name of the call set this variant call b elongs to.",
1044 "type": "string" 1231 "type": "string"
1045 }, 1232 },
(...skipping 24 matching lines...) Expand all
1070 "description": "A map of additional variant call information .", 1257 "description": "A map of additional variant call information .",
1071 "type": "object" 1258 "type": "object"
1072 }, 1259 },
1073 "phaseset": { 1260 "phaseset": {
1074 "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 *.", 1261 "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 *.",
1075 "type": "string" 1262 "type": "string"
1076 } 1263 }
1077 }, 1264 },
1078 "type": "object" 1265 "type": "object"
1079 }, 1266 },
1267 "CallReadGroupSetsRequest": {
1268 "description": "The read group set call request.",
1269 "id": "CallReadGroupSetsRequest",
1270 "properties": {
1271 "datasetId": {
1272 "description": "Required. The ID of the dataset the called v ariants will belong to. The caller must have WRITE permissions to this dataset." ,
1273 "type": "string"
1274 },
1275 "readGroupSetIds": {
1276 "description": "The IDs of the read group sets which will be called. The caller must have READ permissions for these read group sets. One of readGroupSetIds or sourceUris must be provided.",
1277 "items": {
1278 "type": "string"
1279 },
1280 "type": "array"
1281 },
1282 "sourceUris": {
1283 "description": "A list of URIs pointing at BAM files in Goog le Cloud Storage which will be called. FASTQ files are not allowed. The caller m ust have READ permissions for these files. One of readGroupSetIds or sourceUris must be provided.",
1284 "items": {
1285 "type": "string"
1286 },
1287 "type": "array"
1288 }
1289 },
1290 "type": "object"
1291 },
1292 "CallReadGroupSetsResponse": {
1293 "description": "The read group set call response.",
1294 "id": "CallReadGroupSetsResponse",
1295 "properties": {
1296 "jobId": {
1297 "description": "A job ID that can be used to get status info rmation.",
1298 "type": "string"
1299 }
1300 },
1301 "type": "object"
1302 },
1080 "CallSet": { 1303 "CallSet": {
1081 "description": "A CallSet is a collection of variant calls. It belon gs to a variant set.", 1304 "description": "A call set is a collection of variant calls, typical ly for one sample. It belongs to a variant set.",
1082 "id": "CallSet", 1305 "id": "CallSet",
1083 "properties": { 1306 "properties": {
1084 "created": { 1307 "created": {
1085 "description": "The date this call set was created in millis econds from the epoch.", 1308 "description": "The date this call set was created in millis econds from the epoch.",
1086 "format": "int64", 1309 "format": "int64",
1087 "type": "string" 1310 "type": "string"
1088 }, 1311 },
1089 "id": { 1312 "id": {
1090 "description": "The Google generated ID of the call set, imm utable.", 1313 "description": "The Google generated ID of the call set, imm utable.",
1091 "type": "string" 1314 "type": "string"
1092 }, 1315 },
1093 "info": { 1316 "info": {
1094 "additionalProperties": { 1317 "additionalProperties": {
1095 "description": "A string which maps to an array of value s.", 1318 "description": "A string which maps to an array of value s.",
1096 "items": { 1319 "items": {
1097 "type": "string" 1320 "type": "string"
1098 }, 1321 },
1099 "type": "array" 1322 "type": "array"
1100 }, 1323 },
1101 "description": "A map of additional callset information.", 1324 "description": "A map of additional call set information.",
1102 "type": "object" 1325 "type": "object"
1103 }, 1326 },
1104 "name": { 1327 "name": {
1105 "description": "The callset name.", 1328 "description": "The call set name.",
1106 "type": "string" 1329 "type": "string"
1107 }, 1330 },
1108 "sampleId": { 1331 "sampleId": {
1109 "description": "The sample ID this call set corresponds to." , 1332 "description": "The sample ID this call set corresponds to." ,
1110 "type": "string" 1333 "type": "string"
1111 }, 1334 },
1112 "variantSetIds": { 1335 "variantSetIds": {
1113 "description": "The IDs of the variant sets this call set be longs to.", 1336 "description": "The IDs of the variant sets this call set be longs to.",
1114 "items": { 1337 "items": {
1115 "type": "string" 1338 "type": "string"
1116 }, 1339 },
1117 "type": "array" 1340 "type": "array"
1118 } 1341 }
1119 }, 1342 },
1120 "type": "object" 1343 "type": "object"
1121 }, 1344 },
1345 "CigarUnit": {
1346 "description": "A single CIGAR operation.",
1347 "id": "CigarUnit",
1348 "properties": {
1349 "operation": {
1350 "enum": [
1351 "ALIGNMENT_MATCH",
1352 "CLIP_HARD",
1353 "CLIP_SOFT",
1354 "DELETE",
1355 "INSERT",
1356 "PAD",
1357 "SEQUENCE_MATCH",
1358 "SEQUENCE_MISMATCH",
1359 "SKIP"
1360 ],
1361 "enumDescriptions": [
1362 "",
1363 "",
1364 "",
1365 "",
1366 "",
1367 "",
1368 "",
1369 "",
1370 ""
1371 ],
1372 "type": "string"
1373 },
1374 "operationLength": {
1375 "description": "The number of bases that the operation runs for. Required.",
1376 "format": "int64",
1377 "type": "string"
1378 },
1379 "referenceSequence": {
1380 "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.",
1381 "type": "string"
1382 }
1383 },
1384 "type": "object"
1385 },
1122 "CoverageBucket": { 1386 "CoverageBucket": {
1123 "description": "A bucket over which read coverage has been precomput ed. A bucket corresponds to a specific range of the reference sequence.", 1387 "description": "A bucket over which read coverage has been precomput ed. A bucket corresponds to a specific range of the reference sequence.",
1124 "id": "CoverageBucket", 1388 "id": "CoverageBucket",
1125 "properties": { 1389 "properties": {
1126 "meanCoverage": { 1390 "meanCoverage": {
1127 "description": "The average number of reads which are aligne d to each individual reference base in this bucket.", 1391 "description": "The average number of reads which are aligne d to each individual reference base in this bucket.",
1128 "format": "float", 1392 "format": "float",
1129 "type": "number" 1393 "type": "number"
1130 }, 1394 },
1131 "range": { 1395 "range": {
1132 "$ref": "GenomicRange", 1396 "$ref": "Range",
1133 "description": "The genomic coordinate range spanned by this bucket." 1397 "description": "The genomic coordinate range spanned by this bucket."
1134 } 1398 }
1135 }, 1399 },
1136 "type": "object" 1400 "type": "object"
1137 }, 1401 },
1138 "Dataset": { 1402 "Dataset": {
1139 "description": "A Dataset is a collection of genomic data.", 1403 "description": "A Dataset is a collection of genomic data.",
1140 "id": "Dataset", 1404 "id": "Dataset",
1141 "properties": { 1405 "properties": {
1142 "id": { 1406 "id": {
1143 "description": "The Google generated ID of the dataset, immu table.", 1407 "description": "The Google generated ID of the dataset, immu table.",
1144 "type": "string" 1408 "type": "string"
1145 }, 1409 },
1146 "isPublic": { 1410 "isPublic": {
1147 "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.", 1411 "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.",
1148 "type": "boolean" 1412 "type": "boolean"
1149 }, 1413 },
1150 "name": { 1414 "name": {
1151 "description": "The dataset name.", 1415 "description": "The dataset name.",
1152 "type": "string" 1416 "type": "string"
1153 }, 1417 },
1154 "projectId": { 1418 "projectNumber": {
1155 "description": "The Google Developers Console project number that this dataset belongs to.", 1419 "description": "The Google Developers Console project number that this dataset belongs to.",
1156 "format": "int64", 1420 "format": "int64",
1157 "type": "string" 1421 "type": "string"
1158 } 1422 }
1159 }, 1423 },
1160 "type": "object" 1424 "type": "object"
1161 }, 1425 },
1162 "ExperimentalCreateJobRequest": { 1426 "ExperimentalCreateJobRequest": {
1163 "description": "The job creation request.", 1427 "description": "The job creation request.",
1164 "id": "ExperimentalCreateJobRequest", 1428 "id": "ExperimentalCreateJobRequest",
1165 "properties": { 1429 "properties": {
1166 "align": { 1430 "align": {
1167 "description": "Specifies whether or not to run the alignmen t pipeline. At least one of align or callVariants must be provided.", 1431 "description": "Specifies whether or not to run the alignmen t pipeline. Either align or callVariants must be set.",
1168 "type": "boolean" 1432 "type": "boolean"
1169 }, 1433 },
1170 "callVariants": { 1434 "callVariants": {
1171 "description": "Specifies whether or not to run the variant calling pipeline. If specified, alignment will be performed first and the aligne d BAMs will passed as input to the variant caller. At least one of align or call Variants must be provided.", 1435 "description": "Specifies whether or not to run the variant calling pipeline. Either align or callVariants must be set.",
1172 "type": "boolean" 1436 "type": "boolean"
1173 }, 1437 },
1174 "gcsOutputPath": { 1438 "gcsOutputPath": {
1175 "description": "Specifies where to copy the results of certa in pipelines. This should be in the form of gs://bucket/path.", 1439 "description": "Specifies where to copy the results of certa in pipelines. This should be in the form of gs://bucket/path.",
1176 "type": "string" 1440 "type": "string"
1177 }, 1441 },
1178 "pairedSourceUris": { 1442 "pairedSourceUris": {
1179 "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.", 1443 "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.",
1180 "items": { 1444 "items": {
1181 "type": "string" 1445 "type": "string"
1182 }, 1446 },
1183 "type": "array" 1447 "type": "array"
1184 }, 1448 },
1185 "projectId": { 1449 "projectNumber": {
1186 "description": "Required. The Google Cloud Project ID with w hich to associate the request.", 1450 "description": "Required. The Google Cloud Project ID with w hich to associate the request.",
1187 "format": "int64", 1451 "format": "int64",
1188 "type": "string" 1452 "type": "string"
1189 }, 1453 },
1190 "sourceUris": { 1454 "sourceUris": {
1191 "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.", 1455 "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.",
1192 "items": { 1456 "items": {
1193 "type": "string" 1457 "type": "string"
1194 }, 1458 },
1195 "type": "array" 1459 "type": "array"
1196 } 1460 }
1197 }, 1461 },
1198 "type": "object" 1462 "type": "object"
1199 }, 1463 },
1200 "ExperimentalCreateJobResponse": { 1464 "ExperimentalCreateJobResponse": {
1201 "description": "The job creation response.", 1465 "description": "The job creation response.",
1202 "id": "ExperimentalCreateJobResponse", 1466 "id": "ExperimentalCreateJobResponse",
1203 "properties": { 1467 "properties": {
1204 "jobId": { 1468 "jobId": {
1205 "description": "A job ID that can be used to get status info rmation.", 1469 "description": "A job ID that can be used to get status info rmation.",
1206 "type": "string" 1470 "type": "string"
1207 } 1471 }
1208 }, 1472 },
1209 "type": "object" 1473 "type": "object"
1210 }, 1474 },
1211 "ExportReadsetsRequest": { 1475 "ExportReadGroupSetsRequest": {
1212 "description": "The readset export request.", 1476 "description": "The read group set export request.",
1213 "id": "ExportReadsetsRequest", 1477 "id": "ExportReadGroupSetsRequest",
1214 "properties": { 1478 "properties": {
1215 "exportUri": { 1479 "exportUri": {
1216 "description": "A Google Cloud Storage URI where the exporte d BAM file will be created. The currently authenticated user must have write acc ess to the new file location. An error will be returned if the URI already conta ins data.", 1480 "description": "A Google Cloud Storage URI where the exporte d BAM file will be created. The currently authenticated user must have write acc ess to the new file location. An error will be returned if the URI already conta ins data.",
1217 "type": "string" 1481 "type": "string"
1218 }, 1482 },
1219 "projectId": { 1483 "projectNumber": {
1220 "description": "The Google Developers Console project number that owns this export.", 1484 "description": "The Google Developers Console project number that owns this export.",
1221 "format": "int64", 1485 "format": "int64",
1222 "type": "string" 1486 "type": "string"
1223 }, 1487 },
1224 "readsetIds": { 1488 "readGroupSetIds": {
1225 "description": "The IDs of the readsets to export.", 1489 "description": "The IDs of the read group sets to export.",
1226 "items": { 1490 "items": {
1227 "type": "string" 1491 "type": "string"
1228 }, 1492 },
1229 "type": "array" 1493 "type": "array"
1230 }, 1494 },
1231 "referenceNames": { 1495 "referenceNames": {
1232 "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.", 1496 "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.",
1233 "items": { 1497 "items": {
1234 "type": "string" 1498 "type": "string"
1235 }, 1499 },
1236 "type": "array" 1500 "type": "array"
1237 } 1501 }
1238 }, 1502 },
1239 "type": "object" 1503 "type": "object"
1240 }, 1504 },
1241 "ExportReadsetsResponse": { 1505 "ExportReadGroupSetsResponse": {
1242 "description": "The readset export response.", 1506 "description": "The read group set export response.",
1243 "id": "ExportReadsetsResponse", 1507 "id": "ExportReadGroupSetsResponse",
1244 "properties": { 1508 "properties": {
1245 "jobId": { 1509 "jobId": {
1246 "description": "A job ID that can be used to get status info rmation.", 1510 "description": "A job ID that can be used to get status info rmation.",
1247 "type": "string" 1511 "type": "string"
1248 } 1512 }
1249 }, 1513 },
1250 "type": "object" 1514 "type": "object"
1251 }, 1515 },
1252 "ExportVariantsRequest": { 1516 "ExportVariantSetRequest": {
1253 "description": "The variant data export request.", 1517 "description": "The variant data export request.",
1254 "id": "ExportVariantsRequest", 1518 "id": "ExportVariantSetRequest",
1255 "properties": { 1519 "properties": {
1256 "bigqueryDataset": { 1520 "bigqueryDataset": {
1257 "description": "The BigQuery dataset to export data to. Note that this is distinct from the Genomics concept of \"dataset\".", 1521 "description": "The BigQuery dataset to export data to. Note that this is distinct from the Genomics concept of \"dataset\".",
1258 "type": "string" 1522 "type": "string"
1259 }, 1523 },
1260 "bigqueryTable": { 1524 "bigqueryTable": {
1261 "description": "The BigQuery table to export data to. If the table doesn't exist, it will be created. If it already exists, it will be overw ritten.", 1525 "description": "The BigQuery table to export data to. If the table doesn't exist, it will be created. If it already exists, it will be overw ritten.",
1262 "type": "string" 1526 "type": "string"
1263 }, 1527 },
1264 "callSetIds": { 1528 "callSetIds": {
1265 "description": "If provided, only variant call information f rom the specified call sets will be exported. By default all variant calls are e xported.", 1529 "description": "If provided, only variant call information f rom the specified call sets will be exported. By default all variant calls are e xported.",
1266 "items": { 1530 "items": {
1267 "type": "string" 1531 "type": "string"
1268 }, 1532 },
1269 "type": "array" 1533 "type": "array"
1270 }, 1534 },
1271 "format": { 1535 "format": {
1272 "description": "The format for the exported data.", 1536 "description": "The format for the exported data.",
1273 "enum": [ 1537 "enum": [
1274 "bigquery" 1538 "BIGQUERY"
1275 ], 1539 ],
1276 "enumDescriptions": [ 1540 "enumDescriptions": [
1277 "" 1541 ""
1278 ], 1542 ],
1279 "type": "string" 1543 "type": "string"
1280 }, 1544 },
1281 "projectId": { 1545 "projectNumber": {
1282 "description": "The Google Cloud project number that owns th e destination BigQuery dataset. The caller must have WRITE access to this projec t. This project will also own the resulting export job.", 1546 "description": "The Google Cloud project number that owns th e destination BigQuery dataset. The caller must have WRITE access to this projec t. This project will also own the resulting export job.",
1283 "format": "int64", 1547 "format": "int64",
1284 "type": "string" 1548 "type": "string"
1285 },
1286 "variantSetId": {
1287 "description": "Required. The ID of the variant set that con tains variant data which should be exported. The caller must have READ access to this variant set.",
1288 "type": "string"
1289 } 1549 }
1290 }, 1550 },
1291 "type": "object" 1551 "type": "object"
1292 }, 1552 },
1293 "ExportVariantsResponse": { 1553 "ExportVariantSetResponse": {
1294 "description": "The variant data export response.", 1554 "description": "The variant data export response.",
1295 "id": "ExportVariantsResponse", 1555 "id": "ExportVariantSetResponse",
1296 "properties": { 1556 "properties": {
1297 "jobId": { 1557 "jobId": {
1298 "description": "A job ID that can be used to get status info rmation.", 1558 "description": "A job ID that can be used to get status info rmation.",
1299 "type": "string" 1559 "type": "string"
1300 } 1560 }
1301 }, 1561 },
1302 "type": "object" 1562 "type": "object"
1303 }, 1563 },
1304 "GenomicRange": { 1564 "FastqMetadata": {
1305 "description": "An inclusive, exclusive genomic coordinate range ove r a reference sequence.", 1565 "id": "FastqMetadata",
1306 "id": "GenomicRange",
1307 "properties": { 1566 "properties": {
1308 "sequenceEnd": { 1567 "libraryName": {
1309 "description": "The end position of the range on the referen ce, 1-based exclusive. If specified, sequenceName must also be specified.", 1568 "description": "Optionally specifies the library name for al ignment from FASTQ.",
1310 "format": "uint64",
1311 "type": "string" 1569 "type": "string"
1312 }, 1570 },
1313 "sequenceName": { 1571 "platformName": {
1314 "description": "The reference sequence name, for example chr 1, 1, or chrX.", 1572 "description": "Optionally specifies the platform name for a lignment from FASTQ. For example: CAPILLARY, LS454, ILLUMINA, SOLID, HELICOS, IO NTORRENT, PACBIO.",
1315 "type": "string" 1573 "type": "string"
1316 }, 1574 },
1317 "sequenceStart": { 1575 "platformUnit": {
1318 "description": "The start position of the range on the refer ence, 1-based inclusive. If specified, sequenceName must also be specified.", 1576 "description": "Optionally specifies the platform unit for a lignment from FASTQ. For example: flowcell-barcode.lane for Illumina or slide fo r SOLID.",
1319 "format": "uint64", 1577 "type": "string"
1578 },
1579 "readGroupName": {
1580 "description": "Optionally specifies the read group name for alignment from FASTQ.",
1581 "type": "string"
1582 },
1583 "sampleName": {
1584 "description": "Optionally specifies the sample name for ali gnment from FASTQ.",
1320 "type": "string" 1585 "type": "string"
1321 } 1586 }
1322 }, 1587 },
1323 "type": "object" 1588 "type": "object"
1324 }, 1589 },
1325 "Header": { 1590 "ImportReadGroupSetsRequest": {
1326 "id": "Header", 1591 "description": "The read group set import request.",
1592 "id": "ImportReadGroupSetsRequest",
1327 "properties": { 1593 "properties": {
1328 "sortingOrder": { 1594 "datasetId": {
1329 "description": "(SO) Sorting order of alignments.", 1595 "description": "Required. The ID of the dataset these read g roup sets will belong to. The caller must have WRITE permissions to this dataset .",
1330 "type": "string" 1596 "type": "string"
1331 }, 1597 },
1332 "version": { 1598 "referenceSetId": {
1333 "description": "(VN) BAM format version.", 1599 "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.",
1334 "type": "string"
1335 }
1336 },
1337 "type": "object"
1338 },
1339 "HeaderSection": {
1340 "description": "The header section of the BAM/SAM file.",
1341 "id": "HeaderSection",
1342 "properties": {
1343 "comments": {
1344 "description": "(@CO) One-line text comments.",
1345 "items": {
1346 "type": "string"
1347 },
1348 "type": "array"
1349 },
1350 "fileUri": {
1351 "description": "[Deprecated] This field is deprecated and wi ll no longer be populated. Please use filename instead.",
1352 "type": "string"
1353 },
1354 "filename": {
1355 "description": "The name of the file from which this data wa s imported.",
1356 "type": "string"
1357 },
1358 "headers": {
1359 "description": "(@HD) The header line.",
1360 "items": {
1361 "$ref": "Header"
1362 },
1363 "type": "array"
1364 },
1365 "programs": {
1366 "description": "(@PG) Programs.",
1367 "items": {
1368 "$ref": "Program"
1369 },
1370 "type": "array"
1371 },
1372 "readGroups": {
1373 "description": "(@RG) Read group.",
1374 "items": {
1375 "$ref": "ReadGroup"
1376 },
1377 "type": "array"
1378 },
1379 "refSequences": {
1380 "description": "(@SQ) Reference sequence dictionary.",
1381 "items": {
1382 "$ref": "ReferenceSequence"
1383 },
1384 "type": "array"
1385 }
1386 },
1387 "type": "object"
1388 },
1389 "ImportReadsetsRequest": {
1390 "description": "The readset import request.",
1391 "id": "ImportReadsetsRequest",
1392 "properties": {
1393 "datasetId": {
1394 "description": "Required. The ID of the dataset these readse ts will belong to. The caller must have WRITE permissions to this dataset.",
1395 "type": "string" 1600 "type": "string"
1396 }, 1601 },
1397 "sourceUris": { 1602 "sourceUris": {
1398 "description": "A list of URIs pointing at BAM files in Goog le Cloud Storage.", 1603 "description": "A list of URIs pointing at BAM files in Goog le Cloud Storage.",
1399 "items": { 1604 "items": {
1400 "type": "string" 1605 "type": "string"
1401 }, 1606 },
1402 "type": "array" 1607 "type": "array"
1403 } 1608 }
1404 }, 1609 },
1405 "type": "object" 1610 "type": "object"
1406 }, 1611 },
1407 "ImportReadsetsResponse": { 1612 "ImportReadGroupSetsResponse": {
1408 "description": "The readset import response.", 1613 "description": "The read group set import response.",
1409 "id": "ImportReadsetsResponse", 1614 "id": "ImportReadGroupSetsResponse",
1410 "properties": { 1615 "properties": {
1411 "jobId": { 1616 "jobId": {
1412 "description": "A job ID that can be used to get status info rmation.", 1617 "description": "A job ID that can be used to get status info rmation.",
1413 "type": "string" 1618 "type": "string"
1414 } 1619 }
1415 }, 1620 },
1416 "type": "object" 1621 "type": "object"
1417 }, 1622 },
1418 "ImportVariantsRequest": { 1623 "ImportVariantsRequest": {
1419 "description": "The variant data import request.", 1624 "description": "The variant data import request.",
1420 "id": "ImportVariantsRequest", 1625 "id": "ImportVariantsRequest",
1421 "properties": { 1626 "properties": {
1422 "format": { 1627 "format": {
1423 "description": "The format of the variant data being importe d.", 1628 "description": "The format of the variant data being importe d.",
1424 "enum": [ 1629 "enum": [
1425 "completeGenomics", 1630 "COMPLETE_GENOMICS",
1426 "vcf" 1631 "VCF"
1427 ], 1632 ],
1428 "enumDescriptions": [ 1633 "enumDescriptions": [
1429 "", 1634 "",
1430 "" 1635 ""
1431 ], 1636 ],
1432 "type": "string" 1637 "type": "string"
1433 }, 1638 },
1434 "sourceUris": { 1639 "sourceUris": {
1435 "description": "A list of URIs pointing at VCF files in Goog le Cloud Storage. See the VCF Specification for more details on the input format .", 1640 "description": "A list of URIs pointing at VCF files in Goog le Cloud Storage. See the VCF Specification for more details on the input format .",
1436 "items": { 1641 "items": {
1437 "type": "string" 1642 "type": "string"
1438 }, 1643 },
1439 "type": "array" 1644 "type": "array"
1440 },
1441 "variantSetId": {
1442 "description": "Required. The variant set to which variant d ata should be imported.",
1443 "type": "string"
1444 } 1645 }
1445 }, 1646 },
1446 "type": "object" 1647 "type": "object"
1447 }, 1648 },
1448 "ImportVariantsResponse": { 1649 "ImportVariantsResponse": {
1449 "description": "The variant data import response.", 1650 "description": "The variant data import response.",
1450 "id": "ImportVariantsResponse", 1651 "id": "ImportVariantsResponse",
1451 "properties": { 1652 "properties": {
1452 "jobId": { 1653 "jobId": {
1453 "description": "A job ID that can be used to get status info rmation.", 1654 "description": "A job ID that can be used to get status info rmation.",
1454 "type": "string" 1655 "type": "string"
1455 } 1656 }
1456 }, 1657 },
1457 "type": "object" 1658 "type": "object"
1458 }, 1659 },
1660 "InterleavedFastqSource": {
1661 "description": "Describes an interleaved FASTQ file source for align ment.",
1662 "id": "InterleavedFastqSource",
1663 "properties": {
1664 "metadata": {
1665 "$ref": "FastqMetadata",
1666 "description": "Optionally specifies the metadata to be asso ciated with the final aligned read group set."
1667 },
1668 "sourceUris": {
1669 "description": "A list of URIs pointing at interleaved FASTQ files in Google Cloud Storage which will be aligned. The caller must have READ permissions for these files.",
1670 "items": {
1671 "type": "string"
1672 },
1673 "type": "array"
1674 }
1675 },
1676 "type": "object"
1677 },
1459 "Job": { 1678 "Job": {
1460 "description": "A Job represents an ongoing process that can be moni tored for status information.", 1679 "description": "A Job represents an ongoing process that can be moni tored for status information.",
1461 "id": "Job", 1680 "id": "Job",
1462 "properties": { 1681 "properties": {
1463 "created": { 1682 "created": {
1464 "description": "The date this job was created, in millisecon ds from the epoch.", 1683 "description": "The date this job was created, in millisecon ds from the epoch.",
1465 "format": "int64", 1684 "format": "int64",
1466 "type": "string" 1685 "type": "string"
1467 }, 1686 },
1468 "description": { 1687 "detailedStatus": {
1469 "description": "A more detailed description of this job's cu rrent status.", 1688 "description": "A more detailed description of this job's cu rrent status.",
1470 "type": "string" 1689 "type": "string"
1471 }, 1690 },
1472 "errors": { 1691 "errors": {
1473 "description": "Any errors that occurred during processing." , 1692 "description": "Any errors that occurred during processing." ,
1474 "items": { 1693 "items": {
1475 "type": "string" 1694 "type": "string"
1476 }, 1695 },
1477 "type": "array" 1696 "type": "array"
1478 }, 1697 },
1479 "id": { 1698 "id": {
1480 "description": "The job ID.", 1699 "description": "The job ID.",
1481 "type": "string" 1700 "type": "string"
1482 }, 1701 },
1483 "importedIds": { 1702 "importedIds": {
1484 "description": "If this Job represents an import, this field will contain the IDs of the objects that were successfully imported.", 1703 "description": "If this Job represents an import, this field will contain the IDs of the objects that were successfully imported.",
1485 "items": { 1704 "items": {
1486 "type": "string" 1705 "type": "string"
1487 }, 1706 },
1488 "type": "array" 1707 "type": "array"
1489 }, 1708 },
1490 "projectId": { 1709 "projectNumber": {
1491 "description": "The Google Developers Console project number to which this job belongs.", 1710 "description": "The Google Developers Console project number to which this job belongs.",
1492 "format": "int64", 1711 "format": "int64",
1493 "type": "string" 1712 "type": "string"
1494 }, 1713 },
1495 "request": { 1714 "request": {
1496 "$ref": "JobRequest", 1715 "$ref": "JobRequest",
1497 "description": "A summarized representation of the original service request." 1716 "description": "A summarized representation of the original service request."
1498 }, 1717 },
1499 "status": { 1718 "status": {
1500 "description": "The status of this job.", 1719 "description": "The status of this job.",
1501 "enum": [ 1720 "enum": [
1502 "canceled", 1721 "CANCELED",
1503 "failure", 1722 "FAILURE",
1504 "new", 1723 "NEW",
1505 "pending", 1724 "PENDING",
1506 "running", 1725 "RUNNING",
1507 "success", 1726 "SUCCESS",
1508 "unknownStatus" 1727 "UNKNOWN_STATUS"
1509 ], 1728 ],
1510 "enumDescriptions": [ 1729 "enumDescriptions": [
1511 "", 1730 "",
1512 "", 1731 "",
1513 "", 1732 "",
1514 "", 1733 "",
1515 "", 1734 "",
1516 "", 1735 "",
1517 "" 1736 ""
1518 ], 1737 ],
(...skipping 23 matching lines...) Expand all
1542 "source": { 1761 "source": {
1543 "description": "The data source of the request, for example, a Google Cloud Storage object path or Readset ID.", 1762 "description": "The data source of the request, for example, a Google Cloud Storage object path or Readset ID.",
1544 "items": { 1763 "items": {
1545 "type": "string" 1764 "type": "string"
1546 }, 1765 },
1547 "type": "array" 1766 "type": "array"
1548 }, 1767 },
1549 "type": { 1768 "type": {
1550 "description": "The original request type.", 1769 "description": "The original request type.",
1551 "enum": [ 1770 "enum": [
1552 "experimentalCreateJob", 1771 "ALIGN_READSETS",
1553 "exportReadsets", 1772 "CALL_READSETS",
1554 "exportVariants", 1773 "EXPERIMENTAL_CREATE_JOB",
1555 "importReadsets", 1774 "EXPORT_READSETS",
1556 "importVariants", 1775 "EXPORT_VARIANTS",
1557 "unknownType" 1776 "IMPORT_READSETS",
1777 "IMPORT_VARIANTS",
1778 "UNKNOWN_TYPE"
1558 ], 1779 ],
1559 "enumDescriptions": [ 1780 "enumDescriptions": [
1560 "", 1781 "",
1561 "", 1782 "",
1562 "", 1783 "",
1563 "", 1784 "",
1564 "", 1785 "",
1786 "",
1787 "",
1565 "" 1788 ""
1566 ], 1789 ],
1567 "type": "string" 1790 "type": "string"
1568 } 1791 }
1569 }, 1792 },
1570 "type": "object" 1793 "type": "object"
1571 }, 1794 },
1795 "LinearAlignment": {
1796 "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.",
1797 "id": "LinearAlignment",
1798 "properties": {
1799 "cigar": {
1800 "description": "Represents the local alignment of this seque nce (alignment matches, indels, etc) against the reference.",
1801 "items": {
1802 "$ref": "CigarUnit"
1803 },
1804 "type": "array"
1805 },
1806 "mappingQuality": {
1807 "description": "The mapping quality of this alignment. Repre sents how likely the read maps to this position as opposed to other locations.",
1808 "format": "int32",
1809 "type": "integer"
1810 },
1811 "position": {
1812 "$ref": "Position",
1813 "description": "The position of this alignment."
1814 }
1815 },
1816 "type": "object"
1817 },
1818 "ListBasesResponse": {
1819 "id": "ListBasesResponse",
1820 "properties": {
1821 "nextPageToken": {
1822 "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.",
1823 "type": "string"
1824 },
1825 "offset": {
1826 "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.",
1827 "format": "int64",
1828 "type": "string"
1829 },
1830 "sequence": {
1831 "description": "A substring of the bases that make up this r eference.",
1832 "type": "string"
1833 }
1834 },
1835 "type": "object"
1836 },
1572 "ListCoverageBucketsResponse": { 1837 "ListCoverageBucketsResponse": {
1573 "id": "ListCoverageBucketsResponse", 1838 "id": "ListCoverageBucketsResponse",
1574 "properties": { 1839 "properties": {
1575 "bucketWidth": { 1840 "bucketWidth": {
1576 "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).", 1841 "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).",
1577 "format": "uint64", 1842 "format": "int64",
1578 "type": "string" 1843 "type": "string"
1579 }, 1844 },
1580 "coverageBuckets": { 1845 "coverageBuckets": {
1581 "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.", 1846 "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.",
1582 "items": { 1847 "items": {
1583 "$ref": "CoverageBucket" 1848 "$ref": "CoverageBucket"
1584 }, 1849 },
1585 "type": "array" 1850 "type": "array"
1586 }, 1851 },
1587 "nextPageToken": { 1852 "nextPageToken": {
(...skipping 61 matching lines...) Expand 10 before | Expand all | Expand 10 after
1649 "description": "The top-level key.", 1914 "description": "The top-level key.",
1650 "type": "string" 1915 "type": "string"
1651 }, 1916 },
1652 "number": { 1917 "number": {
1653 "description": "The number of values that can be included in a field described by this metadata.", 1918 "description": "The number of values that can be included in a field described by this metadata.",
1654 "type": "string" 1919 "type": "string"
1655 }, 1920 },
1656 "type": { 1921 "type": {
1657 "description": "The type of data. Possible types include: In teger, Float, Flag, Character, and String.", 1922 "description": "The type of data. Possible types include: In teger, Float, Flag, Character, and String.",
1658 "enum": [ 1923 "enum": [
1659 "character", 1924 "CHARACTER",
1660 "flag", 1925 "FLAG",
1661 "float", 1926 "FLOAT",
1662 "integer", 1927 "INTEGER",
1663 "string", 1928 "STRING",
1664 "unknownType" 1929 "UNKNOWN_TYPE"
1665 ], 1930 ],
1666 "enumDescriptions": [ 1931 "enumDescriptions": [
1667 "", 1932 "",
1668 "", 1933 "",
1669 "", 1934 "",
1670 "", 1935 "",
1671 "", 1936 "",
1672 "" 1937 ""
1673 ], 1938 ],
1674 "type": "string" 1939 "type": "string"
1675 }, 1940 },
1676 "value": { 1941 "value": {
1677 "description": "The value field for simple metadata", 1942 "description": "The value field for simple metadata",
1678 "type": "string" 1943 "type": "string"
1679 } 1944 }
1680 }, 1945 },
1681 "type": "object" 1946 "type": "object"
1682 }, 1947 },
1683 "Program": { 1948 "PairedFastqSource": {
1684 "id": "Program", 1949 "description": "Describes a paired-end FASTQ file source for alignme nt.",
1950 "id": "PairedFastqSource",
1685 "properties": { 1951 "properties": {
1686 "commandLine": { 1952 "firstSourceUris": {
1687 "description": "(CL) Command line.", 1953 "description": "A list of URIs pointing at paired end FASTQ files in Google Cloud Storage which will be aligned. The first of each paired fi le should be specified here, in an order that matches the second of each paired file specified in secondSourceUris. For example: firstSourceUris: [file1_1.fq, f ile2_1.fq], secondSourceUris: [file1_2.fq, file2_2.fq]. The caller must have REA D permissions for these files.",
1954 "items": {
1955 "type": "string"
1956 },
1957 "type": "array"
1958 },
1959 "metadata": {
1960 "$ref": "FastqMetadata",
1961 "description": "Optionally specifies the metadata to be asso ciated with the final aligned read group set."
1962 },
1963 "secondSourceUris": {
1964 "description": "A list of URIs pointing at paired end FASTQ files in Google Cloud Storage which will be aligned. The second of each paired f ile should be specified here, in an order that matches the first of each paired file specified in firstSourceUris. For example: firstSourceUris: [file1_1.fq, fi le2_1.fq], secondSourceUris: [file1_2.fq, file2_2.fq]. The caller must have READ permissions for these files.",
1965 "items": {
1966 "type": "string"
1967 },
1968 "type": "array"
1969 }
1970 },
1971 "type": "object"
1972 },
1973 "Position": {
1974 "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.",
1975 "id": "Position",
1976 "properties": {
1977 "position": {
1978 "description": "The 0-based offset from the start of the for ward strand for that reference.",
1979 "format": "int64",
1688 "type": "string" 1980 "type": "string"
1689 }, 1981 },
1690 "id": { 1982 "referenceName": {
1691 "description": "(ID) Program record identifier.", 1983 "description": "The name of the reference in whatever refere nce set is being used.",
1692 "type": "string" 1984 "type": "string"
1693 }, 1985 },
1694 "name": { 1986 "reverseStrand": {
1695 "description": "(PN) Program name.", 1987 "description": "Whether this position is on the reverse stra nd, as opposed to the forward strand.",
1988 "type": "boolean"
1989 }
1990 },
1991 "type": "object"
1992 },
1993 "Range": {
1994 "description": "A 0-based half-open genomic coordinate range over a reference sequence.",
1995 "id": "Range",
1996 "properties": {
1997 "end": {
1998 "description": "The end position of the range on the referen ce, 0-based exclusive. If specified, referenceName must also be specified.",
1999 "format": "int64",
1696 "type": "string" 2000 "type": "string"
1697 }, 2001 },
1698 "prevProgramId": { 2002 "referenceName": {
1699 "description": "(PP) Previous program ID.", 2003 "description": "The reference sequence name, for example chr 1, 1, or chrX.",
1700 "type": "string" 2004 "type": "string"
1701 }, 2005 },
1702 "version": { 2006 "start": {
1703 "description": "(VN) Program version.", 2007 "description": "The start position of the range on the refer ence, 0-based inclusive. If specified, referenceName must also be specified.",
2008 "format": "int64",
1704 "type": "string" 2009 "type": "string"
1705 } 2010 }
1706 }, 2011 },
1707 "type": "object" 2012 "type": "object"
1708 }, 2013 },
1709 "Read": { 2014 "Read": {
1710 "description": "A Read is a group of bases that may or may not have been aligned to a reference. It contains quality information and other metadata. ", 2015 "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.",
1711 "id": "Read", 2016 "id": "Read",
1712 "properties": { 2017 "properties": {
1713 "alignedBases": { 2018 "alignedQuality": {
1714 "description": "The originalBases after the cigar field has been applied. Deletions are represented with '-' and insertions are omitted.", 2019 "description": "The quality of the read sequence contained i n this alignment record. alignedSequence and alignedQuality 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. When this occurs, the CIGAR fo r this read will begin/end with a hard clip operator that will indicate the leng th of the excised sequence.",
2020 "items": {
2021 "format": "int32",
2022 "type": "integer"
2023 },
2024 "type": "array"
2025 },
2026 "alignedSequence": {
2027 "description": "The bases of the read sequence contained in this alignment record. alignedSequence and alignedQuality may be shorter than th e full read sequence 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 begin/end with a hard clip operator that will indicate the length of the excised sequence.",
1715 "type": "string" 2028 "type": "string"
1716 }, 2029 },
1717 "baseQuality": { 2030 "alignment": {
1718 "description": "Represents the quality of each base in this read. Each character represents one base. To get the quality, take the ASCII val ue of the character and subtract 33. (QUAL)", 2031 "$ref": "LinearAlignment",
1719 "type": "string" 2032 "description": "The linear alignment for this alignment reco rd. This field will be null if the read is unmapped."
1720 }, 2033 },
1721 "cigar": { 2034 "duplicateFragment": {
1722 "description": "A condensed representation of how this read matches up to the reference. (CIGAR)", 2035 "description": "The fragment is a PCR or optical duplicate ( SAM flag 0x400)",
1723 "type": "string" 2036 "type": "boolean"
1724 }, 2037 },
1725 "flags": { 2038 "failedVendorQualityChecks": {
1726 "description": "Each bit of this number has a different mean ing if enabled. See the full BAM spec for more details. (FLAG)", 2039 "description": "SAM flag 0x200",
2040 "type": "boolean"
2041 },
2042 "fragmentLength": {
2043 "description": "The observed length of the fragment, equival ent to TLEN in SAM.",
1727 "format": "int32", 2044 "format": "int32",
1728 "type": "integer" 2045 "type": "integer"
1729 }, 2046 },
1730 "id": { 2047 "fragmentName": {
1731 "description": "The Google generated ID of the read, immutab le.", 2048 "description": "The fragment name. Equivalent to QNAME (quer y template name) in SAM.",
1732 "type": "string" 2049 "type": "string"
1733 }, 2050 },
1734 "mappingQuality": { 2051 "id": {
1735 "description": "A score up to 255 that represents how likely this read's aligned position is to be correct. A higher value is better. (MAPQ) ", 2052 "description": "The unique ID for this read. This is a gener ated unique ID, not to be confused with fragmentName.",
2053 "type": "string"
2054 },
2055 "info": {
2056 "additionalProperties": {
2057 "description": "A string which maps to an array of value s.",
2058 "items": {
2059 "type": "string"
2060 },
2061 "type": "array"
2062 },
2063 "description": "A map of additional read alignment informati on.",
2064 "type": "object"
2065 },
2066 "nextMatePosition": {
2067 "$ref": "Position",
2068 "description": "The mapping of the primary alignment of the (readNumber+1)%numberReads read in the fragment. It replaces mate position and m ate strand in SAM."
2069 },
2070 "numberReads": {
2071 "description": "The number of reads in the fragment (extensi on to SAM flag 0x1).",
1736 "format": "int32", 2072 "format": "int32",
1737 "type": "integer" 2073 "type": "integer"
1738 }, 2074 },
1739 "matePosition": { 2075 "properPlacement": {
1740 "description": "The 1-based start position of the paired rea d. (PNEXT)", 2076 "description": "The orientation and the distance between rea ds from the fragment are consistent with the sequencing protocol (extension to S AM flag 0x2)",
2077 "type": "boolean"
2078 },
2079 "readGroupId": {
2080 "description": "The ID of the read group this read belongs t o. (Every read must belong to exactly one read group.)",
2081 "type": "string"
2082 },
2083 "readGroupSetId": {
2084 "description": "The ID of the read group set this read belon gs to. (Every read must belong to exactly one read group set.)",
2085 "type": "string"
2086 },
2087 "readNumber": {
2088 "description": "The read number in sequencing. 0-based and l ess than numberReads. This field replaces SAM flag 0x40 and 0x80.",
1741 "format": "int32", 2089 "format": "int32",
1742 "type": "integer" 2090 "type": "integer"
1743 }, 2091 },
1744 "mateReferenceSequenceName": { 2092 "secondaryAlignment": {
1745 "description": "The name of the sequence that the paired rea d is aligned to. This is usually the same as referenceSequenceName. (RNEXT)", 2093 "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.",
2094 "type": "boolean"
2095 },
2096 "supplementaryAlignment": {
2097 "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.",
2098 "type": "boolean"
2099 }
2100 },
2101 "type": "object"
2102 },
2103 "ReadGroup": {
2104 "description": "A read group is all the data that's processed the sa me way by the sequencer.",
2105 "id": "ReadGroup",
2106 "properties": {
2107 "datasetId": {
2108 "description": "The ID of the dataset this read group belong s to.",
1746 "type": "string" 2109 "type": "string"
1747 }, 2110 },
1748 "name": { 2111 "description": {
1749 "description": "The name of the read. When imported from a B AM file, this is the query template name. (QNAME)", 2112 "description": "A free-form text description of this read gr oup.",
1750 "type": "string" 2113 "type": "string"
1751 }, 2114 },
1752 "originalBases": { 2115 "experiment": {
1753 "description": "The list of bases that this read represents (such as \"CATCGA\"). (SEQ)", 2116 "$ref": "ReadGroupExperiment",
2117 "description": "The experiment used to generate this read gr oup."
2118 },
2119 "id": {
2120 "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.",
1754 "type": "string" 2121 "type": "string"
1755 }, 2122 },
1756 "position": { 2123 "info": {
1757 "description": "The 1-based start position of the aligned re ad. If the first base starts at the very beginning of the reference sequence, th en the position would be '1'. (POS)",
1758 "format": "int32",
1759 "type": "integer"
1760 },
1761 "readsetId": {
1762 "description": "The ID of the readset this read belongs to." ,
1763 "type": "string"
1764 },
1765 "referenceSequenceName": {
1766 "description": "The name of the sequence that this read is a ligned to. This would be, for example, 'X' for the X Chromosome or '20' for Chro mosome 20. (RNAME)",
1767 "type": "string"
1768 },
1769 "tags": {
1770 "additionalProperties": { 2124 "additionalProperties": {
1771 "description": "A string which maps to an array of value s.", 2125 "description": "A string which maps to an array of value s.",
1772 "items": { 2126 "items": {
1773 "type": "string" 2127 "type": "string"
1774 }, 2128 },
1775 "type": "array" 2129 "type": "array"
1776 }, 2130 },
1777 "description": "A map of additional read information. (TAG)" , 2131 "description": "A map of additional read group information." ,
1778 "type": "object" 2132 "type": "object"
1779 }, 2133 },
1780 "templateLength": { 2134 "name": {
1781 "description": "Length of the original piece of DNA that pro duced both this read and the paired read. (TLEN)", 2135 "description": "The read group name. This corresponds to the @RG ID field in the SAM spec.",
1782 "format": "int32",
1783 "type": "integer"
1784 }
1785 },
1786 "type": "object"
1787 },
1788 "ReadGroup": {
1789 "id": "ReadGroup",
1790 "properties": {
1791 "date": {
1792 "description": "(DT) Date the run was produced (ISO8601 date or date/time).",
1793 "type": "string"
1794 },
1795 "description": {
1796 "description": "(DS) Description.",
1797 "type": "string"
1798 },
1799 "flowOrder": {
1800 "description": "(FO) Flow order. The array of nucleotide bas es that correspond to the nucleotides used for each flow of each read.",
1801 "type": "string"
1802 },
1803 "id": {
1804 "description": "(ID) Read group identifier.",
1805 "type": "string"
1806 },
1807 "keySequence": {
1808 "description": "(KS) The array of nucleotide bases that corr espond to the key sequence of each read.",
1809 "type": "string"
1810 },
1811 "library": {
1812 "description": "(LS) Library.",
1813 "type": "string"
1814 },
1815 "platformUnit": {
1816 "description": "(PU) Platform unit.",
1817 "type": "string" 2136 "type": "string"
1818 }, 2137 },
1819 "predictedInsertSize": { 2138 "predictedInsertSize": {
1820 "description": "(PI) Predicted median insert size.", 2139 "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.",
1821 "format": "int32", 2140 "format": "int32",
1822 "type": "integer" 2141 "type": "integer"
1823 }, 2142 },
1824 "processingProgram": { 2143 "programs": {
1825 "description": "(PG) Programs used for processing the read g roup.", 2144 "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.",
2145 "items": {
2146 "$ref": "ReadGroupProgram"
2147 },
2148 "type": "array"
2149 },
2150 "referenceSetId": {
2151 "description": "The reference set the reads in this read gro up are aligned to. Required if there are any read alignments.",
1826 "type": "string" 2152 "type": "string"
1827 }, 2153 },
1828 "sample": { 2154 "sampleId": {
1829 "description": "(SM) Sample.", 2155 "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.",
1830 "type": "string"
1831 },
1832 "sequencingCenterName": {
1833 "description": "(CN) Name of sequencing center producing the read.",
1834 "type": "string"
1835 },
1836 "sequencingTechnology": {
1837 "description": "(PL) Platform/technology used to produce the reads.",
1838 "type": "string" 2156 "type": "string"
1839 } 2157 }
1840 }, 2158 },
1841 "type": "object" 2159 "type": "object"
1842 }, 2160 },
1843 "Readset": { 2161 "ReadGroupExperiment": {
1844 "description": "A Readset is a collection of Reads.", 2162 "id": "ReadGroupExperiment",
1845 "id": "Readset", 2163 "properties": {
2164 "instrumentModel": {
2165 "description": "The instrument model used as part of this ex periment. This maps to sequencing technology in BAM.",
2166 "type": "string"
2167 },
2168 "libraryId": {
2169 "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.",
2170 "type": "string"
2171 },
2172 "platformUnit": {
2173 "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",
2174 "type": "string"
2175 },
2176 "sequencingCenter": {
2177 "description": "The sequencing center used as part of this e xperiment.",
2178 "type": "string"
2179 }
2180 },
2181 "type": "object"
2182 },
2183 "ReadGroupProgram": {
2184 "id": "ReadGroupProgram",
2185 "properties": {
2186 "commandLine": {
2187 "description": "The command line used to run this program.",
2188 "type": "string"
2189 },
2190 "id": {
2191 "description": "The user specified locally unique ID of the program. Used along with prevProgramId to define an ordering between programs.",
2192 "type": "string"
2193 },
2194 "name": {
2195 "description": "The name of the program.",
2196 "type": "string"
2197 },
2198 "prevProgramId": {
2199 "description": "The ID of the program run before this one.",
2200 "type": "string"
2201 },
2202 "version": {
2203 "description": "The version of the program run.",
2204 "type": "string"
2205 }
2206 },
2207 "type": "object"
2208 },
2209 "ReadGroupSet": {
2210 "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.",
2211 "id": "ReadGroupSet",
1846 "properties": { 2212 "properties": {
1847 "datasetId": { 2213 "datasetId": {
1848 "description": "The ID of the dataset this readset belongs t o.", 2214 "description": "The dataset ID.",
1849 "type": "string" 2215 "type": "string"
1850 }, 2216 },
1851 "fileData": { 2217 "filename": {
1852 "description": "File information from the original BAM impor t. See the BAM format specification for additional information on each field.", 2218 "description": "The filename of the original source file for this read group set, if any.",
2219 "type": "string"
2220 },
2221 "id": {
2222 "description": "The read group set ID.",
2223 "type": "string"
2224 },
2225 "name": {
2226 "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. ",
2227 "type": "string"
2228 },
2229 "readGroups": {
2230 "description": "The read groups in this set. There are typic ally 1-10 read groups in a read group set.",
1853 "items": { 2231 "items": {
1854 "$ref": "HeaderSection" 2232 "$ref": "ReadGroup"
1855 }, 2233 },
1856 "type": "array" 2234 "type": "array"
1857 }, 2235 },
2236 "referenceSetId": {
2237 "description": "The reference set the reads in this read gro up set are aligned to.",
2238 "type": "string"
2239 }
2240 },
2241 "type": "object"
2242 },
2243 "Reference": {
2244 "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.",
2245 "id": "Reference",
2246 "properties": {
1858 "id": { 2247 "id": {
1859 "description": "The Google generated ID of the readset, immu table.", 2248 "description": "The Google generated immutable ID of the ref erence.",
2249 "type": "string"
2250 },
2251 "length": {
2252 "description": "The length of this reference's sequence.",
2253 "format": "int64",
2254 "type": "string"
2255 },
2256 "md5checksum": {
2257 "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.",
1860 "type": "string" 2258 "type": "string"
1861 }, 2259 },
1862 "name": { 2260 "name": {
1863 "description": "The readset name, typically this is the samp le name.", 2261 "description": "The name of this reference, for example 22." ,
2262 "type": "string"
2263 },
2264 "ncbiTaxonId": {
2265 "description": "ID from http://www.ncbi.nlm.nih.gov/taxonomy (e.g. 9606->human) if not specified by the containing reference set.",
2266 "format": "int32",
2267 "type": "integer"
2268 },
2269 "sourceAccessions": {
2270 "description": "All known corresponding accession IDs in INS DC (GenBank/ENA/DDBJ) ideally with a version number, for example GCF_000001405.2 6.",
2271 "items": {
2272 "type": "string"
2273 },
2274 "type": "array"
2275 },
2276 "sourceURI": {
2277 "description": "The URI from which the sequence was obtained . Specifies a FASTA format file/string with one name, sequence pair.",
1864 "type": "string" 2278 "type": "string"
1865 } 2279 }
1866 }, 2280 },
1867 "type": "object" 2281 "type": "object"
1868 }, 2282 },
1869 "ReferenceBound": { 2283 "ReferenceBound": {
1870 "description": "ReferenceBound records an upper bound for the starti ng coordinate of variants in a particular reference.", 2284 "description": "ReferenceBound records an upper bound for the starti ng coordinate of variants in a particular reference.",
1871 "id": "ReferenceBound", 2285 "id": "ReferenceBound",
1872 "properties": { 2286 "properties": {
1873 "referenceName": { 2287 "referenceName": {
1874 "description": "The reference the bound is associate with.", 2288 "description": "The reference the bound is associate with.",
1875 "type": "string" 2289 "type": "string"
1876 }, 2290 },
1877 "upperBound": { 2291 "upperBound": {
1878 "description": "An upper bound (inclusive) on the starting c oordinate of any variant in the reference sequence.", 2292 "description": "An upper bound (inclusive) on the starting c oordinate of any variant in the reference sequence.",
1879 "format": "int64", 2293 "format": "int64",
1880 "type": "string" 2294 "type": "string"
1881 } 2295 }
1882 }, 2296 },
1883 "type": "object" 2297 "type": "object"
1884 }, 2298 },
1885 "ReferenceSequence": { 2299 "ReferenceSet": {
1886 "id": "ReferenceSequence", 2300 "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.",
2301 "id": "ReferenceSet",
1887 "properties": { 2302 "properties": {
1888 "assemblyId": { 2303 "assemblyId": {
1889 "description": "(AS) Genome assembly identifier.", 2304 "description": "Public id of this reference set, such as GRC h37.",
1890 "type": "string" 2305 "type": "string"
1891 }, 2306 },
1892 "length": { 2307 "description": {
1893 "description": "(LN) Reference sequence length.", 2308 "description": "Optional free text description of this refer ence set.",
2309 "type": "string"
2310 },
2311 "id": {
2312 "description": "The Google generated immutable ID of the ref erence set.",
2313 "type": "string"
2314 },
2315 "md5checksum": {
2316 "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.",
2317 "type": "string"
2318 },
2319 "ncbiTaxonId": {
2320 "description": "ID from http://www.ncbi.nlm.nih.gov/taxonomy (e.g. 9606->human) indicating the species which this assembly is intended to mo del. Note that contained references may specify a different ncbiTaxonId, as asse mblies may contain reference sequences which do not belong to the modeled specie s, e.g. EBV in a human reference genome.",
1894 "format": "int32", 2321 "format": "int32",
1895 "type": "integer" 2322 "type": "integer"
1896 }, 2323 },
1897 "md5Checksum": { 2324 "referenceIds": {
1898 "description": "(M5) MD5 checksum of the sequence in the upp ercase, excluding spaces but including pads as *.", 2325 "description": "The IDs of the reference objects that are pa rt of this set. Reference.md5checksum must be unique within this set.",
1899 "type": "string" 2326 "items": {
2327 "type": "string"
2328 },
2329 "type": "array"
1900 }, 2330 },
1901 "name": { 2331 "sourceAccessions": {
1902 "description": "(SN) Reference sequence name.", 2332 "description": "All known corresponding accession IDs in INS DC (GenBank/ENA/DDBJ) ideally with a version number, for example NC_000001.11.",
1903 "type": "string" 2333 "items": {
2334 "type": "string"
2335 },
2336 "type": "array"
1904 }, 2337 },
1905 "species": { 2338 "sourceURI": {
1906 "description": "(SP) Species.", 2339 "description": "The URI from which the references were obtai ned.",
1907 "type": "string"
1908 },
1909 "uri": {
1910 "description": "(UR) URI of the sequence.",
1911 "type": "string" 2340 "type": "string"
1912 } 2341 }
1913 }, 2342 },
1914 "type": "object" 2343 "type": "object"
1915 }, 2344 },
1916 "SearchCallSetsRequest": { 2345 "SearchCallSetsRequest": {
1917 "description": "The call set search request.", 2346 "description": "The call set search request.",
1918 "id": "SearchCallSetsRequest", 2347 "id": "SearchCallSetsRequest",
1919 "properties": { 2348 "properties": {
1920 "name": { 2349 "name": {
(...skipping 44 matching lines...) Expand 10 before | Expand all | Expand 10 after
1965 "createdAfter": { 2394 "createdAfter": {
1966 "description": "If specified, only jobs created on or after this date, given in milliseconds since Unix epoch, will be returned.", 2395 "description": "If specified, only jobs created on or after this date, given in milliseconds since Unix epoch, will be returned.",
1967 "format": "int64", 2396 "format": "int64",
1968 "type": "string" 2397 "type": "string"
1969 }, 2398 },
1970 "createdBefore": { 2399 "createdBefore": {
1971 "description": "If specified, only jobs created prior to thi s date, given in milliseconds since Unix epoch, will be returned.", 2400 "description": "If specified, only jobs created prior to thi s date, given in milliseconds since Unix epoch, will be returned.",
1972 "format": "int64", 2401 "format": "int64",
1973 "type": "string" 2402 "type": "string"
1974 }, 2403 },
1975 "maxResults": { 2404 "pageSize": {
1976 "description": "Specifies the number of results to return in a single page. Defaults to 128. The maximum value is 256.", 2405 "description": "Specifies the number of results to return in a single page. Defaults to 128. The maximum value is 256.",
1977 "format": "uint64", 2406 "format": "int32",
1978 "type": "string" 2407 "type": "integer"
1979 }, 2408 },
1980 "pageToken": { 2409 "pageToken": {
1981 "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.", 2410 "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.",
1982 "type": "string" 2411 "type": "string"
1983 }, 2412 },
1984 "projectId": { 2413 "projectNumber": {
1985 "description": "Required. Only return jobs which belong to t his Google Developers", 2414 "description": "Required. Only return jobs which belong to t his Google Developers",
1986 "format": "int64", 2415 "format": "int64",
1987 "type": "string" 2416 "type": "string"
1988 }, 2417 },
1989 "status": { 2418 "status": {
1990 "description": "Only return jobs which have a matching statu s.", 2419 "description": "Only return jobs which have a matching statu s.",
1991 "items": { 2420 "items": {
1992 "enum": [ 2421 "enum": [
1993 "canceled", 2422 "CANCELED",
1994 "failure", 2423 "FAILURE",
1995 "new", 2424 "NEW",
1996 "pending", 2425 "PENDING",
1997 "running", 2426 "RUNNING",
1998 "success", 2427 "SUCCESS",
1999 "unknownStatus" 2428 "UNKNOWN_STATUS"
2000 ], 2429 ],
2001 "enumDescriptions": [ 2430 "enumDescriptions": [
2002 "", 2431 "",
2003 "", 2432 "",
2004 "", 2433 "",
2005 "", 2434 "",
2006 "", 2435 "",
2007 "", 2436 "",
2008 "" 2437 ""
2009 ], 2438 ],
(...skipping 15 matching lines...) Expand all
2025 }, 2454 },
2026 "type": "array" 2455 "type": "array"
2027 }, 2456 },
2028 "nextPageToken": { 2457 "nextPageToken": {
2029 "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 .", 2458 "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 .",
2030 "type": "string" 2459 "type": "string"
2031 } 2460 }
2032 }, 2461 },
2033 "type": "object" 2462 "type": "object"
2034 }, 2463 },
2464 "SearchReadGroupSetsRequest": {
2465 "description": "The read group set search request.",
2466 "id": "SearchReadGroupSetsRequest",
2467 "properties": {
2468 "datasetIds": {
2469 "description": "Restricts this query to read group sets with in the given datasets. At least one ID must be provided.",
2470 "items": {
2471 "type": "string"
2472 },
2473 "type": "array"
2474 },
2475 "name": {
2476 "description": "Only return read group sets for which a subs tring of the name matches this string.",
2477 "type": "string"
2478 },
2479 "pageSize": {
2480 "description": "Specifies number of results to return in a s ingle page. If unspecified, it will default to 128. The maximum value is 1024.",
2481 "format": "int32",
2482 "type": "integer"
2483 },
2484 "pageToken": {
2485 "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.",
2486 "type": "string"
2487 }
2488 },
2489 "type": "object"
2490 },
2491 "SearchReadGroupSetsResponse": {
2492 "description": "The read group set search response.",
2493 "id": "SearchReadGroupSetsResponse",
2494 "properties": {
2495 "nextPageToken": {
2496 "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.",
2497 "type": "string"
2498 },
2499 "readGroupSets": {
2500 "description": "The list of matching read group sets.",
2501 "items": {
2502 "$ref": "ReadGroupSet"
2503 },
2504 "type": "array"
2505 }
2506 },
2507 "type": "object"
2508 },
2035 "SearchReadsRequest": { 2509 "SearchReadsRequest": {
2036 "description": "The read search request.", 2510 "description": "The read search request.",
2037 "id": "SearchReadsRequest", 2511 "id": "SearchReadsRequest",
2038 "properties": { 2512 "properties": {
2039 "maxResults": { 2513 "end": {
2514 "description": "The end position of the range on the referen ce, 0-based exclusive. If specified, referenceName must also be specified.",
2515 "format": "int64",
2516 "type": "string"
2517 },
2518 "pageSize": {
2040 "description": "Specifies number of results to return in a s ingle page. If unspecified, it will default to 256. The maximum value is 2048.", 2519 "description": "Specifies number of results to return in a s ingle page. If unspecified, it will default to 256. The maximum value is 2048.",
2041 "format": "uint64", 2520 "format": "int32",
2042 "type": "string" 2521 "type": "integer"
2043 }, 2522 },
2044 "pageToken": { 2523 "pageToken": {
2045 "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.", 2524 "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.",
2046 "type": "string" 2525 "type": "string"
2047 }, 2526 },
2048 "readsetIds": { 2527 "readGroupIds": {
2049 "description": "The readsets within which to search for read s. At least one readset ID must be provided. All specified readsets must be alig ned against a common set of reference sequences; this defines the genomic coordi nates for the query.", 2528 "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.",
2050 "items": { 2529 "items": {
2051 "type": "string" 2530 "type": "string"
2052 }, 2531 },
2053 "type": "array" 2532 "type": "array"
2054 }, 2533 },
2055 "sequenceEnd": { 2534 "readGroupSetIds": {
2056 "description": "The end position (1-based, inclusive) of the target range. If specified, sequenceName must also be specified. Defaults to th e end of the target reference sequence, if any.", 2535 "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.",
2057 "format": "uint64", 2536 "items": {
2537 "type": "string"
2538 },
2539 "type": "array"
2540 },
2541 "referenceName": {
2542 "description": "The reference sequence name, for example chr 1, 1, or chrX. If set to *, only unmapped reads are returned.",
2058 "type": "string" 2543 "type": "string"
2059 }, 2544 },
2060 "sequenceName": { 2545 "start": {
2061 "description": "Restricts the results to a particular refere nce sequence such as 1, chr1, or X. The set of valid references sequences depend s on the readsets specified. If set to *, only unmapped Reads are returned.", 2546 "description": "The start position of the range on the refer ence, 0-based inclusive. If specified, referenceName must also be specified.",
2062 "type": "string" 2547 "format": "int64",
2063 },
2064 "sequenceStart": {
2065 "description": "The start position (1-based, inclusive) of t he target range. If specified, sequenceName must also be specified. Defaults to the start of the target reference sequence, if any.",
2066 "format": "uint64",
2067 "type": "string" 2548 "type": "string"
2068 } 2549 }
2069 }, 2550 },
2070 "type": "object" 2551 "type": "object"
2071 }, 2552 },
2072 "SearchReadsResponse": { 2553 "SearchReadsResponse": {
2073 "description": "The read search response.", 2554 "description": "The read search response.",
2074 "id": "SearchReadsResponse", 2555 "id": "SearchReadsResponse",
2075 "properties": { 2556 "properties": {
2076 "nextPageToken": { 2557 "alignments": {
2077 "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.", 2558 "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 last and are further sort ed in ascending lexicographic order by fragment name.",
2078 "type": "string"
2079 },
2080 "reads": {
2081 "description": "The list of matching Reads. The resulting Re ads are sorted by position; the smallest positions are returned first. Unmapped reads, which have no position, are returned last and are further sorted alphabet ically by name.",
2082 "items": { 2559 "items": {
2083 "$ref": "Read" 2560 "$ref": "Read"
2084 }, 2561 },
2085 "type": "array" 2562 "type": "array"
2563 },
2564 "nextPageToken": {
2565 "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.",
2566 "type": "string"
2086 } 2567 }
2087 }, 2568 },
2088 "type": "object" 2569 "type": "object"
2089 }, 2570 },
2090 "SearchReadsetsRequest": { 2571 "SearchReferenceSetsRequest": {
2091 "description": "The readset search request.", 2572 "id": "SearchReferenceSetsRequest",
2092 "id": "SearchReadsetsRequest",
2093 "properties": { 2573 "properties": {
2094 "datasetIds": { 2574 "accessions": {
2095 "description": "Restricts this query to readsets within the given datasets. At least one ID must be provided.", 2575 "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.",
2096 "items": { 2576 "items": {
2097 "type": "string" 2577 "type": "string"
2098 }, 2578 },
2099 "type": "array" 2579 "type": "array"
2100 }, 2580 },
2101 "maxResults": { 2581 "md5checksums": {
2102 "description": "Specifies number of results to return in a s ingle page. If unspecified, it will default to 128. The maximum value is 1024.", 2582 "description": "If present, return references for which the md5checksum matches. See ReferenceSet.md5checksum for details.",
2103 "format": "uint64", 2583 "items": {
2104 "type": "string" 2584 "type": "string"
2585 },
2586 "type": "array"
2105 }, 2587 },
2106 "name": { 2588 "pageSize": {
2107 "description": "Only return readsets for which a substring o f the name matches this string.", 2589 "description": "Specifies the maximum number of results to r eturn in a single page.",
2108 "type": "string" 2590 "format": "int32",
2591 "type": "integer"
2109 }, 2592 },
2110 "pageToken": { 2593 "pageToken": {
2111 "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.", 2594 "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.",
2112 "type": "string" 2595 "type": "string"
2113 } 2596 }
2114 }, 2597 },
2115 "type": "object" 2598 "type": "object"
2116 }, 2599 },
2117 "SearchReadsetsResponse": { 2600 "SearchReferenceSetsResponse": {
2118 "description": "The readset search response.", 2601 "id": "SearchReferenceSetsResponse",
2119 "id": "SearchReadsetsResponse",
2120 "properties": { 2602 "properties": {
2121 "nextPageToken": { 2603 "nextPageToken": {
2122 "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.", 2604 "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.",
2123 "type": "string" 2605 "type": "string"
2124 }, 2606 },
2125 "readsets": { 2607 "referenceSets": {
2126 "description": "The list of matching Readsets.", 2608 "description": "The matching references sets.",
2127 "items": { 2609 "items": {
2128 "$ref": "Readset" 2610 "$ref": "ReferenceSet"
2129 }, 2611 },
2130 "type": "array" 2612 "type": "array"
2131 } 2613 }
2614 },
2615 "type": "object"
2616 },
2617 "SearchReferencesRequest": {
2618 "description": "",
2619 "id": "SearchReferencesRequest",
2620 "properties": {
2621 "accessions": {
2622 "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.",
2623 "items": {
2624 "type": "string"
2625 },
2626 "type": "array"
2627 },
2628 "md5checksums": {
2629 "description": "If present, return references for which the md5checksum matches. See Reference.md5checksum for construction details.",
2630 "items": {
2631 "type": "string"
2632 },
2633 "type": "array"
2634 },
2635 "pageSize": {
2636 "description": "Specifies the maximum number of results to r eturn in a single page.",
2637 "format": "int32",
2638 "type": "integer"
2639 },
2640 "pageToken": {
2641 "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.",
2642 "type": "string"
2643 },
2644 "referenceSetId": {
2645 "description": "If present, return only references which bel ong to this reference set.",
2646 "type": "string"
2647 }
2648 },
2649 "type": "object"
2650 },
2651 "SearchReferencesResponse": {
2652 "id": "SearchReferencesResponse",
2653 "properties": {
2654 "nextPageToken": {
2655 "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.",
2656 "type": "string"
2657 },
2658 "references": {
2659 "description": "The matching references.",
2660 "items": {
2661 "$ref": "Reference"
2662 },
2663 "type": "array"
2664 }
2132 }, 2665 },
2133 "type": "object" 2666 "type": "object"
2134 }, 2667 },
2135 "SearchVariantSetsRequest": { 2668 "SearchVariantSetsRequest": {
2136 "description": "The search variant sets request.", 2669 "description": "The search variant sets request.",
2137 "id": "SearchVariantSetsRequest", 2670 "id": "SearchVariantSetsRequest",
2138 "properties": { 2671 "properties": {
2139 "datasetIds": { 2672 "datasetIds": {
2140 "description": "Exactly one dataset ID must be provided here . Only variant sets which belong to this dataset will be returned.", 2673 "description": "Exactly one dataset ID must be provided here . Only variant sets which belong to this dataset will be returned.",
2141 "items": { 2674 "items": {
(...skipping 96 matching lines...) Expand 10 before | Expand all | Expand 10 after
2238 "description": "The list of matching Variants.", 2771 "description": "The list of matching Variants.",
2239 "items": { 2772 "items": {
2240 "$ref": "Variant" 2773 "$ref": "Variant"
2241 }, 2774 },
2242 "type": "array" 2775 "type": "array"
2243 } 2776 }
2244 }, 2777 },
2245 "type": "object" 2778 "type": "object"
2246 }, 2779 },
2247 "Variant": { 2780 "Variant": {
2248 "description": "A Variant represents a change in DNA sequence relati ve to some reference. For example, a Variant could represent a SNP or an inserti on. Variants belong to a variant set.", 2781 "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.",
2249 "id": "Variant", 2782 "id": "Variant",
2250 "properties": { 2783 "properties": {
2251 "alternateBases": { 2784 "alternateBases": {
2252 "description": "The bases that appear instead of the referen ce bases.", 2785 "description": "The bases that appear instead of the referen ce bases.",
2253 "items": { 2786 "items": {
2254 "type": "string" 2787 "type": "string"
2255 }, 2788 },
2256 "type": "array" 2789 "type": "array"
2257 }, 2790 },
2258 "calls": { 2791 "calls": {
(...skipping 61 matching lines...) Expand 10 before | Expand all | Expand 10 after
2320 "type": "string" 2853 "type": "string"
2321 }, 2854 },
2322 "variantSetId": { 2855 "variantSetId": {
2323 "description": "The ID of the variant set this variant belon gs to.", 2856 "description": "The ID of the variant set this variant belon gs to.",
2324 "type": "string" 2857 "type": "string"
2325 } 2858 }
2326 }, 2859 },
2327 "type": "object" 2860 "type": "object"
2328 }, 2861 },
2329 "VariantSet": { 2862 "VariantSet": {
2330 "description": "A VariantSet represents a collection of Variants and their summary statistics.", 2863 "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.",
2331 "id": "VariantSet", 2864 "id": "VariantSet",
2332 "properties": { 2865 "properties": {
2333 "datasetId": { 2866 "datasetId": {
2334 "description": "The dataset to which this variant set belong s. Immutable.", 2867 "description": "The dataset to which this variant set belong s. Immutable.",
2335 "type": "string" 2868 "type": "string"
2336 }, 2869 },
2337 "id": { 2870 "id": {
2338 "description": "The Google-generated ID of the variant set. Immutable.", 2871 "description": "The Google-generated ID of the variant set. Immutable.",
2339 "type": "string" 2872 "type": "string"
2340 }, 2873 },
2341 "metadata": { 2874 "metadata": {
2342 "description": "The metadata associated with this variant se t.", 2875 "description": "The metadata associated with this variant se t.",
2343 "items": { 2876 "items": {
2344 "$ref": "Metadata" 2877 "$ref": "Metadata"
2345 }, 2878 },
2346 "type": "array" 2879 "type": "array"
2347 }, 2880 },
2348 "referenceBounds": { 2881 "referenceBounds": {
2349 "description": "A list of all references used by the variant s in a variant set with associated coordinate upper bounds for each one.", 2882 "description": "A list of all references used by the variant s in a variant set with associated coordinate upper bounds for each one.",
2350 "items": { 2883 "items": {
2351 "$ref": "ReferenceBound" 2884 "$ref": "ReferenceBound"
2352 }, 2885 },
2353 "type": "array" 2886 "type": "array"
2354 } 2887 }
2355 }, 2888 },
2356 "type": "object" 2889 "type": "object"
2357 } 2890 }
2358 }, 2891 },
2359 "servicePath": "genomics/v1beta/", 2892 "servicePath": "genomics/v1beta2/",
2360 "title": "Genomics API", 2893 "title": "Genomics API",
2361 "version": "v1beta" 2894 "version": "v1beta2"
2362 } 2895 }
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698