OLD | NEW |
1 { | 1 { |
2 "auth": { | 2 "auth": { |
3 "oauth2": { | 3 "oauth2": { |
4 "scopes": { | 4 "scopes": { |
5 "https://www.googleapis.com/auth/bigquery": { | |
6 "description": "View and manage your data in Google BigQuery
" | |
7 }, | |
8 "https://www.googleapis.com/auth/cloud-platform": { | 5 "https://www.googleapis.com/auth/cloud-platform": { |
9 "description": "View and manage your data across Google Clou
d Platform services" | 6 "description": "View and manage your data across Google Clou
d Platform services" |
10 }, | 7 }, |
11 "https://www.googleapis.com/auth/devstorage.read_write": { | 8 "https://www.googleapis.com/auth/genomics.readonly": { |
12 "description": "Manage your data in Google Cloud Storage" | 9 "description": "View Genomics data" |
13 }, | 10 }, |
14 "https://www.googleapis.com/auth/genomics": { | 11 "https://www.googleapis.com/auth/genomics": { |
15 "description": "View and manage Genomics data" | 12 "description": "View and manage Genomics data" |
16 }, | 13 }, |
17 "https://www.googleapis.com/auth/genomics.readonly": { | 14 "https://www.googleapis.com/auth/bigquery": { |
18 "description": "View Genomics data" | 15 "description": "View and manage your data in Google BigQuery
" |
| 16 }, |
| 17 "https://www.googleapis.com/auth/devstorage.read_write": { |
| 18 "description": "Manage your data in Google Cloud Storage" |
19 } | 19 } |
20 } | 20 } |
21 } | 21 } |
22 }, | 22 }, |
23 "basePath": "", | 23 "basePath": "", |
24 "baseUrl": "https://genomics.googleapis.com/", | 24 "baseUrl": "https://genomics.googleapis.com/", |
25 "batchPath": "batch", | 25 "batchPath": "batch", |
26 "description": "Stores, processes, explores and shares genomic data.", | 26 "description": "Upload, process, query, and search Genomics data in the clou
d.", |
27 "discoveryVersion": "v1", | 27 "discoveryVersion": "v1", |
28 "documentationLink": "https://cloud.google.com/genomics/", | 28 "documentationLink": "https://cloud.google.com/genomics", |
29 "etag": "\"tbys6C40o18GZwyMen5GMkdK-3s/jo14IJ9oMjJmju16_ICU62ty30c\"", | |
30 "icons": { | 29 "icons": { |
31 "x16": "http://www.google.com/images/icons/product/search-16.gif", | 30 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
32 "x32": "http://www.google.com/images/icons/product/search-32.gif" | 31 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
33 }, | 32 }, |
34 "id": "genomics:v1", | 33 "id": "genomics:v1", |
35 "kind": "discovery#restDescription", | 34 "kind": "discovery#restDescription", |
36 "name": "genomics", | 35 "name": "genomics", |
37 "ownerDomain": "google.com", | 36 "ownerDomain": "google.com", |
38 "ownerName": "Google", | 37 "ownerName": "Google", |
39 "parameters": { | 38 "parameters": { |
40 "access_token": { | 39 "fields": { |
41 "description": "OAuth access token.", | 40 "description": "Selector specifying which fields to include in a par
tial response.", |
42 "location": "query", | 41 "location": "query", |
43 "type": "string" | 42 "type": "string" |
44 }, | 43 }, |
45 "alt": { | 44 "uploadType": { |
46 "default": "json", | 45 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
47 "description": "Data format for response.", | 46 "location": "query", |
| 47 "type": "string" |
| 48 }, |
| 49 "$.xgafv": { |
| 50 "description": "V1 error format.", |
| 51 "enum": [ |
| 52 "1", |
| 53 "2" |
| 54 ], |
48 "enumDescriptions": [ | 55 "enumDescriptions": [ |
49 "Responses with Content-Type of application/json", | 56 "v1 error format", |
50 "Media download with context-dependent Content-Type", | 57 "v2 error format" |
51 "Responses with Content-Type of application/x-protobuf" | |
52 ], | 58 ], |
53 "location": "query", | 59 "location": "query", |
54 "type": "string" | 60 "type": "string" |
55 }, | 61 }, |
56 "bearer_token": { | |
57 "description": "OAuth bearer token.", | |
58 "location": "query", | |
59 "type": "string" | |
60 }, | |
61 "callback": { | 62 "callback": { |
62 "description": "JSONP", | 63 "description": "JSONP", |
63 "location": "query", | 64 "location": "query", |
64 "type": "string" | 65 "type": "string" |
65 }, | 66 }, |
66 "fields": { | 67 "alt": { |
67 "description": "Selector specifying which fields to include in a par
tial response.", | 68 "default": "json", |
| 69 "description": "Data format for response.", |
| 70 "enum": [ |
| 71 "json", |
| 72 "media", |
| 73 "proto" |
| 74 ], |
| 75 "enumDescriptions": [ |
| 76 "Responses with Content-Type of application/json", |
| 77 "Media download with context-dependent Content-Type", |
| 78 "Responses with Content-Type of application/x-protobuf" |
| 79 ], |
68 "location": "query", | 80 "location": "query", |
69 "type": "string" | 81 "type": "string" |
70 }, | 82 }, |
71 "key": { | 83 "key": { |
72 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", | 84 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", |
73 "location": "query", | 85 "location": "query", |
74 "type": "string" | 86 "type": "string" |
75 }, | 87 }, |
76 "oauth_token": { | 88 "access_token": { |
77 "description": "OAuth 2.0 token for the current user.", | 89 "description": "OAuth access token.", |
78 "location": "query", | 90 "location": "query", |
79 "type": "string" | 91 "type": "string" |
80 }, | 92 }, |
| 93 "quotaUser": { |
| 94 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", |
| 95 "location": "query", |
| 96 "type": "string" |
| 97 }, |
81 "pp": { | 98 "pp": { |
82 "default": "true", | 99 "default": "true", |
83 "description": "Pretty-print response.", | 100 "description": "Pretty-print response.", |
84 "location": "query", | 101 "location": "query", |
85 "type": "boolean" | 102 "type": "boolean" |
86 }, | 103 }, |
87 "prettyPrint": { | 104 "oauth_token": { |
88 "default": "true", | 105 "description": "OAuth 2.0 token for the current user.", |
89 "description": "Returns response with indentations and line breaks."
, | |
90 "location": "query", | |
91 "type": "boolean" | |
92 }, | |
93 "quotaUser": { | |
94 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", | |
95 "location": "query", | 106 "location": "query", |
96 "type": "string" | 107 "type": "string" |
97 }, | 108 }, |
| 109 "bearer_token": { |
| 110 "description": "OAuth bearer token.", |
| 111 "location": "query", |
| 112 "type": "string" |
| 113 }, |
98 "upload_protocol": { | 114 "upload_protocol": { |
99 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 115 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
100 "location": "query", | 116 "location": "query", |
101 "type": "string" | 117 "type": "string" |
102 }, | 118 }, |
103 "uploadType": { | 119 "prettyPrint": { |
104 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | 120 "default": "true", |
| 121 "description": "Returns response with indentations and line breaks."
, |
105 "location": "query", | 122 "location": "query", |
106 "type": "string" | 123 "type": "boolean" |
107 }, | |
108 "$.xgafv": { | |
109 "description": "V1 error format.", | |
110 "enumDescriptions": [ | |
111 "v1 error format", | |
112 "v2 error format" | |
113 ], | |
114 "location": "query", | |
115 "type": "string" | |
116 } | 124 } |
117 }, | 125 }, |
118 "protocol": "rest", | 126 "protocol": "rest", |
119 "resources": { | 127 "resources": { |
120 "annotationsets": { | 128 "variants": { |
121 "methods": { | 129 "methods": { |
122 "create": { | 130 "search": { |
123 "description": "Creates a new annotation set. Caller must ha
ve WRITE permission for the associated dataset. The following fields are require
d: * datasetId * referenceSetId All other fields may be optionally specified, un
less documented as being server-generated (for example, the `id` field).", | 131 "description": "Gets a list of variants matching the criteri
a.\n\nFor the definitions of variants and other genomics resources, see\n[Fundam
entals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-go
ogle-genomics)\n\nImplements\n[GlobalAllianceApi.searchVariants](https://github.
com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L126).
", |
124 "httpMethod": "POST", | 132 "httpMethod": "POST", |
125 "id": "genomics.annotationsets.create", | 133 "id": "genomics.variants.search", |
126 "path": "v1/annotationsets", | 134 "parameterOrder": [], |
| 135 "parameters": {}, |
| 136 "path": "v1/variants/search", |
127 "request": { | 137 "request": { |
128 "$ref": "AnnotationSet" | 138 "$ref": "SearchVariantsRequest" |
129 }, | 139 }, |
130 "response": { | 140 "response": { |
131 "$ref": "AnnotationSet" | 141 "$ref": "SearchVariantsResponse" |
| 142 }, |
| 143 "scopes": [ |
| 144 "https://www.googleapis.com/auth/cloud-platform", |
| 145 "https://www.googleapis.com/auth/genomics", |
| 146 "https://www.googleapis.com/auth/genomics.readonly" |
| 147 ] |
| 148 }, |
| 149 "patch": { |
| 150 "description": "Updates a variant.\n\nFor the definitions of
variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](
https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis metho
d supports patch semantics. Returns the modified variant without\nits calls.", |
| 151 "httpMethod": "PATCH", |
| 152 "id": "genomics.variants.patch", |
| 153 "parameterOrder": [ |
| 154 "variantId" |
| 155 ], |
| 156 "parameters": { |
| 157 "variantId": { |
| 158 "description": "The ID of the variant to be updated.
", |
| 159 "location": "path", |
| 160 "required": true, |
| 161 "type": "string" |
| 162 }, |
| 163 "updateMask": { |
| 164 "description": "An optional mask specifying which fi
elds to update. At this time, mutable\nfields are names and\ninfo. Acceptable va
lues are \"names\" and\n\"info\". If unspecified, all mutable fields will be upd
ated.", |
| 165 "format": "google-fieldmask", |
| 166 "location": "query", |
| 167 "type": "string" |
| 168 } |
| 169 }, |
| 170 "path": "v1/variants/{variantId}", |
| 171 "request": { |
| 172 "$ref": "Variant" |
| 173 }, |
| 174 "response": { |
| 175 "$ref": "Variant" |
132 }, | 176 }, |
133 "scopes": [ | 177 "scopes": [ |
134 "https://www.googleapis.com/auth/cloud-platform", | 178 "https://www.googleapis.com/auth/cloud-platform", |
135 "https://www.googleapis.com/auth/genomics" | 179 "https://www.googleapis.com/auth/genomics" |
136 ] | 180 ] |
137 }, | 181 }, |
138 "get": { | 182 "get": { |
139 "description": "Gets an annotation set. Caller must have REA
D permission for the associated dataset.", | 183 "description": "Gets a variant by ID.\n\nFor the definitions
of variants and other genomics resources, see\n[Fundamentals of Google\nGenomic
s](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", |
140 "httpMethod": "GET", | 184 "httpMethod": "GET", |
141 "id": "genomics.annotationsets.get", | 185 "id": "genomics.variants.get", |
142 "parameterOrder": [ | 186 "parameterOrder": [ |
143 "annotationSetId" | 187 "variantId" |
144 ], | 188 ], |
145 "parameters": { | 189 "parameters": { |
146 "annotationSetId": { | 190 "variantId": { |
147 "description": "The ID of the annotation set to be r
etrieved.", | 191 "description": "The ID of the variant.", |
148 "location": "path", | 192 "location": "path", |
149 "required": true, | 193 "required": true, |
150 "type": "string" | 194 "type": "string" |
151 } | 195 } |
152 }, | 196 }, |
153 "path": "v1/annotationsets/{annotationSetId}", | 197 "path": "v1/variants/{variantId}", |
154 "response": { | 198 "response": { |
155 "$ref": "AnnotationSet" | 199 "$ref": "Variant" |
156 }, | 200 }, |
157 "scopes": [ | 201 "scopes": [ |
158 "https://www.googleapis.com/auth/cloud-platform", | 202 "https://www.googleapis.com/auth/cloud-platform", |
159 "https://www.googleapis.com/auth/genomics", | 203 "https://www.googleapis.com/auth/genomics", |
160 "https://www.googleapis.com/auth/genomics.readonly" | 204 "https://www.googleapis.com/auth/genomics.readonly" |
161 ] | 205 ] |
162 }, | 206 }, |
163 "update": { | 207 "merge": { |
164 "description": "Updates an annotation set. The update must r
espect all mutability restrictions and other invariants described on the annotat
ion set resource. Caller must have WRITE permission for the associated dataset."
, | 208 "description": "Merges the given variants with existing vari
ants.\n\nFor the definitions of variants and other genomics resources, see\n[Fun
damentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of
-google-genomics)\n\nEach variant will be\nmerged with an existing variant that
matches its reference sequence,\nstart, end, reference bases, and alternative ba
ses. If no such variant\nexists, a new one will be created.\n\nWhen variants are
merged, the call information from the new variant\nis added to the existing var
iant. Variant info fields are merged as\nspecified in the\ninfoMergeConfig\nfiel
d of the MergeVariantsRequest.\n\nPlease exercise caution when using this method
! It is easy to introduce\nmistakes in existing variants and difficult to back
out of them. For\nexample,\nsuppose you were trying to merge a new variant with
an existing one and\nboth\nvariants contain calls that belong to callsets with
the same callset ID.\n\n // Existing variant - irrelevant fields trimmed for
clarity\n {\n \"variantSetId\": \"10473108253681171589\",\n \"r
eferenceName\": \"1\",\n \"start\": \"10582\",\n \"referenceBases\
": \"G\",\n \"alternateBases\": [\n \"A\"\n ],\n
\"calls\": [\n {\n \"callSetId\": \"10473108253681171
589-0\",\n \"callSetName\": \"CALLSET0\",\n \"geno
type\": [\n 0,\n 1\n ],\n
}\n ]\n }\n\n // New variant with conflicting call inform
ation\n {\n \"variantSetId\": \"10473108253681171589\",\n \"ref
erenceName\": \"1\",\n \"start\": \"10582\",\n \"referenceBases\":
\"G\",\n \"alternateBases\": [\n \"A\"\n ],\n \
"calls\": [\n {\n \"callSetId\": \"1047310825368117158
9-0\",\n \"callSetName\": \"CALLSET0\",\n \"genoty
pe\": [\n 1,\n 1\n ],\n
}\n ]\n }\n\nThe resulting merged variant would overwrite the
existing calls with those\nfrom the new variant:\n\n {\n \"variantSetI
d\": \"10473108253681171589\",\n \"referenceName\": \"1\",\n \"sta
rt\": \"10582\",\n \"referenceBases\": \"G\",\n \"alternateBases\"
: [\n \"A\"\n ],\n \"calls\": [\n {\n
\"callSetId\": \"10473108253681171589-0\",\n \"callSetNa
me\": \"CALLSET0\",\n \"genotype\": [\n 1,\n
1\n ],\n }\n ]\n }\n\nThis
may be the desired outcome, but it is up to the user to determine if\nif that i
s indeed the case.", |
165 "httpMethod": "PUT", | 209 "httpMethod": "POST", |
166 "id": "genomics.annotationsets.update", | 210 "id": "genomics.variants.merge", |
167 "parameterOrder": [ | 211 "parameterOrder": [], |
168 "annotationSetId" | 212 "parameters": {}, |
169 ], | 213 "path": "v1/variants:merge", |
170 "parameters": { | |
171 "annotationSetId": { | |
172 "description": "The ID of the annotation set to be u
pdated.", | |
173 "location": "path", | |
174 "required": true, | |
175 "type": "string" | |
176 }, | |
177 "updateMask": { | |
178 "description": "An optional mask specifying which fi
elds to update. Mutable fields are name, source_uri, and info. If unspecified, a
ll mutable fields will be updated.", | |
179 "location": "query", | |
180 "type": "string" | |
181 } | |
182 }, | |
183 "path": "v1/annotationsets/{annotationSetId}", | |
184 "request": { | 214 "request": { |
185 "$ref": "AnnotationSet" | 215 "$ref": "MergeVariantsRequest" |
186 }, | 216 }, |
187 "response": { | 217 "response": { |
188 "$ref": "AnnotationSet" | 218 "$ref": "Empty" |
189 }, | 219 }, |
190 "scopes": [ | 220 "scopes": [ |
191 "https://www.googleapis.com/auth/cloud-platform", | 221 "https://www.googleapis.com/auth/cloud-platform", |
192 "https://www.googleapis.com/auth/genomics" | 222 "https://www.googleapis.com/auth/genomics" |
193 ] | 223 ] |
194 }, | 224 }, |
| 225 "import": { |
| 226 "description": "Creates variant data by asynchronously impor
ting the provided information.\n\nFor the definitions of variant sets and other
genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google
.com/genomics/fundamentals-of-google-genomics)\n\nThe variants for import will b
e merged with any existing variant that\nmatches its reference sequence, start,
end, reference bases, and\nalternative bases. If no such variant exists, a new o
ne will be created.\n\nWhen variants are merged, the call information from the n
ew variant\nis added to the existing variant, and Variant info fields are merged
\nas specified in\ninfoMergeConfig.\nAs a special case, for single-sample VCF fi
les, QUAL and FILTER fields will\nbe moved to the call level; these are sometime
s interpreted in a\ncall-specific context.\nImported VCF headers are appended to
the metadata already in a variant set.", |
| 227 "httpMethod": "POST", |
| 228 "id": "genomics.variants.import", |
| 229 "parameterOrder": [], |
| 230 "parameters": {}, |
| 231 "path": "v1/variants:import", |
| 232 "request": { |
| 233 "$ref": "ImportVariantsRequest" |
| 234 }, |
| 235 "response": { |
| 236 "$ref": "Operation" |
| 237 }, |
| 238 "scopes": [ |
| 239 "https://www.googleapis.com/auth/cloud-platform", |
| 240 "https://www.googleapis.com/auth/devstorage.read_write", |
| 241 "https://www.googleapis.com/auth/genomics" |
| 242 ] |
| 243 }, |
195 "delete": { | 244 "delete": { |
196 "description": "Deletes an annotation set. Caller must have
WRITE permission for the associated annotation set.", | 245 "description": "Deletes a variant.\n\nFor the definitions of
variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](
https://cloud.google.com/genomics/fundamentals-of-google-genomics)", |
197 "httpMethod": "DELETE", | 246 "httpMethod": "DELETE", |
198 "id": "genomics.annotationsets.delete", | 247 "id": "genomics.variants.delete", |
199 "parameterOrder": [ | 248 "parameterOrder": [ |
200 "annotationSetId" | 249 "variantId" |
201 ], | 250 ], |
202 "parameters": { | 251 "parameters": { |
203 "annotationSetId": { | 252 "variantId": { |
204 "description": "The ID of the annotation set to be d
eleted.", | 253 "description": "The ID of the variant to be deleted.
", |
205 "location": "path", | 254 "location": "path", |
206 "required": true, | 255 "required": true, |
207 "type": "string" | 256 "type": "string" |
208 } | 257 } |
209 }, | 258 }, |
210 "path": "v1/annotationsets/{annotationSetId}", | 259 "path": "v1/variants/{variantId}", |
211 "response": { | 260 "response": { |
212 "$ref": "Empty" | 261 "$ref": "Empty" |
213 }, | 262 }, |
214 "scopes": [ | 263 "scopes": [ |
215 "https://www.googleapis.com/auth/cloud-platform", | 264 "https://www.googleapis.com/auth/cloud-platform", |
216 "https://www.googleapis.com/auth/genomics" | 265 "https://www.googleapis.com/auth/genomics" |
217 ] | 266 ] |
218 }, | 267 }, |
| 268 "create": { |
| 269 "description": "Creates a new variant.\n\nFor the definition
s of variants and other genomics resources, see\n[Fundamentals of Google\nGenomi
cs](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", |
| 270 "httpMethod": "POST", |
| 271 "id": "genomics.variants.create", |
| 272 "parameterOrder": [], |
| 273 "parameters": {}, |
| 274 "path": "v1/variants", |
| 275 "request": { |
| 276 "$ref": "Variant" |
| 277 }, |
| 278 "response": { |
| 279 "$ref": "Variant" |
| 280 }, |
| 281 "scopes": [ |
| 282 "https://www.googleapis.com/auth/cloud-platform", |
| 283 "https://www.googleapis.com/auth/genomics" |
| 284 ] |
| 285 } |
| 286 } |
| 287 }, |
| 288 "annotationsets": { |
| 289 "methods": { |
| 290 "delete": { |
| 291 "description": "Deletes an annotation set. Caller must have
WRITE permission\nfor the associated annotation set.", |
| 292 "httpMethod": "DELETE", |
| 293 "id": "genomics.annotationsets.delete", |
| 294 "parameterOrder": [ |
| 295 "annotationSetId" |
| 296 ], |
| 297 "parameters": { |
| 298 "annotationSetId": { |
| 299 "description": "The ID of the annotation set to be d
eleted.", |
| 300 "location": "path", |
| 301 "required": true, |
| 302 "type": "string" |
| 303 } |
| 304 }, |
| 305 "path": "v1/annotationsets/{annotationSetId}", |
| 306 "response": { |
| 307 "$ref": "Empty" |
| 308 }, |
| 309 "scopes": [ |
| 310 "https://www.googleapis.com/auth/cloud-platform", |
| 311 "https://www.googleapis.com/auth/genomics" |
| 312 ] |
| 313 }, |
219 "search": { | 314 "search": { |
220 "description": "Searches for annotation sets that match the
given criteria. Annotation sets are returned in an unspecified order. This order
is consistent, such that two queries for the same content (regardless of page s
ize) yield annotation sets in the same order across their respective streams of
paginated responses. Caller must have READ permission for the queried datasets."
, | 315 "description": "Searches for annotation sets that match the
given criteria. Annotation sets\nare returned in an unspecified order. This orde
r is consistent, such that\ntwo queries for the same content (regardless of page
size) yield annotation\nsets in the same order across their respective streams
of paginated\nresponses. Caller must have READ permission for the queried datase
ts.", |
221 "httpMethod": "POST", | 316 "httpMethod": "POST", |
222 "id": "genomics.annotationsets.search", | 317 "id": "genomics.annotationsets.search", |
| 318 "parameterOrder": [], |
| 319 "parameters": {}, |
223 "path": "v1/annotationsets/search", | 320 "path": "v1/annotationsets/search", |
224 "request": { | 321 "request": { |
225 "$ref": "SearchAnnotationSetsRequest" | 322 "$ref": "SearchAnnotationSetsRequest" |
226 }, | 323 }, |
227 "response": { | 324 "response": { |
228 "$ref": "SearchAnnotationSetsResponse" | 325 "$ref": "SearchAnnotationSetsResponse" |
229 }, | 326 }, |
230 "scopes": [ | 327 "scopes": [ |
231 "https://www.googleapis.com/auth/cloud-platform", | 328 "https://www.googleapis.com/auth/cloud-platform", |
232 "https://www.googleapis.com/auth/genomics", | 329 "https://www.googleapis.com/auth/genomics", |
233 "https://www.googleapis.com/auth/genomics.readonly" | 330 "https://www.googleapis.com/auth/genomics.readonly" |
234 ] | 331 ] |
235 } | |
236 } | |
237 }, | |
238 "annotations": { | |
239 "methods": { | |
240 "create": { | |
241 "description": "Creates a new annotation. Caller must have W
RITE permission for the associated annotation set. The following fields are requ
ired: * annotationSetId * referenceName or referenceId ### Transcripts For annot
ations of type TRANSCRIPT, the following fields of transcript must be provided:
* exons.start * exons.end All other fields may be optionally specified, unless d
ocumented as being server-generated (for example, the `id` field). The annotated
range must be no longer than 100Mbp (mega base pairs). See the Annotation resou
rce for additional restrictions on each field.", | |
242 "httpMethod": "POST", | |
243 "id": "genomics.annotations.create", | |
244 "path": "v1/annotations", | |
245 "request": { | |
246 "$ref": "Annotation" | |
247 }, | |
248 "response": { | |
249 "$ref": "Annotation" | |
250 }, | |
251 "scopes": [ | |
252 "https://www.googleapis.com/auth/cloud-platform", | |
253 "https://www.googleapis.com/auth/genomics" | |
254 ] | |
255 }, | |
256 "batchCreate": { | |
257 "description": "Creates one or more new annotations atomical
ly. All annotations must belong to the same annotation set. Caller must have WRI
TE permission for this annotation set. For optimal performance, batch positional
ly adjacent annotations together. If the request has a systemic issue, such as a
n attempt to write to an inaccessible annotation set, the entire RPC will fail a
ccordingly. For lesser data issues, when possible an error will be isolated to t
he corresponding batch entry in the response; the remaining well formed annotati
ons will be created normally. For details on the requirements for each individua
l annotation resource, see CreateAnnotation.", | |
258 "httpMethod": "POST", | |
259 "id": "genomics.annotations.batchCreate", | |
260 "path": "v1/annotations:batchCreate", | |
261 "request": { | |
262 "$ref": "BatchCreateAnnotationsRequest" | |
263 }, | |
264 "response": { | |
265 "$ref": "BatchCreateAnnotationsResponse" | |
266 }, | |
267 "scopes": [ | |
268 "https://www.googleapis.com/auth/cloud-platform", | |
269 "https://www.googleapis.com/auth/genomics" | |
270 ] | |
271 }, | 332 }, |
272 "get": { | 333 "get": { |
273 "description": "Gets an annotation. Caller must have READ pe
rmission for the associated annotation set.", | 334 "description": "Gets an annotation set. Caller must have REA
D permission for\nthe associated dataset.", |
274 "httpMethod": "GET", | 335 "httpMethod": "GET", |
275 "id": "genomics.annotations.get", | 336 "id": "genomics.annotationsets.get", |
276 "parameterOrder": [ | 337 "parameterOrder": [ |
277 "annotationId" | 338 "annotationSetId" |
278 ], | 339 ], |
279 "parameters": { | 340 "parameters": { |
280 "annotationId": { | 341 "annotationSetId": { |
281 "description": "The ID of the annotation to be retri
eved.", | 342 "description": "The ID of the annotation set to be r
etrieved.", |
282 "location": "path", | 343 "location": "path", |
283 "required": true, | 344 "required": true, |
284 "type": "string" | 345 "type": "string" |
285 } | 346 } |
286 }, | 347 }, |
287 "path": "v1/annotations/{annotationId}", | 348 "path": "v1/annotationsets/{annotationSetId}", |
288 "response": { | 349 "response": { |
289 "$ref": "Annotation" | 350 "$ref": "AnnotationSet" |
290 }, | 351 }, |
291 "scopes": [ | 352 "scopes": [ |
292 "https://www.googleapis.com/auth/cloud-platform", | 353 "https://www.googleapis.com/auth/cloud-platform", |
293 "https://www.googleapis.com/auth/genomics", | 354 "https://www.googleapis.com/auth/genomics", |
294 "https://www.googleapis.com/auth/genomics.readonly" | 355 "https://www.googleapis.com/auth/genomics.readonly" |
295 ] | 356 ] |
296 }, | 357 }, |
297 "update": { | 358 "update": { |
298 "description": "Updates an annotation. Caller must have WRIT
E permission for the associated dataset.", | 359 "description": "Updates an annotation set. The update must r
espect all mutability\nrestrictions and other invariants described on the annota
tion set resource.\nCaller must have WRITE permission for the associated dataset
.", |
299 "httpMethod": "PUT", | 360 "httpMethod": "PUT", |
300 "id": "genomics.annotations.update", | 361 "id": "genomics.annotationsets.update", |
301 "parameterOrder": [ | 362 "parameterOrder": [ |
302 "annotationId" | 363 "annotationSetId" |
303 ], | 364 ], |
304 "parameters": { | 365 "parameters": { |
305 "annotationId": { | 366 "updateMask": { |
306 "description": "The ID of the annotation to be updat
ed.", | 367 "description": "An optional mask specifying which fi
elds to update. Mutable fields are\nname,\nsource_uri, and\ninfo. If unspecified
, all\nmutable fields will be updated.", |
| 368 "format": "google-fieldmask", |
| 369 "location": "query", |
| 370 "type": "string" |
| 371 }, |
| 372 "annotationSetId": { |
| 373 "description": "The ID of the annotation set to be u
pdated.", |
307 "location": "path", | 374 "location": "path", |
308 "required": true, | 375 "required": true, |
309 "type": "string" | 376 "type": "string" |
310 }, | |
311 "updateMask": { | |
312 "description": "An optional mask specifying which fi
elds to update. Mutable fields are name, variant, transcript, and info. If unspe
cified, all mutable fields will be updated.", | |
313 "location": "query", | |
314 "type": "string" | |
315 } | 377 } |
316 }, | 378 }, |
317 "path": "v1/annotations/{annotationId}", | 379 "path": "v1/annotationsets/{annotationSetId}", |
318 "request": { | 380 "request": { |
319 "$ref": "Annotation" | 381 "$ref": "AnnotationSet" |
320 }, | 382 }, |
321 "response": { | 383 "response": { |
322 "$ref": "Annotation" | 384 "$ref": "AnnotationSet" |
323 }, | 385 }, |
324 "scopes": [ | 386 "scopes": [ |
325 "https://www.googleapis.com/auth/cloud-platform", | 387 "https://www.googleapis.com/auth/cloud-platform", |
326 "https://www.googleapis.com/auth/genomics" | 388 "https://www.googleapis.com/auth/genomics" |
327 ] | 389 ] |
328 }, | 390 }, |
329 "delete": { | 391 "create": { |
330 "description": "Deletes an annotation. Caller must have WRIT
E permission for the associated annotation set.", | 392 "description": "Creates a new annotation set. Caller must ha
ve WRITE permission for the\nassociated dataset.\n\nThe following fields are req
uired:\n\n * datasetId\n * referenceSetId\n\nAll other fields may be optionall
y specified, unless documented as being\nserver-generated (for example, the `id`
field).", |
331 "httpMethod": "DELETE", | 393 "httpMethod": "POST", |
332 "id": "genomics.annotations.delete", | 394 "id": "genomics.annotationsets.create", |
| 395 "parameterOrder": [], |
| 396 "parameters": {}, |
| 397 "path": "v1/annotationsets", |
| 398 "request": { |
| 399 "$ref": "AnnotationSet" |
| 400 }, |
| 401 "response": { |
| 402 "$ref": "AnnotationSet" |
| 403 }, |
| 404 "scopes": [ |
| 405 "https://www.googleapis.com/auth/cloud-platform", |
| 406 "https://www.googleapis.com/auth/genomics" |
| 407 ] |
| 408 } |
| 409 } |
| 410 }, |
| 411 "references": { |
| 412 "methods": { |
| 413 "search": { |
| 414 "description": "Searches for references which match the give
n criteria.\n\nFor the definitions of references and other genomics resources, s
ee\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundame
ntals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchReferences](ht
tps://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemeth
ods.avdl#L146).", |
| 415 "httpMethod": "POST", |
| 416 "id": "genomics.references.search", |
| 417 "parameterOrder": [], |
| 418 "parameters": {}, |
| 419 "path": "v1/references/search", |
| 420 "request": { |
| 421 "$ref": "SearchReferencesRequest" |
| 422 }, |
| 423 "response": { |
| 424 "$ref": "SearchReferencesResponse" |
| 425 }, |
| 426 "scopes": [ |
| 427 "https://www.googleapis.com/auth/cloud-platform", |
| 428 "https://www.googleapis.com/auth/genomics", |
| 429 "https://www.googleapis.com/auth/genomics.readonly" |
| 430 ] |
| 431 }, |
| 432 "get": { |
| 433 "description": "Gets a reference.\n\nFor the definitions of
references and other genomics resources, see\n[Fundamentals of Google\nGenomics]
(https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplement
s\n[GlobalAllianceApi.getReference](https://github.com/ga4gh/schemas/blob/v0.5.1
/src/main/resources/avro/referencemethods.avdl#L158).", |
| 434 "httpMethod": "GET", |
| 435 "id": "genomics.references.get", |
333 "parameterOrder": [ | 436 "parameterOrder": [ |
334 "annotationId" | 437 "referenceId" |
335 ], | 438 ], |
336 "parameters": { | 439 "parameters": { |
337 "annotationId": { | 440 "referenceId": { |
338 "description": "The ID of the annotation to be delet
ed.", | 441 "description": "The ID of the reference.", |
339 "location": "path", | 442 "location": "path", |
340 "required": true, | 443 "required": true, |
341 "type": "string" | 444 "type": "string" |
342 } | 445 } |
343 }, | 446 }, |
344 "path": "v1/annotations/{annotationId}", | 447 "path": "v1/references/{referenceId}", |
345 "response": { | 448 "response": { |
346 "$ref": "Empty" | 449 "$ref": "Reference" |
347 }, | |
348 "scopes": [ | |
349 "https://www.googleapis.com/auth/cloud-platform", | |
350 "https://www.googleapis.com/auth/genomics" | |
351 ] | |
352 }, | |
353 "search": { | |
354 "description": "Searches for annotations that match the give
n criteria. Results are ordered by genomic coordinate (by reference sequence, th
en position). Annotations with equivalent genomic coordinates are returned in an
unspecified order. This order is consistent, such that two queries for the same
content (regardless of page size) yield annotations in the same order across th
eir respective streams of paginated responses. Caller must have READ permission
for the queried annotation sets.", | |
355 "httpMethod": "POST", | |
356 "id": "genomics.annotations.search", | |
357 "path": "v1/annotations/search", | |
358 "request": { | |
359 "$ref": "SearchAnnotationsRequest" | |
360 }, | |
361 "response": { | |
362 "$ref": "SearchAnnotationsResponse" | |
363 }, | 450 }, |
364 "scopes": [ | 451 "scopes": [ |
365 "https://www.googleapis.com/auth/cloud-platform", | 452 "https://www.googleapis.com/auth/cloud-platform", |
366 "https://www.googleapis.com/auth/genomics", | 453 "https://www.googleapis.com/auth/genomics", |
367 "https://www.googleapis.com/auth/genomics.readonly" | 454 "https://www.googleapis.com/auth/genomics.readonly" |
368 ] | 455 ] |
369 } | 456 } |
| 457 }, |
| 458 "resources": { |
| 459 "bases": { |
| 460 "methods": { |
| 461 "list": { |
| 462 "description": "Lists the bases in a reference, opti
onally restricted to a range.\n\nFor the definitions of references and other gen
omics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.co
m/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.ge
tReferenceBases](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources
/avro/referencemethods.avdl#L221).", |
| 463 "httpMethod": "GET", |
| 464 "id": "genomics.references.bases.list", |
| 465 "parameterOrder": [ |
| 466 "referenceId" |
| 467 ], |
| 468 "parameters": { |
| 469 "pageSize": { |
| 470 "description": "The maximum number of bases
to return in a single page. If unspecified,\ndefaults to 200Kbp (kilo base pairs
). The maximum value is 10Mbp (mega base\npairs).", |
| 471 "format": "int32", |
| 472 "location": "query", |
| 473 "type": "integer" |
| 474 }, |
| 475 "start": { |
| 476 "description": "The start position (0-based)
of this query. Defaults to 0.", |
| 477 "format": "int64", |
| 478 "location": "query", |
| 479 "type": "string" |
| 480 }, |
| 481 "referenceId": { |
| 482 "description": "The ID of the reference.", |
| 483 "location": "path", |
| 484 "required": true, |
| 485 "type": "string" |
| 486 }, |
| 487 "end": { |
| 488 "description": "The end position (0-based, e
xclusive) of this query. Defaults to the length\nof this reference.", |
| 489 "format": "int64", |
| 490 "location": "query", |
| 491 "type": "string" |
| 492 }, |
| 493 "pageToken": { |
| 494 "description": "The continuation token, whic
h is used to page through large result sets.\nTo get the next page of results, s
et this parameter to the value of\n`nextPageToken` from the previous response.", |
| 495 "location": "query", |
| 496 "type": "string" |
| 497 } |
| 498 }, |
| 499 "path": "v1/references/{referenceId}/bases", |
| 500 "response": { |
| 501 "$ref": "ListBasesResponse" |
| 502 }, |
| 503 "scopes": [ |
| 504 "https://www.googleapis.com/auth/cloud-platform"
, |
| 505 "https://www.googleapis.com/auth/genomics", |
| 506 "https://www.googleapis.com/auth/genomics.readon
ly" |
| 507 ] |
| 508 } |
| 509 } |
| 510 } |
370 } | 511 } |
371 }, | 512 }, |
372 "datasets": { | 513 "datasets": { |
373 "methods": { | 514 "methods": { |
374 "list": { | 515 "testIamPermissions": { |
375 "description": "Lists datasets within a project. For the def
initions of datasets and other genomics resources, see [Fundamentals of Google G
enomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", | 516 "description": "Returns permissions that a caller has on the
specified resource.\nSee <a href=\"/iam/docs/managing-policies#testing_permissi
ons\">Testing\nPermissions</a> for more information.\n\nFor the definitions of d
atasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](ht
tps://cloud.google.com/genomics/fundamentals-of-google-genomics)", |
376 "httpMethod": "GET", | |
377 "id": "genomics.datasets.list", | |
378 "parameters": { | |
379 "projectId": { | |
380 "description": "Required. The Google Cloud project I
D to list datasets for.", | |
381 "location": "query", | |
382 "type": "string" | |
383 }, | |
384 "pageSize": { | |
385 "description": "The maximum number of results to ret
urn in a single page. If unspecified, defaults to 50. The maximum value is 1024.
", | |
386 "format": "int32", | |
387 "location": "query", | |
388 "type": "integer" | |
389 }, | |
390 "pageToken": { | |
391 "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.", | |
392 "location": "query", | |
393 "type": "string" | |
394 } | |
395 }, | |
396 "path": "v1/datasets", | |
397 "response": { | |
398 "$ref": "ListDatasetsResponse" | |
399 }, | |
400 "scopes": [ | |
401 "https://www.googleapis.com/auth/cloud-platform", | |
402 "https://www.googleapis.com/auth/genomics", | |
403 "https://www.googleapis.com/auth/genomics.readonly" | |
404 ] | |
405 }, | |
406 "create": { | |
407 "description": "Creates a new dataset. For the definitions o
f datasets and other genomics resources, see [Fundamentals of Google Genomics](h
ttps://cloud.google.com/genomics/fundamentals-of-google-genomics)", | |
408 "httpMethod": "POST", | 517 "httpMethod": "POST", |
409 "id": "genomics.datasets.create", | 518 "id": "genomics.datasets.testIamPermissions", |
410 "path": "v1/datasets", | |
411 "request": { | |
412 "$ref": "Dataset" | |
413 }, | |
414 "response": { | |
415 "$ref": "Dataset" | |
416 }, | |
417 "scopes": [ | |
418 "https://www.googleapis.com/auth/cloud-platform", | |
419 "https://www.googleapis.com/auth/genomics" | |
420 ] | |
421 }, | |
422 "get": { | |
423 "description": "Gets a dataset by ID. For the definitions of
datasets and other genomics resources, see [Fundamentals of Google Genomics](ht
tps://cloud.google.com/genomics/fundamentals-of-google-genomics)", | |
424 "httpMethod": "GET", | |
425 "id": "genomics.datasets.get", | |
426 "parameterOrder": [ | 519 "parameterOrder": [ |
427 "datasetId" | 520 "resource" |
428 ], | 521 ], |
429 "parameters": { | 522 "parameters": { |
430 "datasetId": { | 523 "resource": { |
431 "description": "The ID of the dataset.", | 524 "description": "REQUIRED: The resource for which pol
icy is being specified. Format is\n`datasets/<dataset ID>`.", |
432 "location": "path", | 525 "location": "path", |
| 526 "pattern": "^datasets/[^/]+$", |
433 "required": true, | 527 "required": true, |
434 "type": "string" | 528 "type": "string" |
435 } | 529 } |
436 }, | 530 }, |
437 "path": "v1/datasets/{datasetId}", | 531 "path": "v1/{+resource}:testIamPermissions", |
| 532 "request": { |
| 533 "$ref": "TestIamPermissionsRequest" |
| 534 }, |
438 "response": { | 535 "response": { |
439 "$ref": "Dataset" | 536 "$ref": "TestIamPermissionsResponse" |
440 }, | 537 }, |
441 "scopes": [ | 538 "scopes": [ |
442 "https://www.googleapis.com/auth/cloud-platform", | 539 "https://www.googleapis.com/auth/cloud-platform", |
443 "https://www.googleapis.com/auth/genomics", | |
444 "https://www.googleapis.com/auth/genomics.readonly" | |
445 ] | |
446 }, | |
447 "patch": { | |
448 "description": "Updates a dataset. For the definitions of da
tasets and other genomics resources, see [Fundamentals of Google Genomics](https
://cloud.google.com/genomics/fundamentals-of-google-genomics) This method suppor
ts patch semantics.", | |
449 "httpMethod": "PATCH", | |
450 "id": "genomics.datasets.patch", | |
451 "parameterOrder": [ | |
452 "datasetId" | |
453 ], | |
454 "parameters": { | |
455 "datasetId": { | |
456 "description": "The ID of the dataset to be updated.
", | |
457 "location": "path", | |
458 "required": true, | |
459 "type": "string" | |
460 }, | |
461 "updateMask": { | |
462 "description": "An optional mask specifying which fi
elds to update. At this time, the only mutable field is name. The only acceptabl
e value is \"name\". If unspecified, all mutable fields will be updated.", | |
463 "location": "query", | |
464 "type": "string" | |
465 } | |
466 }, | |
467 "path": "v1/datasets/{datasetId}", | |
468 "request": { | |
469 "$ref": "Dataset" | |
470 }, | |
471 "response": { | |
472 "$ref": "Dataset" | |
473 }, | |
474 "scopes": [ | |
475 "https://www.googleapis.com/auth/cloud-platform", | |
476 "https://www.googleapis.com/auth/genomics" | 540 "https://www.googleapis.com/auth/genomics" |
477 ] | 541 ] |
478 }, | 542 }, |
479 "delete": { | 543 "delete": { |
480 "description": "Deletes a dataset and all of its contents (a
ll read group sets, reference sets, variant sets, call sets, annotation sets, et
c.) This is reversible (up to one week after the deletion) via the datasets.unde
lete operation. For the definitions of datasets and other genomics resources, se
e [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamenta
ls-of-google-genomics)", | 544 "description": "Deletes a dataset and all of its contents (a
ll read group sets,\nreference sets, variant sets, call sets, annotation sets, e
tc.)\nThis is reversible (up to one week after the deletion) via\nthe\ndatasets.
undelete\noperation.\n\nFor the definitions of datasets and other genomics resou
rces, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/
fundamentals-of-google-genomics)", |
481 "httpMethod": "DELETE", | 545 "httpMethod": "DELETE", |
482 "id": "genomics.datasets.delete", | 546 "id": "genomics.datasets.delete", |
483 "parameterOrder": [ | 547 "parameterOrder": [ |
484 "datasetId" | 548 "datasetId" |
485 ], | 549 ], |
486 "parameters": { | 550 "parameters": { |
487 "datasetId": { | 551 "datasetId": { |
488 "description": "The ID of the dataset to be deleted.
", | 552 "description": "The ID of the dataset to be deleted.
", |
489 "location": "path", | 553 "location": "path", |
490 "required": true, | 554 "required": true, |
491 "type": "string" | 555 "type": "string" |
492 } | 556 } |
493 }, | 557 }, |
494 "path": "v1/datasets/{datasetId}", | 558 "path": "v1/datasets/{datasetId}", |
495 "response": { | 559 "response": { |
496 "$ref": "Empty" | 560 "$ref": "Empty" |
497 }, | 561 }, |
498 "scopes": [ | 562 "scopes": [ |
499 "https://www.googleapis.com/auth/cloud-platform", | 563 "https://www.googleapis.com/auth/cloud-platform", |
500 "https://www.googleapis.com/auth/genomics" | 564 "https://www.googleapis.com/auth/genomics" |
501 ] | 565 ] |
502 }, | 566 }, |
503 "undelete": { | 567 "list": { |
504 "description": "Undeletes a dataset by restoring a dataset w
hich was deleted via this API. For the definitions of datasets and other genomic
s resources, see [Fundamentals of Google Genomics](https://cloud.google.com/geno
mics/fundamentals-of-google-genomics) This operation is only possible for a week
after the deletion occurred.", | 568 "description": "Lists datasets within a project.\n\nFor the
definitions of datasets and other genomics resources, see\n[Fundamentals of Goog
le\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
", |
505 "httpMethod": "POST", | 569 "httpMethod": "GET", |
506 "id": "genomics.datasets.undelete", | 570 "id": "genomics.datasets.list", |
507 "parameterOrder": [ | 571 "parameterOrder": [], |
508 "datasetId" | |
509 ], | |
510 "parameters": { | 572 "parameters": { |
511 "datasetId": { | 573 "pageSize": { |
512 "description": "The ID of the dataset to be undelete
d.", | 574 "description": "The maximum number of results to ret
urn in a single page. If unspecified,\ndefaults to 50. The maximum value is 1024
.", |
513 "location": "path", | 575 "format": "int32", |
514 "required": true, | 576 "location": "query", |
| 577 "type": "integer" |
| 578 }, |
| 579 "projectId": { |
| 580 "description": "Required. The Google Cloud project I
D to list datasets for.", |
| 581 "location": "query", |
| 582 "type": "string" |
| 583 }, |
| 584 "pageToken": { |
| 585 "description": "The continuation token, which is use
d to page through large result sets.\nTo get the next page of results, set this
parameter to the value of\n`nextPageToken` from the previous response.", |
| 586 "location": "query", |
515 "type": "string" | 587 "type": "string" |
516 } | 588 } |
517 }, | 589 }, |
518 "path": "v1/datasets/{datasetId}:undelete", | 590 "path": "v1/datasets", |
519 "request": { | |
520 "$ref": "UndeleteDatasetRequest" | |
521 }, | |
522 "response": { | 591 "response": { |
523 "$ref": "Dataset" | 592 "$ref": "ListDatasetsResponse" |
524 }, | 593 }, |
525 "scopes": [ | 594 "scopes": [ |
526 "https://www.googleapis.com/auth/cloud-platform", | 595 "https://www.googleapis.com/auth/cloud-platform", |
527 "https://www.googleapis.com/auth/genomics" | 596 "https://www.googleapis.com/auth/genomics", |
| 597 "https://www.googleapis.com/auth/genomics.readonly" |
528 ] | 598 ] |
529 }, | 599 }, |
530 "setIamPolicy": { | 600 "setIamPolicy": { |
531 "description": "Sets the access control policy on the specif
ied dataset. Replaces any existing policy. For the definitions of datasets and o
ther genomics resources, see [Fundamentals of Google Genomics](https://cloud.goo
gle.com/genomics/fundamentals-of-google-genomics) See Setting a Policy for more
information.", | 601 "description": "Sets the access control policy on the specif
ied dataset. Replaces any\nexisting policy.\n\nFor the definitions of datasets a
nd other genomics resources, see\n[Fundamentals of Google\nGenomics](https://clo
ud.google.com/genomics/fundamentals-of-google-genomics)\n\nSee <a href=\"/iam/do
cs/managing-policies#setting_a_policy\">Setting a\nPolicy</a> for more informati
on.", |
532 "httpMethod": "POST", | 602 "httpMethod": "POST", |
533 "id": "genomics.datasets.setIamPolicy", | 603 "id": "genomics.datasets.setIamPolicy", |
534 "parameterOrder": [ | 604 "parameterOrder": [ |
535 "resource" | 605 "resource" |
536 ], | 606 ], |
537 "parameters": { | 607 "parameters": { |
538 "resource": { | 608 "resource": { |
539 "description": "REQUIRED: The resource for which pol
icy is being specified. Format is `datasets/`.", | 609 "description": "REQUIRED: The resource for which pol
icy is being specified. Format is\n`datasets/<dataset ID>`.", |
540 "location": "path", | 610 "location": "path", |
541 "pattern": "^datasets/[^/]+$", | 611 "pattern": "^datasets/[^/]+$", |
542 "required": true, | 612 "required": true, |
543 "type": "string" | 613 "type": "string" |
544 } | 614 } |
545 }, | 615 }, |
546 "path": "v1/{+resource}:setIamPolicy", | 616 "path": "v1/{+resource}:setIamPolicy", |
547 "request": { | 617 "request": { |
548 "$ref": "SetIamPolicyRequest" | 618 "$ref": "SetIamPolicyRequest" |
549 }, | 619 }, |
550 "response": { | 620 "response": { |
551 "$ref": "Policy" | 621 "$ref": "Policy" |
552 }, | 622 }, |
553 "scopes": [ | 623 "scopes": [ |
554 "https://www.googleapis.com/auth/cloud-platform", | 624 "https://www.googleapis.com/auth/cloud-platform", |
555 "https://www.googleapis.com/auth/genomics" | 625 "https://www.googleapis.com/auth/genomics" |
556 ] | 626 ] |
557 }, | 627 }, |
| 628 "create": { |
| 629 "description": "Creates a new dataset.\n\nFor the definition
s of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomi
cs](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", |
| 630 "httpMethod": "POST", |
| 631 "id": "genomics.datasets.create", |
| 632 "parameterOrder": [], |
| 633 "parameters": {}, |
| 634 "path": "v1/datasets", |
| 635 "request": { |
| 636 "$ref": "Dataset" |
| 637 }, |
| 638 "response": { |
| 639 "$ref": "Dataset" |
| 640 }, |
| 641 "scopes": [ |
| 642 "https://www.googleapis.com/auth/cloud-platform", |
| 643 "https://www.googleapis.com/auth/genomics" |
| 644 ] |
| 645 }, |
558 "getIamPolicy": { | 646 "getIamPolicy": { |
559 "description": "Gets the access control policy for the datas
et. This is empty if the policy or resource does not exist. See Getting a Policy
for more information. For the definitions of datasets and other genomics resour
ces, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fun
damentals-of-google-genomics)", | 647 "description": "Gets the access control policy for the datas
et. This is empty if the\npolicy or resource does not exist.\n\nSee <a href=\"/i
am/docs/managing-policies#getting_a_policy\">Getting a\nPolicy</a> for more info
rmation.\n\nFor the definitions of datasets and other genomics resources, see\n[
Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals
-of-google-genomics)", |
560 "httpMethod": "POST", | 648 "httpMethod": "POST", |
561 "id": "genomics.datasets.getIamPolicy", | 649 "id": "genomics.datasets.getIamPolicy", |
562 "parameterOrder": [ | 650 "parameterOrder": [ |
563 "resource" | 651 "resource" |
564 ], | 652 ], |
565 "parameters": { | 653 "parameters": { |
566 "resource": { | 654 "resource": { |
567 "description": "REQUIRED: The resource for which pol
icy is being specified. Format is `datasets/`.", | 655 "description": "REQUIRED: The resource for which pol
icy is being specified. Format is\n`datasets/<dataset ID>`.", |
568 "location": "path", | 656 "location": "path", |
569 "pattern": "^datasets/[^/]+$", | 657 "pattern": "^datasets/[^/]+$", |
570 "required": true, | 658 "required": true, |
571 "type": "string" | 659 "type": "string" |
572 } | 660 } |
573 }, | 661 }, |
574 "path": "v1/{+resource}:getIamPolicy", | 662 "path": "v1/{+resource}:getIamPolicy", |
575 "request": { | 663 "request": { |
576 "$ref": "GetIamPolicyRequest" | 664 "$ref": "GetIamPolicyRequest" |
577 }, | 665 }, |
578 "response": { | 666 "response": { |
579 "$ref": "Policy" | 667 "$ref": "Policy" |
580 }, | 668 }, |
581 "scopes": [ | 669 "scopes": [ |
582 "https://www.googleapis.com/auth/cloud-platform", | 670 "https://www.googleapis.com/auth/cloud-platform", |
583 "https://www.googleapis.com/auth/genomics" | 671 "https://www.googleapis.com/auth/genomics" |
584 ] | 672 ] |
585 }, | 673 }, |
586 "testIamPermissions": { | 674 "patch": { |
587 "description": "Returns permissions that a caller has on the
specified resource. See Testing Permissions for more information. For the defin
itions of datasets and other genomics resources, see [Fundamentals of Google Gen
omics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", | 675 "description": "Updates a dataset.\n\nFor the definitions of
datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](
https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis metho
d supports patch semantics.", |
588 "httpMethod": "POST", | 676 "httpMethod": "PATCH", |
589 "id": "genomics.datasets.testIamPermissions", | 677 "id": "genomics.datasets.patch", |
590 "parameterOrder": [ | 678 "parameterOrder": [ |
591 "resource" | 679 "datasetId" |
592 ], | 680 ], |
593 "parameters": { | 681 "parameters": { |
594 "resource": { | 682 "datasetId": { |
595 "description": "REQUIRED: The resource for which pol
icy is being specified. Format is `datasets/`.", | 683 "description": "The ID of the dataset to be updated.
", |
596 "location": "path", | 684 "location": "path", |
597 "pattern": "^datasets/[^/]+$", | 685 "required": true, |
| 686 "type": "string" |
| 687 }, |
| 688 "updateMask": { |
| 689 "description": "An optional mask specifying which fi
elds to update. At this time, the only\nmutable field is name. The only\naccepta
ble value is \"name\". If unspecified, all mutable fields will be\nupdated.", |
| 690 "format": "google-fieldmask", |
| 691 "location": "query", |
| 692 "type": "string" |
| 693 } |
| 694 }, |
| 695 "path": "v1/datasets/{datasetId}", |
| 696 "request": { |
| 697 "$ref": "Dataset" |
| 698 }, |
| 699 "response": { |
| 700 "$ref": "Dataset" |
| 701 }, |
| 702 "scopes": [ |
| 703 "https://www.googleapis.com/auth/cloud-platform", |
| 704 "https://www.googleapis.com/auth/genomics" |
| 705 ] |
| 706 }, |
| 707 "get": { |
| 708 "description": "Gets a dataset by ID.\n\nFor the definitions
of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomic
s](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", |
| 709 "httpMethod": "GET", |
| 710 "id": "genomics.datasets.get", |
| 711 "parameterOrder": [ |
| 712 "datasetId" |
| 713 ], |
| 714 "parameters": { |
| 715 "datasetId": { |
| 716 "description": "The ID of the dataset.", |
| 717 "location": "path", |
598 "required": true, | 718 "required": true, |
599 "type": "string" | 719 "type": "string" |
600 } | 720 } |
601 }, | 721 }, |
602 "path": "v1/{+resource}:testIamPermissions", | 722 "path": "v1/datasets/{datasetId}", |
| 723 "response": { |
| 724 "$ref": "Dataset" |
| 725 }, |
| 726 "scopes": [ |
| 727 "https://www.googleapis.com/auth/cloud-platform", |
| 728 "https://www.googleapis.com/auth/genomics", |
| 729 "https://www.googleapis.com/auth/genomics.readonly" |
| 730 ] |
| 731 }, |
| 732 "undelete": { |
| 733 "description": "Undeletes a dataset by restoring a dataset w
hich was deleted via this API.\n\nFor the definitions of datasets and other geno
mics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com
/genomics/fundamentals-of-google-genomics)\n\nThis operation is only possible fo
r a week after the deletion occurred.", |
| 734 "httpMethod": "POST", |
| 735 "id": "genomics.datasets.undelete", |
| 736 "parameterOrder": [ |
| 737 "datasetId" |
| 738 ], |
| 739 "parameters": { |
| 740 "datasetId": { |
| 741 "description": "The ID of the dataset to be undelete
d.", |
| 742 "location": "path", |
| 743 "required": true, |
| 744 "type": "string" |
| 745 } |
| 746 }, |
| 747 "path": "v1/datasets/{datasetId}:undelete", |
603 "request": { | 748 "request": { |
604 "$ref": "TestIamPermissionsRequest" | 749 "$ref": "UndeleteDatasetRequest" |
605 }, | 750 }, |
606 "response": { | 751 "response": { |
607 "$ref": "TestIamPermissionsResponse" | 752 "$ref": "Dataset" |
608 }, | 753 }, |
609 "scopes": [ | 754 "scopes": [ |
610 "https://www.googleapis.com/auth/cloud-platform", | 755 "https://www.googleapis.com/auth/cloud-platform", |
611 "https://www.googleapis.com/auth/genomics" | 756 "https://www.googleapis.com/auth/genomics" |
612 ] | 757 ] |
613 } | 758 } |
614 } | 759 } |
615 }, | 760 }, |
616 "operations": { | 761 "annotations": { |
617 "methods": { | 762 "methods": { |
618 "list": { | 763 "search": { |
619 "description": "Lists operations that match the specified fi
lter in the request.", | 764 "description": "Searches for annotations that match the give
n criteria. Results are\nordered by genomic coordinate (by reference sequence, t
hen position).\nAnnotations with equivalent genomic coordinates are returned in
an\nunspecified order. This order is consistent, such that two queries for the\n
same content (regardless of page size) yield annotations in the same order\nacro
ss their respective streams of paginated responses. Caller must have\nREAD permi
ssion for the queried annotation sets.", |
| 765 "httpMethod": "POST", |
| 766 "id": "genomics.annotations.search", |
| 767 "parameterOrder": [], |
| 768 "parameters": {}, |
| 769 "path": "v1/annotations/search", |
| 770 "request": { |
| 771 "$ref": "SearchAnnotationsRequest" |
| 772 }, |
| 773 "response": { |
| 774 "$ref": "SearchAnnotationsResponse" |
| 775 }, |
| 776 "scopes": [ |
| 777 "https://www.googleapis.com/auth/cloud-platform", |
| 778 "https://www.googleapis.com/auth/genomics", |
| 779 "https://www.googleapis.com/auth/genomics.readonly" |
| 780 ] |
| 781 }, |
| 782 "get": { |
| 783 "description": "Gets an annotation. Caller must have READ pe
rmission\nfor the associated annotation set.", |
620 "httpMethod": "GET", | 784 "httpMethod": "GET", |
621 "id": "genomics.operations.list", | 785 "id": "genomics.annotations.get", |
622 "parameterOrder": [ | 786 "parameterOrder": [ |
623 "name" | 787 "annotationId" |
624 ], | 788 ], |
625 "parameters": { | 789 "parameters": { |
626 "name": { | 790 "annotationId": { |
627 "description": "The name of the operation collection
.", | 791 "description": "The ID of the annotation to be retri
eved.", |
628 "location": "path", | 792 "location": "path", |
629 "pattern": "^operations$", | |
630 "required": true, | 793 "required": true, |
631 "type": "string" | 794 "type": "string" |
632 }, | 795 } |
633 "filter": { | 796 }, |
634 "description": "A string for filtering Operations. T
he following filter fields are supported: * projectId: Required. Corresponds to
OperationMetadata.projectId. * createTime: The time this job was created, in sec
onds from the [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/
or `= 1432140000` * `projectId = my-project AND createTime >= 1432140000 AND cre
ateTime <= 1432150000 AND status = RUNNING` * `projectId = my-project AND labels
.color = *` * `projectId = my-project AND labels.color = red`", | 797 "path": "v1/annotations/{annotationId}", |
| 798 "response": { |
| 799 "$ref": "Annotation" |
| 800 }, |
| 801 "scopes": [ |
| 802 "https://www.googleapis.com/auth/cloud-platform", |
| 803 "https://www.googleapis.com/auth/genomics", |
| 804 "https://www.googleapis.com/auth/genomics.readonly" |
| 805 ] |
| 806 }, |
| 807 "update": { |
| 808 "description": "Updates an annotation. Caller must have\nWRI
TE permission for the associated dataset.", |
| 809 "httpMethod": "PUT", |
| 810 "id": "genomics.annotations.update", |
| 811 "parameterOrder": [ |
| 812 "annotationId" |
| 813 ], |
| 814 "parameters": { |
| 815 "updateMask": { |
| 816 "description": "An optional mask specifying which fi
elds to update. Mutable fields are\nname,\nvariant,\ntranscript, and\ninfo. If u
nspecified, all mutable\nfields will be updated.", |
| 817 "format": "google-fieldmask", |
635 "location": "query", | 818 "location": "query", |
636 "type": "string" | 819 "type": "string" |
637 }, | 820 }, |
638 "pageSize": { | 821 "annotationId": { |
639 "description": "The maximum number of results to ret
urn. If unspecified, defaults to 256. The maximum value is 2048.", | 822 "description": "The ID of the annotation to be updat
ed.", |
640 "format": "int32", | 823 "location": "path", |
641 "location": "query", | 824 "required": true, |
642 "type": "integer" | |
643 }, | |
644 "pageToken": { | |
645 "description": "The standard list page token.", | |
646 "location": "query", | |
647 "type": "string" | 825 "type": "string" |
648 } | 826 } |
649 }, | 827 }, |
650 "path": "v1/{+name}", | 828 "path": "v1/annotations/{annotationId}", |
| 829 "request": { |
| 830 "$ref": "Annotation" |
| 831 }, |
651 "response": { | 832 "response": { |
652 "$ref": "ListOperationsResponse" | 833 "$ref": "Annotation" |
653 }, | 834 }, |
654 "scopes": [ | 835 "scopes": [ |
655 "https://www.googleapis.com/auth/cloud-platform", | 836 "https://www.googleapis.com/auth/cloud-platform", |
656 "https://www.googleapis.com/auth/genomics" | 837 "https://www.googleapis.com/auth/genomics" |
657 ] | 838 ] |
658 }, | 839 }, |
659 "get": { | 840 "delete": { |
660 "description": "Gets the latest state of a long-running oper
ation. Clients can use this method to poll the operation result at intervals as
recommended by the API service.", | 841 "description": "Deletes an annotation. Caller must have WRIT
E permission for\nthe associated annotation set.", |
661 "httpMethod": "GET", | 842 "httpMethod": "DELETE", |
662 "id": "genomics.operations.get", | 843 "id": "genomics.annotations.delete", |
663 "parameterOrder": [ | 844 "parameterOrder": [ |
664 "name" | 845 "annotationId" |
665 ], | 846 ], |
666 "parameters": { | 847 "parameters": { |
667 "name": { | 848 "annotationId": { |
668 "description": "The name of the operation resource."
, | 849 "description": "The ID of the annotation to be delet
ed.", |
669 "location": "path", | 850 "location": "path", |
670 "pattern": "^operations/.+$", | |
671 "required": true, | 851 "required": true, |
672 "type": "string" | 852 "type": "string" |
673 } | 853 } |
674 }, | 854 }, |
675 "path": "v1/{+name}", | 855 "path": "v1/annotations/{annotationId}", |
676 "response": { | |
677 "$ref": "Operation" | |
678 }, | |
679 "scopes": [ | |
680 "https://www.googleapis.com/auth/cloud-platform", | |
681 "https://www.googleapis.com/auth/genomics" | |
682 ] | |
683 }, | |
684 "cancel": { | |
685 "description": "Starts asynchronous cancellation on a long-r
unning operation. The server makes a best effort to cancel the operation, but su
ccess is not guaranteed. Clients may use Operations.GetOperation or Operations.L
istOperations to check whether the cancellation succeeded or the operation compl
eted despite cancellation.", | |
686 "httpMethod": "POST", | |
687 "id": "genomics.operations.cancel", | |
688 "parameterOrder": [ | |
689 "name" | |
690 ], | |
691 "parameters": { | |
692 "name": { | |
693 "description": "The name of the operation resource t
o be cancelled.", | |
694 "location": "path", | |
695 "pattern": "^operations/.+$", | |
696 "required": true, | |
697 "type": "string" | |
698 } | |
699 }, | |
700 "path": "v1/{+name}:cancel", | |
701 "request": { | |
702 "$ref": "CancelOperationRequest" | |
703 }, | |
704 "response": { | 856 "response": { |
705 "$ref": "Empty" | 857 "$ref": "Empty" |
706 }, | 858 }, |
707 "scopes": [ | 859 "scopes": [ |
708 "https://www.googleapis.com/auth/cloud-platform", | 860 "https://www.googleapis.com/auth/cloud-platform", |
709 "https://www.googleapis.com/auth/genomics" | 861 "https://www.googleapis.com/auth/genomics" |
710 ] | 862 ] |
| 863 }, |
| 864 "create": { |
| 865 "description": "Creates a new annotation. Caller must have W
RITE permission\nfor the associated annotation set.\n\nThe following fields are
required:\n\n* annotationSetId\n* referenceName or\n referenceId\n\n### Transcr
ipts\n\nFor annotations of type TRANSCRIPT, the following fields of\ntranscript
must be provided:\n\n* exons.start\n* exons.end\n\nAll other fields may be optio
nally specified, unless documented as being\nserver-generated (for example, the
`id` field). The annotated\nrange must be no longer than 100Mbp (mega base pairs
). See the\nAnnotation resource\nfor additional restrictions on each field.", |
| 866 "httpMethod": "POST", |
| 867 "id": "genomics.annotations.create", |
| 868 "parameterOrder": [], |
| 869 "parameters": {}, |
| 870 "path": "v1/annotations", |
| 871 "request": { |
| 872 "$ref": "Annotation" |
| 873 }, |
| 874 "response": { |
| 875 "$ref": "Annotation" |
| 876 }, |
| 877 "scopes": [ |
| 878 "https://www.googleapis.com/auth/cloud-platform", |
| 879 "https://www.googleapis.com/auth/genomics" |
| 880 ] |
| 881 }, |
| 882 "batchCreate": { |
| 883 "description": "Creates one or more new annotations atomical
ly. All annotations must\nbelong to the same annotation set. Caller must have WR
ITE\npermission for this annotation set. For optimal performance, batch\npositio
nally adjacent annotations together.\n\nIf the request has a systemic issue, suc
h as an attempt to write to\nan inaccessible annotation set, the entire RPC will
fail accordingly. For\nlesser data issues, when possible an error will be isola
ted to the\ncorresponding batch entry in the response; the remaining well formed
\nannotations will be created normally.\n\nFor details on the requirements for e
ach individual annotation resource,\nsee\nCreateAnnotation.", |
| 884 "httpMethod": "POST", |
| 885 "id": "genomics.annotations.batchCreate", |
| 886 "parameterOrder": [], |
| 887 "parameters": {}, |
| 888 "path": "v1/annotations:batchCreate", |
| 889 "request": { |
| 890 "$ref": "BatchCreateAnnotationsRequest" |
| 891 }, |
| 892 "response": { |
| 893 "$ref": "BatchCreateAnnotationsResponse" |
| 894 }, |
| 895 "scopes": [ |
| 896 "https://www.googleapis.com/auth/cloud-platform", |
| 897 "https://www.googleapis.com/auth/genomics" |
| 898 ] |
711 } | 899 } |
712 } | 900 } |
713 }, | 901 }, |
714 "readgroupsets": { | 902 "variantsets": { |
715 "methods": { | 903 "methods": { |
716 "import": { | 904 "create": { |
717 "description": "Creates read group sets by asynchronously im
porting the provided information. For the definitions of read group sets and oth
er genomics resources, see [Fundamentals of Google Genomics](https://cloud.googl
e.com/genomics/fundamentals-of-google-genomics) The caller must have WRITE permi
ssions to the dataset. ## Notes on [BAM](https://samtools.github.io/hts-specs/SA
Mv1.pdf) import - Tags will be converted to strings - tag types are not preserve
d - Comments (`@CO`) in the input file header will not be preserved - Original h
eader order of references (`@SQ`) will not be preserved - Any reverse stranded u
nmapped reads will be reverse complemented, and their qualities (also the \"BQ\"
and \"OQ\" tags, if any) will be reversed - Unmapped reads will be stripped of
positional information (reference name and position)", | 905 "description": "Creates a new variant set.\n\nFor the defini
tions of variant sets and other genomics resources, see\n[Fundamentals of Google
\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n
\nThe provided variant set must have a valid `datasetId` set - all other\nfields
are optional. Note that the `id` field will be ignored, as this is\nassigned by
the server.", |
718 "httpMethod": "POST", | 906 "httpMethod": "POST", |
719 "id": "genomics.readgroupsets.import", | 907 "id": "genomics.variantsets.create", |
720 "path": "v1/readgroupsets:import", | 908 "parameterOrder": [], |
| 909 "parameters": {}, |
| 910 "path": "v1/variantsets", |
721 "request": { | 911 "request": { |
722 "$ref": "ImportReadGroupSetsRequest" | 912 "$ref": "VariantSet" |
| 913 }, |
| 914 "response": { |
| 915 "$ref": "VariantSet" |
| 916 }, |
| 917 "scopes": [ |
| 918 "https://www.googleapis.com/auth/cloud-platform", |
| 919 "https://www.googleapis.com/auth/genomics" |
| 920 ] |
| 921 }, |
| 922 "export": { |
| 923 "description": "Exports variant set data to an external dest
ination.\n\nFor the definitions of variant sets and other genomics resources, se
e\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamen
tals-of-google-genomics)", |
| 924 "httpMethod": "POST", |
| 925 "id": "genomics.variantsets.export", |
| 926 "parameterOrder": [ |
| 927 "variantSetId" |
| 928 ], |
| 929 "parameters": { |
| 930 "variantSetId": { |
| 931 "description": "Required. The ID of the variant set
that contains variant data which\nshould be exported. The caller must have READ
access to this variant set.", |
| 932 "location": "path", |
| 933 "required": true, |
| 934 "type": "string" |
| 935 } |
| 936 }, |
| 937 "path": "v1/variantsets/{variantSetId}:export", |
| 938 "request": { |
| 939 "$ref": "ExportVariantSetRequest" |
723 }, | 940 }, |
724 "response": { | 941 "response": { |
725 "$ref": "Operation" | 942 "$ref": "Operation" |
726 }, | 943 }, |
727 "scopes": [ | 944 "scopes": [ |
| 945 "https://www.googleapis.com/auth/bigquery", |
728 "https://www.googleapis.com/auth/cloud-platform", | 946 "https://www.googleapis.com/auth/cloud-platform", |
729 "https://www.googleapis.com/auth/devstorage.read_write", | |
730 "https://www.googleapis.com/auth/genomics" | |
731 ] | |
732 }, | |
733 "export": { | |
734 "description": "Exports a read group set to a BAM file in Go
ogle Cloud Storage. For the definitions of read group sets and other genomics re
sources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics
/fundamentals-of-google-genomics) Note that currently there may be some differen
ces between exported BAM files and the original BAM file at the time of import.
See ImportReadGroupSets for caveats.", | |
735 "httpMethod": "POST", | |
736 "id": "genomics.readgroupsets.export", | |
737 "parameterOrder": [ | |
738 "readGroupSetId" | |
739 ], | |
740 "parameters": { | |
741 "readGroupSetId": { | |
742 "description": "Required. The ID of the read group s
et to export. The caller must have READ access to this read group set.", | |
743 "location": "path", | |
744 "required": true, | |
745 "type": "string" | |
746 } | |
747 }, | |
748 "path": "v1/readgroupsets/{readGroupSetId}:export", | |
749 "request": { | |
750 "$ref": "ExportReadGroupSetRequest" | |
751 }, | |
752 "response": { | |
753 "$ref": "Operation" | |
754 }, | |
755 "scopes": [ | |
756 "https://www.googleapis.com/auth/cloud-platform", | |
757 "https://www.googleapis.com/auth/devstorage.read_write", | |
758 "https://www.googleapis.com/auth/genomics" | 947 "https://www.googleapis.com/auth/genomics" |
759 ] | 948 ] |
760 }, | 949 }, |
761 "search": { | 950 "search": { |
762 "description": "Searches for read group sets matching the cr
iteria. For the definitions of read group sets and other genomics resources, see
[Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamental
s-of-google-genomics) Implements [GlobalAllianceApi.searchReadGroupSets](https:/
/github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/readmethods.avdl#L
135).", | 951 "description": "Returns a list of all variant sets matching
search criteria.\n\nFor the definitions of variant sets and other genomics resou
rces, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/
fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchVariant
Sets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/varia
ntmethods.avdl#L49).", |
763 "httpMethod": "POST", | 952 "httpMethod": "POST", |
764 "id": "genomics.readgroupsets.search", | 953 "id": "genomics.variantsets.search", |
765 "path": "v1/readgroupsets/search", | 954 "parameterOrder": [], |
| 955 "parameters": {}, |
| 956 "path": "v1/variantsets/search", |
766 "request": { | 957 "request": { |
767 "$ref": "SearchReadGroupSetsRequest" | 958 "$ref": "SearchVariantSetsRequest" |
768 }, | 959 }, |
769 "response": { | 960 "response": { |
770 "$ref": "SearchReadGroupSetsResponse" | 961 "$ref": "SearchVariantSetsResponse" |
771 }, | 962 }, |
772 "scopes": [ | 963 "scopes": [ |
773 "https://www.googleapis.com/auth/cloud-platform", | 964 "https://www.googleapis.com/auth/cloud-platform", |
774 "https://www.googleapis.com/auth/genomics", | 965 "https://www.googleapis.com/auth/genomics", |
775 "https://www.googleapis.com/auth/genomics.readonly" | 966 "https://www.googleapis.com/auth/genomics.readonly" |
776 ] | 967 ] |
777 }, | 968 }, |
| 969 "get": { |
| 970 "description": "Gets a variant set by ID.\n\nFor the definit
ions of variant sets and other genomics resources, see\n[Fundamentals of Google\
nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", |
| 971 "httpMethod": "GET", |
| 972 "id": "genomics.variantsets.get", |
| 973 "parameterOrder": [ |
| 974 "variantSetId" |
| 975 ], |
| 976 "parameters": { |
| 977 "variantSetId": { |
| 978 "description": "Required. The ID of the variant set.
", |
| 979 "location": "path", |
| 980 "required": true, |
| 981 "type": "string" |
| 982 } |
| 983 }, |
| 984 "path": "v1/variantsets/{variantSetId}", |
| 985 "response": { |
| 986 "$ref": "VariantSet" |
| 987 }, |
| 988 "scopes": [ |
| 989 "https://www.googleapis.com/auth/cloud-platform", |
| 990 "https://www.googleapis.com/auth/genomics", |
| 991 "https://www.googleapis.com/auth/genomics.readonly" |
| 992 ] |
| 993 }, |
778 "patch": { | 994 "patch": { |
779 "description": "Updates a read group set. For the definition
s of read group sets and other genomics resources, see [Fundamentals of Google G
enomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) This
method supports patch semantics.", | 995 "description": "Updates a variant set using patch semantics.
\n\nFor the definitions of variant sets and other genomics resources, see\n[Fund
amentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-
google-genomics)", |
780 "httpMethod": "PATCH", | 996 "httpMethod": "PATCH", |
781 "id": "genomics.readgroupsets.patch", | 997 "id": "genomics.variantsets.patch", |
782 "parameterOrder": [ | 998 "parameterOrder": [ |
783 "readGroupSetId" | 999 "variantSetId" |
784 ], | 1000 ], |
785 "parameters": { | 1001 "parameters": { |
786 "readGroupSetId": { | 1002 "updateMask": { |
787 "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.", | 1003 "description": "An optional mask specifying which fi
elds to update. Supported fields:\n\n* metadata.\n* name.\n* description.\n\nLea
ving `updateMask` unset is equivalent to specifying all mutable\nfields.", |
| 1004 "format": "google-fieldmask", |
| 1005 "location": "query", |
| 1006 "type": "string" |
| 1007 }, |
| 1008 "variantSetId": { |
| 1009 "description": "The ID of the variant to be updated
(must already exist).", |
788 "location": "path", | 1010 "location": "path", |
789 "required": true, | 1011 "required": true, |
790 "type": "string" | 1012 "type": "string" |
791 }, | |
792 "updateMask": { | |
793 "description": "An optional mask specifying which fi
elds to update. Supported fields: * name. * referenceSetId. Leaving `updateMask`
unset is equivalent to specifying all mutable fields.", | |
794 "location": "query", | |
795 "type": "string" | |
796 } | 1013 } |
797 }, | 1014 }, |
798 "path": "v1/readgroupsets/{readGroupSetId}", | 1015 "path": "v1/variantsets/{variantSetId}", |
799 "request": { | 1016 "request": { |
800 "$ref": "ReadGroupSet" | 1017 "$ref": "VariantSet" |
801 }, | 1018 }, |
802 "response": { | 1019 "response": { |
803 "$ref": "ReadGroupSet" | 1020 "$ref": "VariantSet" |
804 }, | 1021 }, |
805 "scopes": [ | 1022 "scopes": [ |
806 "https://www.googleapis.com/auth/cloud-platform", | 1023 "https://www.googleapis.com/auth/cloud-platform", |
807 "https://www.googleapis.com/auth/genomics" | 1024 "https://www.googleapis.com/auth/genomics" |
808 ] | 1025 ] |
809 }, | 1026 }, |
810 "delete": { | 1027 "delete": { |
811 "description": "Deletes a read group set. For the definition
s of read group sets and other genomics resources, see [Fundamentals of Google G
enomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", | 1028 "description": "Deletes a variant set including all variants
, call sets, and calls within.\nThis is not reversible.\n\nFor the definitions o
f variant sets and other genomics resources, see\n[Fundamentals of Google\nGenom
ics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", |
812 "httpMethod": "DELETE", | 1029 "httpMethod": "DELETE", |
813 "id": "genomics.readgroupsets.delete", | 1030 "id": "genomics.variantsets.delete", |
814 "parameterOrder": [ | 1031 "parameterOrder": [ |
815 "readGroupSetId" | 1032 "variantSetId" |
816 ], | 1033 ], |
817 "parameters": { | 1034 "parameters": { |
818 "readGroupSetId": { | 1035 "variantSetId": { |
819 "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.", | 1036 "description": "The ID of the variant set to be dele
ted.", |
820 "location": "path", | 1037 "location": "path", |
821 "required": true, | 1038 "required": true, |
822 "type": "string" | 1039 "type": "string" |
823 } | 1040 } |
824 }, | 1041 }, |
825 "path": "v1/readgroupsets/{readGroupSetId}", | 1042 "path": "v1/variantsets/{variantSetId}", |
826 "response": { | 1043 "response": { |
827 "$ref": "Empty" | 1044 "$ref": "Empty" |
828 }, | 1045 }, |
829 "scopes": [ | 1046 "scopes": [ |
830 "https://www.googleapis.com/auth/cloud-platform", | 1047 "https://www.googleapis.com/auth/cloud-platform", |
831 "https://www.googleapis.com/auth/genomics" | 1048 "https://www.googleapis.com/auth/genomics" |
832 ] | 1049 ] |
| 1050 } |
| 1051 } |
| 1052 }, |
| 1053 "operations": { |
| 1054 "methods": { |
| 1055 "cancel": { |
| 1056 "description": "Starts asynchronous cancellation on a long-r
unning operation. The server makes a best effort to cancel the operation, but su
ccess is not guaranteed. Clients may use Operations.GetOperation or Operations.L
istOperations to check whether the cancellation succeeded or the operation compl
eted despite cancellation.", |
| 1057 "httpMethod": "POST", |
| 1058 "id": "genomics.operations.cancel", |
| 1059 "parameterOrder": [ |
| 1060 "name" |
| 1061 ], |
| 1062 "parameters": { |
| 1063 "name": { |
| 1064 "description": "The name of the operation resource t
o be cancelled.", |
| 1065 "location": "path", |
| 1066 "pattern": "^operations/.+$", |
| 1067 "required": true, |
| 1068 "type": "string" |
| 1069 } |
| 1070 }, |
| 1071 "path": "v1/{+name}:cancel", |
| 1072 "request": { |
| 1073 "$ref": "CancelOperationRequest" |
| 1074 }, |
| 1075 "response": { |
| 1076 "$ref": "Empty" |
| 1077 }, |
| 1078 "scopes": [ |
| 1079 "https://www.googleapis.com/auth/cloud-platform", |
| 1080 "https://www.googleapis.com/auth/genomics" |
| 1081 ] |
| 1082 }, |
| 1083 "list": { |
| 1084 "description": "Lists operations that match the specified fi
lter in the request.", |
| 1085 "httpMethod": "GET", |
| 1086 "id": "genomics.operations.list", |
| 1087 "parameterOrder": [ |
| 1088 "name" |
| 1089 ], |
| 1090 "parameters": { |
| 1091 "pageSize": { |
| 1092 "description": "The maximum number of results to ret
urn. If unspecified, defaults to\n256. The maximum value is 2048.", |
| 1093 "format": "int32", |
| 1094 "location": "query", |
| 1095 "type": "integer" |
| 1096 }, |
| 1097 "filter": { |
| 1098 "description": "A string for filtering Operations.\n
The following filter fields are supported:\n\n* projectId: Required. Cor
responds to\n OperationMetadata.projectId.\n* createTime: The time this job
was created, in seconds from the\n [epoch](http://en.wikipedia.org/wiki/Unix_t
ime). Can use `>=` and/or `<=`\n operators.\n* status: Can be `RUNNING`, `S
UCCESS`, `FAILURE`, or `CANCELED`. Only\n one status may be specified.\n* label
s.key where key is a label key.\n\nExamples:\n\n* `projectId = my-project AN
D createTime >= 1432140000`\n* `projectId = my-project AND createTime >= 1432140
000 AND createTime <= 1432150000 AND status = RUNNING`\n* `projectId = my-projec
t AND labels.color = *`\n* `projectId = my-project AND labels.color = red`", |
| 1099 "location": "query", |
| 1100 "type": "string" |
| 1101 }, |
| 1102 "name": { |
| 1103 "description": "The name of the operation collection
.", |
| 1104 "location": "path", |
| 1105 "pattern": "^operations$", |
| 1106 "required": true, |
| 1107 "type": "string" |
| 1108 }, |
| 1109 "pageToken": { |
| 1110 "description": "The standard list page token.", |
| 1111 "location": "query", |
| 1112 "type": "string" |
| 1113 } |
| 1114 }, |
| 1115 "path": "v1/{+name}", |
| 1116 "response": { |
| 1117 "$ref": "ListOperationsResponse" |
| 1118 }, |
| 1119 "scopes": [ |
| 1120 "https://www.googleapis.com/auth/cloud-platform", |
| 1121 "https://www.googleapis.com/auth/genomics" |
| 1122 ] |
833 }, | 1123 }, |
834 "get": { | 1124 "get": { |
835 "description": "Gets a read group set by ID. For the definit
ions of read group sets and other genomics resources, see [Fundamentals of Googl
e Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", | 1125 "description": "Gets the latest state of a long-running oper
ation. Clients can use this\nmethod to poll the operation result at intervals a
s recommended by the API\nservice.", |
836 "httpMethod": "GET", | 1126 "httpMethod": "GET", |
837 "id": "genomics.readgroupsets.get", | 1127 "id": "genomics.operations.get", |
838 "parameterOrder": [ | 1128 "parameterOrder": [ |
839 "readGroupSetId" | 1129 "name" |
840 ], | 1130 ], |
841 "parameters": { | 1131 "parameters": { |
842 "readGroupSetId": { | 1132 "name": { |
843 "description": "The ID of the read group set.", | 1133 "description": "The name of the operation resource."
, |
844 "location": "path", | 1134 "location": "path", |
| 1135 "pattern": "^operations/.+$", |
845 "required": true, | 1136 "required": true, |
846 "type": "string" | 1137 "type": "string" |
847 } | 1138 } |
848 }, | 1139 }, |
849 "path": "v1/readgroupsets/{readGroupSetId}", | 1140 "path": "v1/{+name}", |
850 "response": { | 1141 "response": { |
851 "$ref": "ReadGroupSet" | 1142 "$ref": "Operation" |
852 }, | 1143 }, |
853 "scopes": [ | 1144 "scopes": [ |
854 "https://www.googleapis.com/auth/cloud-platform", | 1145 "https://www.googleapis.com/auth/cloud-platform", |
855 "https://www.googleapis.com/auth/genomics", | |
856 "https://www.googleapis.com/auth/genomics.readonly" | |
857 ] | |
858 } | |
859 }, | |
860 "resources": { | |
861 "coveragebuckets": { | |
862 "methods": { | |
863 "list": { | |
864 "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. For the definitions of read group sets and other genomics resources, see [
Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-
of-google-genomics) Coverage is defined as the number of reads which are aligned
to a given base in the reference sequence. Coverage buckets are available at se
veral precomputed bucket widths, enabling retrieval of various coverage 'zoom le
vels'. The caller must have READ permissions for the target read group set.", | |
865 "httpMethod": "GET", | |
866 "id": "genomics.readgroupsets.coveragebuckets.list", | |
867 "parameterOrder": [ | |
868 "readGroupSetId" | |
869 ], | |
870 "parameters": { | |
871 "readGroupSetId": { | |
872 "description": "Required. The ID of the read
group set over which coverage is requested.", | |
873 "location": "path", | |
874 "required": true, | |
875 "type": "string" | |
876 }, | |
877 "referenceName": { | |
878 "description": "The name of the reference to
query, within the reference set associated with this query. Optional.", | |
879 "location": "query", | |
880 "type": "string" | |
881 }, | |
882 "start": { | |
883 "description": "The start position of the ra
nge on the reference, 0-based inclusive. If specified, `referenceName` must also
be specified. Defaults to 0.", | |
884 "format": "int64", | |
885 "location": "query", | |
886 "type": "string" | |
887 }, | |
888 "end": { | |
889 "description": "The end position of the rang
e on the reference, 0-based exclusive. If specified, `referenceName` must also b
e specified. If unset or 0, defaults to the length of the reference.", | |
890 "format": "int64", | |
891 "location": "query", | |
892 "type": "string" | |
893 }, | |
894 "targetBucketWidth": { | |
895 "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
response. Defaults to infinity (each bucket spans an entire reference sequence)
or the length of the target range, if specified. The smallest precomputed `bucke
tWidth` is currently 2048 base pairs; this is subject to change.", | |
896 "format": "int64", | |
897 "location": "query", | |
898 "type": "string" | |
899 }, | |
900 "pageToken": { | |
901 "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.", | |
902 "location": "query", | |
903 "type": "string" | |
904 }, | |
905 "pageSize": { | |
906 "description": "The maximum number of result
s to return in a single page. If unspecified, defaults to 1024. The maximum valu
e is 2048.", | |
907 "format": "int32", | |
908 "location": "query", | |
909 "type": "integer" | |
910 } | |
911 }, | |
912 "path": "v1/readgroupsets/{readGroupSetId}/coverageb
uckets", | |
913 "response": { | |
914 "$ref": "ListCoverageBucketsResponse" | |
915 }, | |
916 "scopes": [ | |
917 "https://www.googleapis.com/auth/cloud-platform"
, | |
918 "https://www.googleapis.com/auth/genomics", | |
919 "https://www.googleapis.com/auth/genomics.readon
ly" | |
920 ] | |
921 } | |
922 } | |
923 } | |
924 } | |
925 }, | |
926 "reads": { | |
927 "methods": { | |
928 "search": { | |
929 "description": "Gets a list of reads for one or more read gr
oup sets. For the definitions of read group sets and other genomics resources, s
ee [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundament
als-of-google-genomics) Reads search operates over a genomic coordinate space of
reference sequence & position defined over the reference sequences to which the
requested read group sets are aligned. If a target positional range is specifie
d, search returns all reads whose alignment to the reference genome overlap the
range. A query which specifies only read group set IDs yields all reads in those
read group sets, including unmapped reads. All reads returned (including reads
on subsequent pages) are ordered by genomic coordinate (by reference sequence, t
hen position). Reads with equivalent genomic coordinates are returned in an unsp
ecified order. This order is consistent, such that two queries for the same cont
ent (regardless of page size) yield reads in the same order across their respect
ive streams of paginated responses. Implements [GlobalAllianceApi.searchReads](h
ttps://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/readmethods.
avdl#L85).", | |
930 "httpMethod": "POST", | |
931 "id": "genomics.reads.search", | |
932 "path": "v1/reads/search", | |
933 "request": { | |
934 "$ref": "SearchReadsRequest" | |
935 }, | |
936 "response": { | |
937 "$ref": "SearchReadsResponse" | |
938 }, | |
939 "scopes": [ | |
940 "https://www.googleapis.com/auth/cloud-platform", | |
941 "https://www.googleapis.com/auth/genomics", | |
942 "https://www.googleapis.com/auth/genomics.readonly" | |
943 ] | |
944 }, | |
945 "stream": { | |
946 "description": "Returns a stream of all the reads matching t
he search request, ordered by reference name, position, and ID.", | |
947 "httpMethod": "POST", | |
948 "id": "genomics.reads.stream", | |
949 "path": "v1/reads:stream", | |
950 "request": { | |
951 "$ref": "StreamReadsRequest" | |
952 }, | |
953 "response": { | |
954 "$ref": "StreamReadsResponse" | |
955 }, | |
956 "scopes": [ | |
957 "https://www.googleapis.com/auth/cloud-platform", | |
958 "https://www.googleapis.com/auth/genomics" | 1146 "https://www.googleapis.com/auth/genomics" |
959 ] | 1147 ] |
960 } | 1148 } |
961 } | 1149 } |
962 }, | 1150 }, |
963 "referencesets": { | 1151 "referencesets": { |
964 "methods": { | 1152 "methods": { |
965 "search": { | 1153 "search": { |
966 "description": "Searches for reference sets which match the
given criteria. For the definitions of references and other genomics resources,
see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamen
tals-of-google-genomics) Implements [GlobalAllianceApi.searchReferenceSets](http
s://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethod
s.avdl#L71)", | 1154 "description": "Searches for reference sets which match the
given criteria.\n\nFor the definitions of references and other genomics resource
s, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fun
damentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchReferenceS
ets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/refere
ncemethods.avdl#L71)", |
967 "httpMethod": "POST", | 1155 "httpMethod": "POST", |
968 "id": "genomics.referencesets.search", | 1156 "id": "genomics.referencesets.search", |
| 1157 "parameterOrder": [], |
| 1158 "parameters": {}, |
969 "path": "v1/referencesets/search", | 1159 "path": "v1/referencesets/search", |
970 "request": { | 1160 "request": { |
971 "$ref": "SearchReferenceSetsRequest" | 1161 "$ref": "SearchReferenceSetsRequest" |
972 }, | 1162 }, |
973 "response": { | 1163 "response": { |
974 "$ref": "SearchReferenceSetsResponse" | 1164 "$ref": "SearchReferenceSetsResponse" |
975 }, | 1165 }, |
976 "scopes": [ | 1166 "scopes": [ |
977 "https://www.googleapis.com/auth/cloud-platform", | 1167 "https://www.googleapis.com/auth/cloud-platform", |
978 "https://www.googleapis.com/auth/genomics", | 1168 "https://www.googleapis.com/auth/genomics", |
979 "https://www.googleapis.com/auth/genomics.readonly" | 1169 "https://www.googleapis.com/auth/genomics.readonly" |
980 ] | 1170 ] |
981 }, | 1171 }, |
982 "get": { | 1172 "get": { |
983 "description": "Gets a reference set. For the definitions of
references and other genomics resources, see [Fundamentals of Google Genomics](
https://cloud.google.com/genomics/fundamentals-of-google-genomics) Implements [G
lobalAllianceApi.getReferenceSet](https://github.com/ga4gh/schemas/blob/v0.5.1/s
rc/main/resources/avro/referencemethods.avdl#L83).", | 1173 "description": "Gets a reference set.\n\nFor the definitions
of references and other genomics resources, see\n[Fundamentals of Google\nGenom
ics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImple
ments\n[GlobalAllianceApi.getReferenceSet](https://github.com/ga4gh/schemas/blob
/v0.5.1/src/main/resources/avro/referencemethods.avdl#L83).", |
984 "httpMethod": "GET", | 1174 "httpMethod": "GET", |
985 "id": "genomics.referencesets.get", | 1175 "id": "genomics.referencesets.get", |
986 "parameterOrder": [ | 1176 "parameterOrder": [ |
987 "referenceSetId" | 1177 "referenceSetId" |
988 ], | 1178 ], |
989 "parameters": { | 1179 "parameters": { |
990 "referenceSetId": { | 1180 "referenceSetId": { |
991 "description": "The ID of the reference set.", | 1181 "description": "The ID of the reference set.", |
992 "location": "path", | 1182 "location": "path", |
993 "required": true, | 1183 "required": true, |
994 "type": "string" | 1184 "type": "string" |
995 } | 1185 } |
996 }, | 1186 }, |
997 "path": "v1/referencesets/{referenceSetId}", | 1187 "path": "v1/referencesets/{referenceSetId}", |
998 "response": { | 1188 "response": { |
999 "$ref": "ReferenceSet" | 1189 "$ref": "ReferenceSet" |
1000 }, | 1190 }, |
1001 "scopes": [ | 1191 "scopes": [ |
1002 "https://www.googleapis.com/auth/cloud-platform", | 1192 "https://www.googleapis.com/auth/cloud-platform", |
1003 "https://www.googleapis.com/auth/genomics", | 1193 "https://www.googleapis.com/auth/genomics", |
1004 "https://www.googleapis.com/auth/genomics.readonly" | 1194 "https://www.googleapis.com/auth/genomics.readonly" |
1005 ] | 1195 ] |
1006 } | 1196 } |
1007 } | 1197 } |
1008 }, | 1198 }, |
1009 "references": { | 1199 "readgroupsets": { |
1010 "methods": { | 1200 "methods": { |
1011 "search": { | 1201 "export": { |
1012 "description": "Searches for references which match the give
n criteria. For the definitions of references and other genomics resources, see
[Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals
-of-google-genomics) Implements [GlobalAllianceApi.searchReferences](https://git
hub.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#
L146).", | 1202 "description": "Exports a read group set to a BAM file in Go
ogle Cloud Storage.\n\nFor the definitions of read group sets and other genomics
resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/gen
omics/fundamentals-of-google-genomics)\n\nNote that currently there may be some
differences between exported BAM\nfiles and the original BAM file at the time of
import. See\nImportReadGroupSets\nfor caveats.", |
1013 "httpMethod": "POST", | 1203 "httpMethod": "POST", |
1014 "id": "genomics.references.search", | 1204 "id": "genomics.readgroupsets.export", |
1015 "path": "v1/references/search", | |
1016 "request": { | |
1017 "$ref": "SearchReferencesRequest" | |
1018 }, | |
1019 "response": { | |
1020 "$ref": "SearchReferencesResponse" | |
1021 }, | |
1022 "scopes": [ | |
1023 "https://www.googleapis.com/auth/cloud-platform", | |
1024 "https://www.googleapis.com/auth/genomics", | |
1025 "https://www.googleapis.com/auth/genomics.readonly" | |
1026 ] | |
1027 }, | |
1028 "get": { | |
1029 "description": "Gets a reference. For the definitions of ref
erences and other genomics resources, see [Fundamentals of Google Genomics](http
s://cloud.google.com/genomics/fundamentals-of-google-genomics) Implements [Globa
lAllianceApi.getReference](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main
/resources/avro/referencemethods.avdl#L158).", | |
1030 "httpMethod": "GET", | |
1031 "id": "genomics.references.get", | |
1032 "parameterOrder": [ | 1205 "parameterOrder": [ |
1033 "referenceId" | 1206 "readGroupSetId" |
1034 ], | 1207 ], |
1035 "parameters": { | 1208 "parameters": { |
1036 "referenceId": { | 1209 "readGroupSetId": { |
1037 "description": "The ID of the reference.", | 1210 "description": "Required. The ID of the read group s
et to export. The caller must have\nREAD access to this read group set.", |
1038 "location": "path", | 1211 "location": "path", |
1039 "required": true, | 1212 "required": true, |
1040 "type": "string" | 1213 "type": "string" |
1041 } | 1214 } |
1042 }, | 1215 }, |
1043 "path": "v1/references/{referenceId}", | 1216 "path": "v1/readgroupsets/{readGroupSetId}:export", |
1044 "response": { | |
1045 "$ref": "Reference" | |
1046 }, | |
1047 "scopes": [ | |
1048 "https://www.googleapis.com/auth/cloud-platform", | |
1049 "https://www.googleapis.com/auth/genomics", | |
1050 "https://www.googleapis.com/auth/genomics.readonly" | |
1051 ] | |
1052 } | |
1053 }, | |
1054 "resources": { | |
1055 "bases": { | |
1056 "methods": { | |
1057 "list": { | |
1058 "description": "Lists the bases in a reference, opti
onally restricted to a range. For the definitions of references and other genomi
cs resources, see [Fundamentals of Google Genomics](https://cloud.google.com/gen
omics/fundamentals-of-google-genomics) Implements [GlobalAllianceApi.getReferenc
eBases](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/ref
erencemethods.avdl#L221).", | |
1059 "httpMethod": "GET", | |
1060 "id": "genomics.references.bases.list", | |
1061 "parameterOrder": [ | |
1062 "referenceId" | |
1063 ], | |
1064 "parameters": { | |
1065 "referenceId": { | |
1066 "description": "The ID of the reference.", | |
1067 "location": "path", | |
1068 "required": true, | |
1069 "type": "string" | |
1070 }, | |
1071 "start": { | |
1072 "description": "The start position (0-based)
of this query. Defaults to 0.", | |
1073 "format": "int64", | |
1074 "location": "query", | |
1075 "type": "string" | |
1076 }, | |
1077 "end": { | |
1078 "description": "The end position (0-based, e
xclusive) of this query. Defaults to the length of this reference.", | |
1079 "format": "int64", | |
1080 "location": "query", | |
1081 "type": "string" | |
1082 }, | |
1083 "pageToken": { | |
1084 "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.", | |
1085 "location": "query", | |
1086 "type": "string" | |
1087 }, | |
1088 "pageSize": { | |
1089 "description": "The maximum number of bases
to return in a single page. If unspecified, defaults to 200Kbp (kilo base pairs)
. The maximum value is 10Mbp (mega base pairs).", | |
1090 "format": "int32", | |
1091 "location": "query", | |
1092 "type": "integer" | |
1093 } | |
1094 }, | |
1095 "path": "v1/references/{referenceId}/bases", | |
1096 "response": { | |
1097 "$ref": "ListBasesResponse" | |
1098 }, | |
1099 "scopes": [ | |
1100 "https://www.googleapis.com/auth/cloud-platform"
, | |
1101 "https://www.googleapis.com/auth/genomics", | |
1102 "https://www.googleapis.com/auth/genomics.readon
ly" | |
1103 ] | |
1104 } | |
1105 } | |
1106 } | |
1107 } | |
1108 }, | |
1109 "variants": { | |
1110 "methods": { | |
1111 "import": { | |
1112 "description": "Creates variant data by asynchronously impor
ting the provided information. For the definitions of variant sets and other gen
omics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/
genomics/fundamentals-of-google-genomics) The variants for import will be merged
with any existing variant that matches its reference sequence, start, end, refe
rence bases, and alternative bases. If no such variant exists, a new one will be
created. When variants are merged, the call information from the new variant is
added to the existing variant, and Variant info fields are merged as specified
in infoMergeConfig. As a special case, for single-sample VCF files, QUAL and FIL
TER fields will be moved to the call level; these are sometimes interpreted in a
call-specific context. Imported VCF headers are appended to the metadata alread
y in a variant set.", | |
1113 "httpMethod": "POST", | |
1114 "id": "genomics.variants.import", | |
1115 "path": "v1/variants:import", | |
1116 "request": { | 1217 "request": { |
1117 "$ref": "ImportVariantsRequest" | 1218 "$ref": "ExportReadGroupSetRequest" |
1118 }, | 1219 }, |
1119 "response": { | 1220 "response": { |
1120 "$ref": "Operation" | 1221 "$ref": "Operation" |
1121 }, | 1222 }, |
1122 "scopes": [ | 1223 "scopes": [ |
1123 "https://www.googleapis.com/auth/cloud-platform", | 1224 "https://www.googleapis.com/auth/cloud-platform", |
1124 "https://www.googleapis.com/auth/devstorage.read_write", | 1225 "https://www.googleapis.com/auth/devstorage.read_write", |
1125 "https://www.googleapis.com/auth/genomics" | 1226 "https://www.googleapis.com/auth/genomics" |
1126 ] | 1227 ] |
1127 }, | 1228 }, |
1128 "search": { | 1229 "search": { |
1129 "description": "Gets a list of variants matching the criteri
a. For the definitions of variants and other genomics resources, see [Fundamenta
ls of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-
genomics) Implements [GlobalAllianceApi.searchVariants](https://github.com/ga4gh
/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L126).", | 1230 "description": "Searches for read group sets matching the cr
iteria.\n\nFor the definitions of read group sets and other genomics resources,
see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundam
entals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchReadGroupSets
](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/readmetho
ds.avdl#L135).", |
1130 "httpMethod": "POST", | 1231 "httpMethod": "POST", |
1131 "id": "genomics.variants.search", | 1232 "id": "genomics.readgroupsets.search", |
1132 "path": "v1/variants/search", | 1233 "parameterOrder": [], |
| 1234 "parameters": {}, |
| 1235 "path": "v1/readgroupsets/search", |
1133 "request": { | 1236 "request": { |
1134 "$ref": "SearchVariantsRequest" | 1237 "$ref": "SearchReadGroupSetsRequest" |
1135 }, | 1238 }, |
1136 "response": { | 1239 "response": { |
1137 "$ref": "SearchVariantsResponse" | 1240 "$ref": "SearchReadGroupSetsResponse" |
1138 }, | 1241 }, |
1139 "scopes": [ | 1242 "scopes": [ |
1140 "https://www.googleapis.com/auth/cloud-platform", | 1243 "https://www.googleapis.com/auth/cloud-platform", |
1141 "https://www.googleapis.com/auth/genomics", | 1244 "https://www.googleapis.com/auth/genomics", |
1142 "https://www.googleapis.com/auth/genomics.readonly" | 1245 "https://www.googleapis.com/auth/genomics.readonly" |
1143 ] | 1246 ] |
1144 }, | 1247 }, |
1145 "create": { | |
1146 "description": "Creates a new variant. For the definitions o
f variants and other genomics resources, see [Fundamentals of Google Genomics](h
ttps://cloud.google.com/genomics/fundamentals-of-google-genomics)", | |
1147 "httpMethod": "POST", | |
1148 "id": "genomics.variants.create", | |
1149 "path": "v1/variants", | |
1150 "request": { | |
1151 "$ref": "Variant" | |
1152 }, | |
1153 "response": { | |
1154 "$ref": "Variant" | |
1155 }, | |
1156 "scopes": [ | |
1157 "https://www.googleapis.com/auth/cloud-platform", | |
1158 "https://www.googleapis.com/auth/genomics" | |
1159 ] | |
1160 }, | |
1161 "patch": { | 1248 "patch": { |
1162 "description": "Updates a variant. For the definitions of va
riants and other genomics resources, see [Fundamentals of Google Genomics](https
://cloud.google.com/genomics/fundamentals-of-google-genomics) This method suppor
ts patch semantics. Returns the modified variant without its calls.", | 1249 "description": "Updates a read group set.\n\nFor the definit
ions of read group sets and other genomics resources, see\n[Fundamentals of Goog
le\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
\n\nThis method supports patch semantics.", |
1163 "httpMethod": "PATCH", | 1250 "httpMethod": "PATCH", |
1164 "id": "genomics.variants.patch", | 1251 "id": "genomics.readgroupsets.patch", |
1165 "parameterOrder": [ | 1252 "parameterOrder": [ |
1166 "variantId" | 1253 "readGroupSetId" |
1167 ], | 1254 ], |
1168 "parameters": { | 1255 "parameters": { |
1169 "variantId": { | 1256 "updateMask": { |
1170 "description": "The ID of the variant to be updated.
", | 1257 "description": "An optional mask specifying which fi
elds to update. Supported fields:\n\n* name.\n* referenceSetId.\n\nLeaving `upda
teMask` unset is equivalent to specifying all mutable\nfields.", |
1171 "location": "path", | 1258 "format": "google-fieldmask", |
1172 "required": true, | 1259 "location": "query", |
1173 "type": "string" | 1260 "type": "string" |
1174 }, | 1261 }, |
1175 "updateMask": { | 1262 "readGroupSetId": { |
1176 "description": "An optional mask specifying which fi
elds to update. At this time, mutable fields are names and info. Acceptable valu
es are \"names\" and \"info\". If unspecified, all mutable fields will be update
d.", | 1263 "description": "The ID of the read group set to be u
pdated. The caller must have WRITE\npermissions to the dataset associated with t
his read group set.", |
1177 "location": "query", | |
1178 "type": "string" | |
1179 } | |
1180 }, | |
1181 "path": "v1/variants/{variantId}", | |
1182 "request": { | |
1183 "$ref": "Variant" | |
1184 }, | |
1185 "response": { | |
1186 "$ref": "Variant" | |
1187 }, | |
1188 "scopes": [ | |
1189 "https://www.googleapis.com/auth/cloud-platform", | |
1190 "https://www.googleapis.com/auth/genomics" | |
1191 ] | |
1192 }, | |
1193 "delete": { | |
1194 "description": "Deletes a variant. For the definitions of va
riants and other genomics resources, see [Fundamentals of Google Genomics](https
://cloud.google.com/genomics/fundamentals-of-google-genomics)", | |
1195 "httpMethod": "DELETE", | |
1196 "id": "genomics.variants.delete", | |
1197 "parameterOrder": [ | |
1198 "variantId" | |
1199 ], | |
1200 "parameters": { | |
1201 "variantId": { | |
1202 "description": "The ID of the variant to be deleted.
", | |
1203 "location": "path", | 1264 "location": "path", |
1204 "required": true, | 1265 "required": true, |
1205 "type": "string" | 1266 "type": "string" |
1206 } | 1267 } |
1207 }, | 1268 }, |
1208 "path": "v1/variants/{variantId}", | 1269 "path": "v1/readgroupsets/{readGroupSetId}", |
| 1270 "request": { |
| 1271 "$ref": "ReadGroupSet" |
| 1272 }, |
1209 "response": { | 1273 "response": { |
1210 "$ref": "Empty" | 1274 "$ref": "ReadGroupSet" |
1211 }, | 1275 }, |
1212 "scopes": [ | 1276 "scopes": [ |
1213 "https://www.googleapis.com/auth/cloud-platform", | 1277 "https://www.googleapis.com/auth/cloud-platform", |
1214 "https://www.googleapis.com/auth/genomics" | 1278 "https://www.googleapis.com/auth/genomics" |
1215 ] | 1279 ] |
1216 }, | 1280 }, |
1217 "get": { | 1281 "get": { |
1218 "description": "Gets a variant by ID. For the definitions of
variants and other genomics resources, see [Fundamentals of Google Genomics](ht
tps://cloud.google.com/genomics/fundamentals-of-google-genomics)", | 1282 "description": "Gets a read group set by ID.\n\nFor the defi
nitions of read group sets and other genomics resources, see\n[Fundamentals of G
oogle\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomi
cs)", |
1219 "httpMethod": "GET", | 1283 "httpMethod": "GET", |
1220 "id": "genomics.variants.get", | 1284 "id": "genomics.readgroupsets.get", |
1221 "parameterOrder": [ | 1285 "parameterOrder": [ |
1222 "variantId" | 1286 "readGroupSetId" |
1223 ], | 1287 ], |
1224 "parameters": { | 1288 "parameters": { |
1225 "variantId": { | 1289 "readGroupSetId": { |
1226 "description": "The ID of the variant.", | 1290 "description": "The ID of the read group set.", |
1227 "location": "path", | 1291 "location": "path", |
1228 "required": true, | 1292 "required": true, |
1229 "type": "string" | 1293 "type": "string" |
1230 } | 1294 } |
1231 }, | 1295 }, |
1232 "path": "v1/variants/{variantId}", | 1296 "path": "v1/readgroupsets/{readGroupSetId}", |
1233 "response": { | 1297 "response": { |
1234 "$ref": "Variant" | 1298 "$ref": "ReadGroupSet" |
1235 }, | 1299 }, |
1236 "scopes": [ | 1300 "scopes": [ |
1237 "https://www.googleapis.com/auth/cloud-platform", | 1301 "https://www.googleapis.com/auth/cloud-platform", |
1238 "https://www.googleapis.com/auth/genomics", | 1302 "https://www.googleapis.com/auth/genomics", |
1239 "https://www.googleapis.com/auth/genomics.readonly" | 1303 "https://www.googleapis.com/auth/genomics.readonly" |
1240 ] | 1304 ] |
1241 }, | 1305 }, |
1242 "merge": { | 1306 "import": { |
1243 "description": "Merges the given variants with existing vari
ants. For the definitions of variants and other genomics resources, see [Fundame
ntals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-goog
le-genomics) Each variant will be merged with an existing variant that matches i
ts reference sequence, start, end, reference bases, and alternative bases. If no
such variant exists, a new one will be created. When variants are merged, the c
all information from the new variant is added to the existing variant. Variant i
nfo fields are merged as specified in the infoMergeConfig field of the MergeVari
antsRequest. Please exercise caution when using this method! It is easy to intro
duce mistakes in existing variants and difficult to back out of them. For exampl
e, suppose you were trying to merge a new variant with an existing one and both
variants contain calls that belong to callsets with the same callset ID. // Exis
ting variant - irrelevant fields trimmed for clarity { \"variantSetId\": \"10473
108253681171589\", \"referenceName\": \"1\", \"start\": \"10582\", \"referenceBa
ses\": \"G\", \"alternateBases\": [ \"A\" ], \"calls\": [ { \"callSetId\": \"104
73108253681171589-0\", \"callSetName\": \"CALLSET0\", \"genotype\": [ 0, 1 ], }
] } // New variant with conflicting call information { \"variantSetId\": \"10473
108253681171589\", \"referenceName\": \"1\", \"start\": \"10582\", \"referenceBa
ses\": \"G\", \"alternateBases\": [ \"A\" ], \"calls\": [ { \"callSetId\": \"104
73108253681171589-0\", \"callSetName\": \"CALLSET0\", \"genotype\": [ 1, 1 ], }
] } The resulting merged variant would overwrite the existing calls with those f
rom the new variant: { \"variantSetId\": \"10473108253681171589\", \"referenceNa
me\": \"1\", \"start\": \"10582\", \"referenceBases\": \"G\", \"alternateBases\"
: [ \"A\" ], \"calls\": [ { \"callSetId\": \"10473108253681171589-0\", \"callSet
Name\": \"CALLSET0\", \"genotype\": [ 1, 1 ], } ] } This may be the desired outc
ome, but it is up to the user to determine if if that is indeed the case.", | 1307 "description": "Creates read group sets by asynchronously im
porting the provided\ninformation.\n\nFor the definitions of read group sets and
other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud
.google.com/genomics/fundamentals-of-google-genomics)\n\nThe caller must have WR
ITE permissions to the dataset.\n\n## Notes on [BAM](https://samtools.github.io/
hts-specs/SAMv1.pdf) import\n\n- Tags will be converted to strings - tag types a
re not preserved\n- Comments (`@CO`) in the input file header will not be preser
ved\n- Original header order of references (`@SQ`) will not be preserved\n- Any
reverse stranded unmapped reads will be reverse complemented, and\ntheir qualiti
es (also the \"BQ\" and \"OQ\" tags, if any) will be reversed\n- Unmapped reads
will be stripped of positional information (reference name\nand position)", |
1244 "httpMethod": "POST", | 1308 "httpMethod": "POST", |
1245 "id": "genomics.variants.merge", | 1309 "id": "genomics.readgroupsets.import", |
1246 "path": "v1/variants:merge", | 1310 "parameterOrder": [], |
| 1311 "parameters": {}, |
| 1312 "path": "v1/readgroupsets:import", |
1247 "request": { | 1313 "request": { |
1248 "$ref": "MergeVariantsRequest" | 1314 "$ref": "ImportReadGroupSetsRequest" |
1249 }, | 1315 }, |
1250 "response": { | 1316 "response": { |
| 1317 "$ref": "Operation" |
| 1318 }, |
| 1319 "scopes": [ |
| 1320 "https://www.googleapis.com/auth/cloud-platform", |
| 1321 "https://www.googleapis.com/auth/devstorage.read_write", |
| 1322 "https://www.googleapis.com/auth/genomics" |
| 1323 ] |
| 1324 }, |
| 1325 "delete": { |
| 1326 "description": "Deletes a read group set.\n\nFor the definit
ions of read group sets and other genomics resources, see\n[Fundamentals of Goog
le\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
", |
| 1327 "httpMethod": "DELETE", |
| 1328 "id": "genomics.readgroupsets.delete", |
| 1329 "parameterOrder": [ |
| 1330 "readGroupSetId" |
| 1331 ], |
| 1332 "parameters": { |
| 1333 "readGroupSetId": { |
| 1334 "description": "The ID of the read group set to be d
eleted. The caller must have WRITE\npermissions to the dataset associated with t
his read group set.", |
| 1335 "location": "path", |
| 1336 "required": true, |
| 1337 "type": "string" |
| 1338 } |
| 1339 }, |
| 1340 "path": "v1/readgroupsets/{readGroupSetId}", |
| 1341 "response": { |
1251 "$ref": "Empty" | 1342 "$ref": "Empty" |
1252 }, | 1343 }, |
1253 "scopes": [ | 1344 "scopes": [ |
1254 "https://www.googleapis.com/auth/cloud-platform", | 1345 "https://www.googleapis.com/auth/cloud-platform", |
1255 "https://www.googleapis.com/auth/genomics" | 1346 "https://www.googleapis.com/auth/genomics" |
1256 ] | 1347 ] |
1257 }, | |
1258 "stream": { | |
1259 "description": "Returns a stream of all the variants matchin
g the search request, ordered by reference name, position, and ID.", | |
1260 "httpMethod": "POST", | |
1261 "id": "genomics.variants.stream", | |
1262 "path": "v1/variants:stream", | |
1263 "request": { | |
1264 "$ref": "StreamVariantsRequest" | |
1265 }, | |
1266 "response": { | |
1267 "$ref": "StreamVariantsResponse" | |
1268 }, | |
1269 "scopes": [ | |
1270 "https://www.googleapis.com/auth/cloud-platform", | |
1271 "https://www.googleapis.com/auth/genomics" | |
1272 ] | |
1273 } | 1348 } |
| 1349 }, |
| 1350 "resources": { |
| 1351 "coveragebuckets": { |
| 1352 "methods": { |
| 1353 "list": { |
| 1354 "description": "Lists fixed width coverage buckets f
or a read group set, each of which\ncorrespond to a range of a reference sequenc
e. Each bucket summarizes\ncoverage information across its corresponding genomic
range.\n\nFor the definitions of read group sets and other genomics resources,
see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundam
entals-of-google-genomics)\n\nCoverage is defined as the number of reads which a
re aligned to a given\nbase in the reference sequence. Coverage buckets are avai
lable at several\nprecomputed bucket widths, enabling retrieval of various cover
age 'zoom\nlevels'. The caller must have READ permissions for the target read gr
oup\nset.", |
| 1355 "httpMethod": "GET", |
| 1356 "id": "genomics.readgroupsets.coveragebuckets.list", |
| 1357 "parameterOrder": [ |
| 1358 "readGroupSetId" |
| 1359 ], |
| 1360 "parameters": { |
| 1361 "pageSize": { |
| 1362 "description": "The maximum number of result
s to return in a single page. If unspecified,\ndefaults to 1024. The maximum val
ue is 2048.", |
| 1363 "format": "int32", |
| 1364 "location": "query", |
| 1365 "type": "integer" |
| 1366 }, |
| 1367 "start": { |
| 1368 "description": "The start position of the ra
nge on the reference, 0-based inclusive. If\nspecified, `referenceName` must als
o be specified. Defaults to 0.", |
| 1369 "format": "int64", |
| 1370 "location": "query", |
| 1371 "type": "string" |
| 1372 }, |
| 1373 "targetBucketWidth": { |
| 1374 "description": "The desired width of each re
ported coverage bucket in base pairs. This\nwill be rounded down to the nearest
precomputed bucket width; the value\nof which is returned as `bucketWidth` in th
e response. Defaults\nto infinity (each bucket spans an entire reference sequenc
e) or the length\nof the target range, if specified. The smallest precomputed\n`
bucketWidth` is currently 2048 base pairs; this is subject to\nchange.", |
| 1375 "format": "int64", |
| 1376 "location": "query", |
| 1377 "type": "string" |
| 1378 }, |
| 1379 "readGroupSetId": { |
| 1380 "description": "Required. The ID of the read
group set over which coverage is requested.", |
| 1381 "location": "path", |
| 1382 "required": true, |
| 1383 "type": "string" |
| 1384 }, |
| 1385 "referenceName": { |
| 1386 "description": "The name of the reference to
query, within the reference set associated\nwith this query. Optional.", |
| 1387 "location": "query", |
| 1388 "type": "string" |
| 1389 }, |
| 1390 "end": { |
| 1391 "description": "The end position of the rang
e on the reference, 0-based exclusive. If\nspecified, `referenceName` must also
be specified. If unset or 0, defaults\nto the length of the reference.", |
| 1392 "format": "int64", |
| 1393 "location": "query", |
| 1394 "type": "string" |
| 1395 }, |
| 1396 "pageToken": { |
| 1397 "description": "The continuation token, whic
h is used to page through large result sets.\nTo get the next page of results, s
et this parameter to the value of\n`nextPageToken` from the previous response.", |
| 1398 "location": "query", |
| 1399 "type": "string" |
| 1400 } |
| 1401 }, |
| 1402 "path": "v1/readgroupsets/{readGroupSetId}/coverageb
uckets", |
| 1403 "response": { |
| 1404 "$ref": "ListCoverageBucketsResponse" |
| 1405 }, |
| 1406 "scopes": [ |
| 1407 "https://www.googleapis.com/auth/cloud-platform"
, |
| 1408 "https://www.googleapis.com/auth/genomics", |
| 1409 "https://www.googleapis.com/auth/genomics.readon
ly" |
| 1410 ] |
| 1411 } |
| 1412 } |
| 1413 } |
1274 } | 1414 } |
1275 }, | 1415 }, |
1276 "variantsets": { | 1416 "reads": { |
1277 "methods": { | 1417 "methods": { |
1278 "create": { | 1418 "search": { |
1279 "description": "Creates a new variant set. For the definitio
ns of variant sets and other genomics resources, see [Fundamentals of Google Gen
omics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) The pr
ovided variant set must have a valid `datasetId` set - all other fields are opti
onal. Note that the `id` field will be ignored, as this is assigned by the serve
r.", | 1419 "description": "Gets a list of reads for one or more read gr
oup sets.\n\nFor the definitions of read group sets and other genomics resources
, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fund
amentals-of-google-genomics)\n\nReads search operates over a genomic coordinate
space of reference sequence\n& position defined over the reference sequences to
which the requested\nread group sets are aligned.\n\nIf a target positional rang
e is specified, search returns all reads whose\nalignment to the reference genom
e overlap the range. A query which\nspecifies only read group set IDs yields all
reads in those read group\nsets, including unmapped reads.\n\nAll reads returne
d (including reads on subsequent pages) are ordered by\ngenomic coordinate (by r
eference sequence, then position). Reads with\nequivalent genomic coordinates ar
e returned in an unspecified order. This\norder is consistent, such that two que
ries for the same content (regardless\nof page size) yield reads in the same ord
er across their respective streams\nof paginated responses.\n\nImplements\n[Glob
alAllianceApi.searchReads](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main
/resources/avro/readmethods.avdl#L85).", |
1280 "httpMethod": "POST", | 1420 "httpMethod": "POST", |
1281 "id": "genomics.variantsets.create", | 1421 "id": "genomics.reads.search", |
1282 "path": "v1/variantsets", | 1422 "parameterOrder": [], |
| 1423 "parameters": {}, |
| 1424 "path": "v1/reads/search", |
1283 "request": { | 1425 "request": { |
1284 "$ref": "VariantSet" | 1426 "$ref": "SearchReadsRequest" |
1285 }, | 1427 }, |
1286 "response": { | 1428 "response": { |
1287 "$ref": "VariantSet" | 1429 "$ref": "SearchReadsResponse" |
| 1430 }, |
| 1431 "scopes": [ |
| 1432 "https://www.googleapis.com/auth/cloud-platform", |
| 1433 "https://www.googleapis.com/auth/genomics", |
| 1434 "https://www.googleapis.com/auth/genomics.readonly" |
| 1435 ] |
| 1436 } |
| 1437 } |
| 1438 }, |
| 1439 "callsets": { |
| 1440 "methods": { |
| 1441 "search": { |
| 1442 "description": "Gets a list of call sets matching the criter
ia.\n\nFor the definitions of call sets and other genomics resources, see\n[Fund
amentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-
google-genomics)\n\nImplements\n[GlobalAllianceApi.searchCallSets](https://githu
b.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L178
).", |
| 1443 "httpMethod": "POST", |
| 1444 "id": "genomics.callsets.search", |
| 1445 "parameterOrder": [], |
| 1446 "parameters": {}, |
| 1447 "path": "v1/callsets/search", |
| 1448 "request": { |
| 1449 "$ref": "SearchCallSetsRequest" |
| 1450 }, |
| 1451 "response": { |
| 1452 "$ref": "SearchCallSetsResponse" |
| 1453 }, |
| 1454 "scopes": [ |
| 1455 "https://www.googleapis.com/auth/cloud-platform", |
| 1456 "https://www.googleapis.com/auth/genomics", |
| 1457 "https://www.googleapis.com/auth/genomics.readonly" |
| 1458 ] |
| 1459 }, |
| 1460 "patch": { |
| 1461 "description": "Updates a call set.\n\nFor the definitions o
f call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics
](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis met
hod supports patch semantics.", |
| 1462 "httpMethod": "PATCH", |
| 1463 "id": "genomics.callsets.patch", |
| 1464 "parameterOrder": [ |
| 1465 "callSetId" |
| 1466 ], |
| 1467 "parameters": { |
| 1468 "updateMask": { |
| 1469 "description": "An optional mask specifying which fi
elds to update. At this time, the only\nmutable field is name. The only\naccepta
ble value is \"name\". If unspecified, all mutable fields will be\nupdated.", |
| 1470 "format": "google-fieldmask", |
| 1471 "location": "query", |
| 1472 "type": "string" |
| 1473 }, |
| 1474 "callSetId": { |
| 1475 "description": "The ID of the call set to be updated
.", |
| 1476 "location": "path", |
| 1477 "required": true, |
| 1478 "type": "string" |
| 1479 } |
| 1480 }, |
| 1481 "path": "v1/callsets/{callSetId}", |
| 1482 "request": { |
| 1483 "$ref": "CallSet" |
| 1484 }, |
| 1485 "response": { |
| 1486 "$ref": "CallSet" |
1288 }, | 1487 }, |
1289 "scopes": [ | 1488 "scopes": [ |
1290 "https://www.googleapis.com/auth/cloud-platform", | 1489 "https://www.googleapis.com/auth/cloud-platform", |
1291 "https://www.googleapis.com/auth/genomics" | 1490 "https://www.googleapis.com/auth/genomics" |
1292 ] | 1491 ] |
1293 }, | 1492 }, |
1294 "export": { | 1493 "get": { |
1295 "description": "Exports variant set data to an external dest
ination. For the definitions of variant sets and other genomics resources, see [
Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-
of-google-genomics)", | 1494 "description": "Gets a call set by ID.\n\nFor the definition
s of call sets and other genomics resources, see\n[Fundamentals of Google\nGenom
ics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", |
1296 "httpMethod": "POST", | 1495 "httpMethod": "GET", |
1297 "id": "genomics.variantsets.export", | 1496 "id": "genomics.callsets.get", |
1298 "parameterOrder": [ | 1497 "parameterOrder": [ |
1299 "variantSetId" | 1498 "callSetId" |
1300 ], | 1499 ], |
1301 "parameters": { | 1500 "parameters": { |
1302 "variantSetId": { | 1501 "callSetId": { |
1303 "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.", | 1502 "description": "The ID of the call set.", |
1304 "location": "path", | 1503 "location": "path", |
1305 "required": true, | 1504 "required": true, |
1306 "type": "string" | 1505 "type": "string" |
1307 } | 1506 } |
1308 }, | 1507 }, |
1309 "path": "v1/variantsets/{variantSetId}:export", | 1508 "path": "v1/callsets/{callSetId}", |
1310 "request": { | |
1311 "$ref": "ExportVariantSetRequest" | |
1312 }, | |
1313 "response": { | 1509 "response": { |
1314 "$ref": "Operation" | 1510 "$ref": "CallSet" |
1315 }, | |
1316 "scopes": [ | |
1317 "https://www.googleapis.com/auth/bigquery", | |
1318 "https://www.googleapis.com/auth/cloud-platform", | |
1319 "https://www.googleapis.com/auth/genomics" | |
1320 ] | |
1321 }, | |
1322 "get": { | |
1323 "description": "Gets a variant set by ID. For the definition
s of variant sets and other genomics resources, see [Fundamentals of Google Geno
mics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", | |
1324 "httpMethod": "GET", | |
1325 "id": "genomics.variantsets.get", | |
1326 "parameterOrder": [ | |
1327 "variantSetId" | |
1328 ], | |
1329 "parameters": { | |
1330 "variantSetId": { | |
1331 "description": "Required. The ID of the variant set.
", | |
1332 "location": "path", | |
1333 "required": true, | |
1334 "type": "string" | |
1335 } | |
1336 }, | |
1337 "path": "v1/variantsets/{variantSetId}", | |
1338 "response": { | |
1339 "$ref": "VariantSet" | |
1340 }, | 1511 }, |
1341 "scopes": [ | 1512 "scopes": [ |
1342 "https://www.googleapis.com/auth/cloud-platform", | 1513 "https://www.googleapis.com/auth/cloud-platform", |
1343 "https://www.googleapis.com/auth/genomics", | 1514 "https://www.googleapis.com/auth/genomics", |
1344 "https://www.googleapis.com/auth/genomics.readonly" | 1515 "https://www.googleapis.com/auth/genomics.readonly" |
1345 ] | 1516 ] |
1346 }, | 1517 }, |
1347 "search": { | 1518 "create": { |
1348 "description": "Returns a list of all variant sets matching
search criteria. For the definitions of variant sets and other genomics resource
s, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/funda
mentals-of-google-genomics) Implements [GlobalAllianceApi.searchVariantSets](htt
ps://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods
.avdl#L49).", | 1519 "description": "Creates a new call set.\n\nFor the definitio
ns of call sets and other genomics resources, see\n[Fundamentals of Google\nGeno
mics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", |
1349 "httpMethod": "POST", | 1520 "httpMethod": "POST", |
1350 "id": "genomics.variantsets.search", | 1521 "id": "genomics.callsets.create", |
1351 "path": "v1/variantsets/search", | 1522 "parameterOrder": [], |
| 1523 "parameters": {}, |
| 1524 "path": "v1/callsets", |
1352 "request": { | 1525 "request": { |
1353 "$ref": "SearchVariantSetsRequest" | 1526 "$ref": "CallSet" |
1354 }, | 1527 }, |
1355 "response": { | 1528 "response": { |
1356 "$ref": "SearchVariantSetsResponse" | 1529 "$ref": "CallSet" |
1357 }, | 1530 }, |
1358 "scopes": [ | 1531 "scopes": [ |
1359 "https://www.googleapis.com/auth/cloud-platform", | 1532 "https://www.googleapis.com/auth/cloud-platform", |
1360 "https://www.googleapis.com/auth/genomics", | 1533 "https://www.googleapis.com/auth/genomics" |
1361 "https://www.googleapis.com/auth/genomics.readonly" | |
1362 ] | 1534 ] |
1363 }, | 1535 }, |
1364 "delete": { | 1536 "delete": { |
1365 "description": "Deletes a variant set including all variants
, call sets, and calls within. This is not reversible. For the definitions of va
riant sets and other genomics resources, see [Fundamentals of Google Genomics](h
ttps://cloud.google.com/genomics/fundamentals-of-google-genomics)", | 1537 "description": "Deletes a call set.\n\nFor the definitions o
f call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics
](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", |
1366 "httpMethod": "DELETE", | 1538 "httpMethod": "DELETE", |
1367 "id": "genomics.variantsets.delete", | 1539 "id": "genomics.callsets.delete", |
1368 "parameterOrder": [ | 1540 "parameterOrder": [ |
1369 "variantSetId" | 1541 "callSetId" |
1370 ], | 1542 ], |
1371 "parameters": { | 1543 "parameters": { |
1372 "variantSetId": { | 1544 "callSetId": { |
1373 "description": "The ID of the variant set to be dele
ted.", | 1545 "description": "The ID of the call set to be deleted
.", |
1374 "location": "path", | 1546 "location": "path", |
1375 "required": true, | 1547 "required": true, |
1376 "type": "string" | 1548 "type": "string" |
1377 } | 1549 } |
1378 }, | 1550 }, |
1379 "path": "v1/variantsets/{variantSetId}", | 1551 "path": "v1/callsets/{callSetId}", |
1380 "response": { | 1552 "response": { |
1381 "$ref": "Empty" | 1553 "$ref": "Empty" |
1382 }, | 1554 }, |
1383 "scopes": [ | 1555 "scopes": [ |
1384 "https://www.googleapis.com/auth/cloud-platform", | 1556 "https://www.googleapis.com/auth/cloud-platform", |
1385 "https://www.googleapis.com/auth/genomics" | 1557 "https://www.googleapis.com/auth/genomics" |
1386 ] | 1558 ] |
1387 }, | |
1388 "patch": { | |
1389 "description": "Updates a variant set using patch semantics.
For the definitions of variant sets and other genomics resources, see [Fundamen
tals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-googl
e-genomics)", | |
1390 "httpMethod": "PATCH", | |
1391 "id": "genomics.variantsets.patch", | |
1392 "parameterOrder": [ | |
1393 "variantSetId" | |
1394 ], | |
1395 "parameters": { | |
1396 "variantSetId": { | |
1397 "description": "The ID of the variant to be updated
(must already exist).", | |
1398 "location": "path", | |
1399 "required": true, | |
1400 "type": "string" | |
1401 }, | |
1402 "updateMask": { | |
1403 "description": "An optional mask specifying which fi
elds to update. Supported fields: * metadata. * name. * description. Leaving `up
dateMask` unset is equivalent to specifying all mutable fields.", | |
1404 "location": "query", | |
1405 "type": "string" | |
1406 } | |
1407 }, | |
1408 "path": "v1/variantsets/{variantSetId}", | |
1409 "request": { | |
1410 "$ref": "VariantSet" | |
1411 }, | |
1412 "response": { | |
1413 "$ref": "VariantSet" | |
1414 }, | |
1415 "scopes": [ | |
1416 "https://www.googleapis.com/auth/cloud-platform", | |
1417 "https://www.googleapis.com/auth/genomics" | |
1418 ] | |
1419 } | 1559 } |
1420 } | 1560 } |
1421 }, | |
1422 "callsets": { | |
1423 "methods": { | |
1424 "search": { | |
1425 "description": "Gets a list of call sets matching the criter
ia. For the definitions of call sets and other genomics resources, see [Fundamen
tals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-googl
e-genomics) Implements [GlobalAllianceApi.searchCallSets](https://github.com/ga4
gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L178).", | |
1426 "httpMethod": "POST", | |
1427 "id": "genomics.callsets.search", | |
1428 "path": "v1/callsets/search", | |
1429 "request": { | |
1430 "$ref": "SearchCallSetsRequest" | |
1431 }, | |
1432 "response": { | |
1433 "$ref": "SearchCallSetsResponse" | |
1434 }, | |
1435 "scopes": [ | |
1436 "https://www.googleapis.com/auth/cloud-platform", | |
1437 "https://www.googleapis.com/auth/genomics", | |
1438 "https://www.googleapis.com/auth/genomics.readonly" | |
1439 ] | |
1440 }, | |
1441 "create": { | |
1442 "description": "Creates a new call set. For the definitions
of call sets and other genomics resources, see [Fundamentals of Google Genomics]
(https://cloud.google.com/genomics/fundamentals-of-google-genomics)", | |
1443 "httpMethod": "POST", | |
1444 "id": "genomics.callsets.create", | |
1445 "path": "v1/callsets", | |
1446 "request": { | |
1447 "$ref": "CallSet" | |
1448 }, | |
1449 "response": { | |
1450 "$ref": "CallSet" | |
1451 }, | |
1452 "scopes": [ | |
1453 "https://www.googleapis.com/auth/cloud-platform", | |
1454 "https://www.googleapis.com/auth/genomics" | |
1455 ] | |
1456 }, | |
1457 "patch": { | |
1458 "description": "Updates a call set. For the definitions of c
all sets and other genomics resources, see [Fundamentals of Google Genomics](htt
ps://cloud.google.com/genomics/fundamentals-of-google-genomics) This method supp
orts patch semantics.", | |
1459 "httpMethod": "PATCH", | |
1460 "id": "genomics.callsets.patch", | |
1461 "parameterOrder": [ | |
1462 "callSetId" | |
1463 ], | |
1464 "parameters": { | |
1465 "callSetId": { | |
1466 "description": "The ID of the call set to be updated
.", | |
1467 "location": "path", | |
1468 "required": true, | |
1469 "type": "string" | |
1470 }, | |
1471 "updateMask": { | |
1472 "description": "An optional mask specifying which fi
elds to update. At this time, the only mutable field is name. The only acceptabl
e value is \"name\". If unspecified, all mutable fields will be updated.", | |
1473 "location": "query", | |
1474 "type": "string" | |
1475 } | |
1476 }, | |
1477 "path": "v1/callsets/{callSetId}", | |
1478 "request": { | |
1479 "$ref": "CallSet" | |
1480 }, | |
1481 "response": { | |
1482 "$ref": "CallSet" | |
1483 }, | |
1484 "scopes": [ | |
1485 "https://www.googleapis.com/auth/cloud-platform", | |
1486 "https://www.googleapis.com/auth/genomics" | |
1487 ] | |
1488 }, | |
1489 "delete": { | |
1490 "description": "Deletes a call set. For the definitions of c
all sets and other genomics resources, see [Fundamentals of Google Genomics](htt
ps://cloud.google.com/genomics/fundamentals-of-google-genomics)", | |
1491 "httpMethod": "DELETE", | |
1492 "id": "genomics.callsets.delete", | |
1493 "parameterOrder": [ | |
1494 "callSetId" | |
1495 ], | |
1496 "parameters": { | |
1497 "callSetId": { | |
1498 "description": "The ID of the call set to be deleted
.", | |
1499 "location": "path", | |
1500 "required": true, | |
1501 "type": "string" | |
1502 } | |
1503 }, | |
1504 "path": "v1/callsets/{callSetId}", | |
1505 "response": { | |
1506 "$ref": "Empty" | |
1507 }, | |
1508 "scopes": [ | |
1509 "https://www.googleapis.com/auth/cloud-platform", | |
1510 "https://www.googleapis.com/auth/genomics" | |
1511 ] | |
1512 }, | |
1513 "get": { | |
1514 "description": "Gets a call set by ID. For the definitions o
f call sets and other genomics resources, see [Fundamentals of Google Genomics](
https://cloud.google.com/genomics/fundamentals-of-google-genomics)", | |
1515 "httpMethod": "GET", | |
1516 "id": "genomics.callsets.get", | |
1517 "parameterOrder": [ | |
1518 "callSetId" | |
1519 ], | |
1520 "parameters": { | |
1521 "callSetId": { | |
1522 "description": "The ID of the call set.", | |
1523 "location": "path", | |
1524 "required": true, | |
1525 "type": "string" | |
1526 } | |
1527 }, | |
1528 "path": "v1/callsets/{callSetId}", | |
1529 "response": { | |
1530 "$ref": "CallSet" | |
1531 }, | |
1532 "scopes": [ | |
1533 "https://www.googleapis.com/auth/cloud-platform", | |
1534 "https://www.googleapis.com/auth/genomics", | |
1535 "https://www.googleapis.com/auth/genomics.readonly" | |
1536 ] | |
1537 } | |
1538 } | |
1539 } | 1561 } |
1540 }, | 1562 }, |
1541 "revision": "20160928", | 1563 "revision": "20170209", |
1542 "rootUrl": "https://genomics.googleapis.com/", | 1564 "rootUrl": "https://genomics.googleapis.com/", |
1543 "schemas": { | 1565 "schemas": { |
1544 "AnnotationSet": { | 1566 "Policy": { |
1545 "description": "An annotation set is a logical grouping of annotatio
ns that share consistent type information and provenance. Examples of annotation
sets include 'all genes from refseq', and 'all variant annotations from ClinVar
'.", | 1567 "description": "Defines an Identity and Access Management (IAM) poli
cy. It is used to\nspecify access control policies for Cloud Platform resources.
\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n
`members` to a `role`, where the members can be user accounts, Google groups,\nG
oogle domains, and service accounts. A `role` is a named list of permissions\nde
fined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n
\"role\": \"roles/owner\",\n \"members\": [\n \"user:mike
@example.com\",\n \"group:admins@example.com\",\n \"domain
:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccoun
t.com\",\n ]\n },\n {\n \"role\": \"roles/viewer
\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n
}\n\nFor a description of IAM and its features, see the\n[IAM developer's guide
](https://cloud.google.com/iam).", |
1546 "id": "AnnotationSet", | 1568 "id": "Policy", |
1547 "properties": { | 1569 "properties": { |
1548 "id": { | 1570 "etag": { |
1549 "description": "The server-generated annotation set ID, uniq
ue across all annotation sets.", | 1571 "description": "`etag` is used for optimistic concurrency co
ntrol as a way to help\nprevent simultaneous updates of a policy from overwritin
g each other.\nIt is strongly suggested that systems make use of the `etag` in t
he\nread-modify-write cycle to perform policy updates in order to avoid race\nco
nditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems
are expected to put that etag in the request to `setIamPolicy` to\nensure that t
heir change will be applied to the same version of the policy.\n\nIf no `etag` i
s provided in the call to `setIamPolicy`, then the existing\npolicy is overwritt
en blindly.", |
| 1572 "format": "byte", |
1550 "type": "string" | 1573 "type": "string" |
1551 }, | 1574 }, |
1552 "datasetId": { | 1575 "version": { |
1553 "description": "The dataset to which this annotation set bel
ongs.", | 1576 "description": "Version of the `Policy`. The default version
is 0.", |
1554 "type": "string" | 1577 "format": "int32", |
| 1578 "type": "integer" |
1555 }, | 1579 }, |
1556 "referenceSetId": { | 1580 "bindings": { |
1557 "description": "The ID of the reference set that defines the
coordinate space for this set's annotations.", | 1581 "description": "Associates a list of `members` to a `role`.\
nMultiple `bindings` must not be specified for the same `role`.\n`bindings` with
no members will result in an error.", |
1558 "type": "string" | 1582 "items": { |
1559 }, | 1583 "$ref": "Binding" |
1560 "name": { | |
1561 "description": "The display name for this annotation set.", | |
1562 "type": "string" | |
1563 }, | |
1564 "sourceUri": { | |
1565 "description": "The source URI describing the file from whic
h this annotation set was generated, if any.", | |
1566 "type": "string" | |
1567 }, | |
1568 "type": { | |
1569 "description": "The type of annotations contained within thi
s set.", | |
1570 "enum": [ | |
1571 "ANNOTATION_TYPE_UNSPECIFIED", | |
1572 "GENERIC", | |
1573 "VARIANT", | |
1574 "GENE", | |
1575 "TRANSCRIPT" | |
1576 ], | |
1577 "type": "string" | |
1578 }, | |
1579 "info": { | |
1580 "additionalProperties": { | |
1581 "items": { | |
1582 "type": "any" | |
1583 }, | |
1584 "type": "array" | |
1585 }, | 1584 }, |
1586 "description": "A map of additional read alignment informati
on. This must be of the form map (string key mapping to a list of string values)
.", | 1585 "type": "array" |
1587 "type": "object" | |
1588 } | 1586 } |
1589 }, | 1587 }, |
1590 "type": "object" | 1588 "type": "object" |
1591 }, | 1589 }, |
1592 "Empty": { | 1590 "CancelOperationRequest": { |
1593 "description": "A generic empty message that you can re-use to avoid
defining duplicated empty messages in your APIs. A typical example is to use it
as the request or the response type of an API method. For instance: service Foo
{ rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON re
presentation for `Empty` is empty JSON object `{}`.", | 1591 "description": "The request message for Operations.CancelOperation."
, |
1594 "id": "Empty", | 1592 "id": "CancelOperationRequest", |
| 1593 "properties": {}, |
1595 "type": "object" | 1594 "type": "object" |
1596 }, | 1595 }, |
1597 "SearchAnnotationSetsRequest": { | 1596 "SearchReadsRequest": { |
1598 "id": "SearchAnnotationSetsRequest", | 1597 "description": "The read search request.", |
| 1598 "id": "SearchReadsRequest", |
1599 "properties": { | 1599 "properties": { |
1600 "datasetIds": { | 1600 "readGroupIds": { |
1601 "description": "Required. The dataset IDs to search within.
Caller must have `READ` access to these datasets.", | 1601 "description": "The IDs of the read groups within which to s
earch for reads. All specified\nread groups must belong to the same read group s
ets. Must specify one of\n`readGroupSetIds` or `readGroupIds`.", |
1602 "items": { | 1602 "items": { |
1603 "type": "string" | 1603 "type": "string" |
1604 }, | 1604 }, |
1605 "type": "array" | 1605 "type": "array" |
1606 }, | 1606 }, |
1607 "referenceSetId": { | 1607 "end": { |
1608 "description": "If specified, only annotation sets associate
d with the given reference set are returned.", | 1608 "description": "The end position of the range on the referen
ce, 0-based exclusive. If\nspecified, `referenceName` must also be specified.", |
| 1609 "format": "int64", |
1609 "type": "string" | 1610 "type": "string" |
1610 }, | 1611 }, |
1611 "name": { | 1612 "pageToken": { |
1612 "description": "Only return annotations sets for which a sub
string of the name matches this string (case insensitive).", | 1613 "description": "The continuation token, which is used to pag
e through large result sets.\nTo get the next page of results, set this paramete
r to the value of\n`nextPageToken` from the previous response.", |
1613 "type": "string" | 1614 "type": "string" |
1614 }, | 1615 }, |
1615 "types": { | 1616 "pageSize": { |
1616 "description": "If specified, only annotation sets that have
any of these types are returned.", | 1617 "description": "The maximum number of results to return in a
single page. If unspecified,\ndefaults to 256. The maximum value is 2048.", |
1617 "enumDescriptions": [ | 1618 "format": "int32", |
1618 "", | 1619 "type": "integer" |
1619 "A `GENERIC` annotation type should be used when no othe
r annotation type will suffice. This represents an untyped annotation of the ref
erence genome.", | 1620 }, |
1620 "A `VARIANT` annotation type.", | 1621 "start": { |
1621 "A `GENE` annotation type represents the existence of a
gene at the associated reference coordinates. The start coordinate is typically
the gene's transcription start site and the end is typically the end of the gene
's last exon.", | 1622 "description": "The start position of the range on the refer
ence, 0-based inclusive. If\nspecified, `referenceName` must also be specified."
, |
1622 "A `TRANSCRIPT` annotation type represents the assertion
that a particular region of the reference genome may be transcribed as RNA." | 1623 "format": "int64", |
1623 ], | 1624 "type": "string" |
| 1625 }, |
| 1626 "referenceName": { |
| 1627 "description": "The reference sequence name, for example `ch
r1`, `1`, or `chrX`. If set to\n`*`, only unmapped reads are returned. If unspec
ified, all reads (mapped\nand unmapped) are returned.", |
| 1628 "type": "string" |
| 1629 }, |
| 1630 "readGroupSetIds": { |
| 1631 "description": "The IDs of the read groups sets within which
to search for reads. All\nspecified read group sets must be aligned against a c
ommon set of reference\nsequences; this defines the genomic coordinates for the
query. Must specify\none of `readGroupSetIds` or `readGroupIds`.", |
1624 "items": { | 1632 "items": { |
1625 "enum": [ | |
1626 "ANNOTATION_TYPE_UNSPECIFIED", | |
1627 "GENERIC", | |
1628 "VARIANT", | |
1629 "GENE", | |
1630 "TRANSCRIPT" | |
1631 ], | |
1632 "type": "string" | 1633 "type": "string" |
1633 }, | 1634 }, |
1634 "type": "array" | 1635 "type": "array" |
1635 }, | |
1636 "pageToken": { | |
1637 "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.", | |
1638 "type": "string" | |
1639 }, | |
1640 "pageSize": { | |
1641 "description": "The maximum number of results to return in a
single page. If unspecified, defaults to 128. The maximum value is 1024.", | |
1642 "format": "int32", | |
1643 "type": "integer" | |
1644 } | |
1645 }, | |
1646 "type": "object" | |
1647 }, | |
1648 "SearchAnnotationSetsResponse": { | |
1649 "id": "SearchAnnotationSetsResponse", | |
1650 "properties": { | |
1651 "annotationSets": { | |
1652 "description": "The matching annotation sets.", | |
1653 "items": { | |
1654 "$ref": "AnnotationSet" | |
1655 }, | |
1656 "type": "array" | |
1657 }, | |
1658 "nextPageToken": { | |
1659 "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.", | |
1660 "type": "string" | |
1661 } | 1636 } |
1662 }, | 1637 }, |
1663 "type": "object" | 1638 "type": "object" |
1664 }, | 1639 }, |
1665 "Annotation": { | 1640 "Annotation": { |
1666 "description": "An annotation describes a region of reference genome
. The value of an annotation may be one of several canonical types, supplemented
by arbitrary info tags. An annotation is not inherently associated with a speci
fic sample or individual (though a client could choose to use annotations in thi
s way). Example canonical annotation types are `GENE` and `VARIANT`.", | 1641 "description": "An annotation describes a region of reference genome
. The value of an\nannotation may be one of several canonical types, supplemente
d by arbitrary\ninfo tags. An annotation is not inherently associated with a spe
cific\nsample or individual (though a client could choose to use annotations in\
nthis way). Example canonical annotation types are `GENE` and\n`VARIANT`.", |
1667 "id": "Annotation", | 1642 "id": "Annotation", |
1668 "properties": { | 1643 "properties": { |
1669 "id": { | 1644 "variant": { |
1670 "description": "The server-generated annotation ID, unique a
cross all annotations.", | 1645 "$ref": "VariantAnnotation", |
1671 "type": "string" | 1646 "description": "A variant annotation, which describes the ef
fect of a variant on the\ngenome, the coding sequence, and/or higher level conse
quences at the\norganism level e.g. pathogenicity. This field is only set for an
notations\nof type `VARIANT`." |
1672 }, | |
1673 "annotationSetId": { | |
1674 "description": "The annotation set to which this annotation
belongs.", | |
1675 "type": "string" | |
1676 }, | |
1677 "name": { | |
1678 "description": "The display name of this annotation.", | |
1679 "type": "string" | |
1680 }, | 1647 }, |
1681 "referenceId": { | 1648 "referenceId": { |
1682 "description": "The ID of the Google Genomics reference asso
ciated with this range.", | 1649 "description": "The ID of the Google Genomics reference asso
ciated with this range.", |
1683 "type": "string" | 1650 "type": "string" |
1684 }, | 1651 }, |
1685 "referenceName": { | 1652 "id": { |
1686 "description": "The display name corresponding to the refere
nce specified by `referenceId`, for example `chr1`, `1`, or `chrX`.", | 1653 "description": "The server-generated annotation ID, unique a
cross all annotations.", |
1687 "type": "string" | |
1688 }, | |
1689 "start": { | |
1690 "description": "The start position of the range on the refer
ence, 0-based inclusive.", | |
1691 "format": "int64", | |
1692 "type": "string" | |
1693 }, | |
1694 "end": { | |
1695 "description": "The end position of the range on the referen
ce, 0-based exclusive.", | |
1696 "format": "int64", | |
1697 "type": "string" | 1654 "type": "string" |
1698 }, | 1655 }, |
1699 "reverseStrand": { | 1656 "reverseStrand": { |
1700 "description": "Whether this range refers to the reverse str
and, as opposed to the forward strand. Note that regardless of this field, the s
tart/end position of the range always refer to the forward strand.", | 1657 "description": "Whether this range refers to the reverse str
and, as opposed to the forward\nstrand. Note that regardless of this field, the
start/end position of the\nrange always refer to the forward strand.", |
1701 "type": "boolean" | 1658 "type": "boolean" |
1702 }, | 1659 }, |
| 1660 "referenceName": { |
| 1661 "description": "The display name corresponding to the refere
nce specified by\n`referenceId`, for example `chr1`, `1`, or `chrX`.", |
| 1662 "type": "string" |
| 1663 }, |
1703 "type": { | 1664 "type": { |
1704 "description": "The data type for this annotation. Must matc
h the containing annotation set's type.", | 1665 "description": "The data type for this annotation. Must matc
h the containing annotation\nset's type.", |
1705 "enum": [ | 1666 "enum": [ |
1706 "ANNOTATION_TYPE_UNSPECIFIED", | 1667 "ANNOTATION_TYPE_UNSPECIFIED", |
1707 "GENERIC", | 1668 "GENERIC", |
1708 "VARIANT", | 1669 "VARIANT", |
1709 "GENE", | 1670 "GENE", |
1710 "TRANSCRIPT" | 1671 "TRANSCRIPT" |
1711 ], | 1672 ], |
| 1673 "enumDescriptions": [ |
| 1674 "", |
| 1675 "A `GENERIC` annotation type should be used when no othe
r annotation\ntype will suffice. This represents an untyped annotation of the re
ference\ngenome.", |
| 1676 "A `VARIANT` annotation type.", |
| 1677 "A `GENE` annotation type represents the existence of a
gene at the\nassociated reference coordinates. The start coordinate is typically
the\ngene's transcription start site and the end is typically the end of the\ng
ene's last exon.", |
| 1678 "A `TRANSCRIPT` annotation type represents the assertion
that a\nparticular region of the reference genome may be transcribed as RNA." |
| 1679 ], |
1712 "type": "string" | 1680 "type": "string" |
1713 }, | 1681 }, |
1714 "variant": { | |
1715 "$ref": "VariantAnnotation", | |
1716 "description": "A variant annotation, which describes the ef
fect of a variant on the genome, the coding sequence, and/or higher level conseq
uences at the organism level e.g. pathogenicity. This field is only set for anno
tations of type `VARIANT`." | |
1717 }, | |
1718 "transcript": { | |
1719 "$ref": "Transcript", | |
1720 "description": "A transcript value represents the assertion
that a particular region of the reference genome may be transcribed as RNA. An a
lternative splicing pattern would be represented as a separate transcript object
. This field is only set for annotations of type `TRANSCRIPT`." | |
1721 }, | |
1722 "info": { | 1682 "info": { |
1723 "additionalProperties": { | 1683 "additionalProperties": { |
1724 "items": { | 1684 "items": { |
1725 "type": "any" | 1685 "type": "any" |
1726 }, | 1686 }, |
1727 "type": "array" | 1687 "type": "array" |
1728 }, | 1688 }, |
1729 "description": "A map of additional read alignment informati
on. This must be of the form map (string key mapping to a list of string values)
.", | 1689 "description": "A map of additional read alignment informati
on. This must be of the form\nmap<string, string[]> (string key mapping to a lis
t of string values).", |
| 1690 "type": "object" |
| 1691 }, |
| 1692 "end": { |
| 1693 "description": "The end position of the range on the referen
ce, 0-based exclusive.", |
| 1694 "format": "int64", |
| 1695 "type": "string" |
| 1696 }, |
| 1697 "transcript": { |
| 1698 "$ref": "Transcript", |
| 1699 "description": "A transcript value represents the assertion
that a particular region of\nthe reference genome may be transcribed as RNA. An
alternative splicing\npattern would be represented as a separate transcript obje
ct. This field\nis only set for annotations of type `TRANSCRIPT`." |
| 1700 }, |
| 1701 "start": { |
| 1702 "description": "The start position of the range on the refer
ence, 0-based inclusive.", |
| 1703 "format": "int64", |
| 1704 "type": "string" |
| 1705 }, |
| 1706 "annotationSetId": { |
| 1707 "description": "The annotation set to which this annotation
belongs.", |
| 1708 "type": "string" |
| 1709 }, |
| 1710 "name": { |
| 1711 "description": "The display name of this annotation.", |
| 1712 "type": "string" |
| 1713 } |
| 1714 }, |
| 1715 "type": "object" |
| 1716 }, |
| 1717 "Operation": { |
| 1718 "description": "This resource represents a long-running operation th
at is the result of a\nnetwork API call.", |
| 1719 "id": "Operation", |
| 1720 "properties": { |
| 1721 "done": { |
| 1722 "description": "If the value is `false`, it means the operat
ion is still in progress.\nIf true, the operation is completed, and either `erro
r` or `response` is\navailable.", |
| 1723 "type": "boolean" |
| 1724 }, |
| 1725 "response": { |
| 1726 "additionalProperties": { |
| 1727 "description": "Properties of the object. Contains field
@type with type URL.", |
| 1728 "type": "any" |
| 1729 }, |
| 1730 "description": "If importing ReadGroupSets, an ImportReadGro
upSetsResponse is returned. If importing Variants, an ImportVariantsResponse is
returned. For pipelines and exports, an empty response is returned.", |
| 1731 "type": "object" |
| 1732 }, |
| 1733 "name": { |
| 1734 "description": "The server-assigned name, which is only uniq
ue within the same service that originally returns it. For example: `operati
ons/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`", |
| 1735 "type": "string" |
| 1736 }, |
| 1737 "error": { |
| 1738 "$ref": "Status", |
| 1739 "description": "The error result of the operation in case of
failure or cancellation." |
| 1740 }, |
| 1741 "metadata": { |
| 1742 "additionalProperties": { |
| 1743 "description": "Properties of the object. Contains field
@type with type URL.", |
| 1744 "type": "any" |
| 1745 }, |
| 1746 "description": "An OperationMetadata object. This will alway
s be returned with the Operation.", |
1730 "type": "object" | 1747 "type": "object" |
1731 } | 1748 } |
1732 }, | 1749 }, |
1733 "type": "object" | 1750 "type": "object" |
1734 }, | 1751 }, |
1735 "VariantAnnotation": { | 1752 "RuntimeMetadata": { |
1736 "id": "VariantAnnotation", | 1753 "description": "Runtime metadata that will be populated in the\nrunt
imeMetadata\nfield of the Operation associated with a RunPipeline execution.", |
| 1754 "id": "RuntimeMetadata", |
1737 "properties": { | 1755 "properties": { |
1738 "type": { | 1756 "computeEngine": { |
1739 "description": "Type has been adapted from ClinVar's list of
variant types.", | 1757 "$ref": "ComputeEngine", |
1740 "enum": [ | 1758 "description": "Execution information specific to Google Com
pute Engine." |
1741 "TYPE_UNSPECIFIED", | |
1742 "TYPE_OTHER", | |
1743 "INSERTION", | |
1744 "DELETION", | |
1745 "SUBSTITUTION", | |
1746 "SNP", | |
1747 "STRUCTURAL", | |
1748 "CNV" | |
1749 ], | |
1750 "type": "string" | |
1751 }, | |
1752 "effect": { | |
1753 "description": "Effect of the variant on the coding sequence
.", | |
1754 "enum": [ | |
1755 "EFFECT_UNSPECIFIED", | |
1756 "EFFECT_OTHER", | |
1757 "FRAMESHIFT", | |
1758 "FRAME_PRESERVING_INDEL", | |
1759 "SYNONYMOUS_SNP", | |
1760 "NONSYNONYMOUS_SNP", | |
1761 "STOP_GAIN", | |
1762 "STOP_LOSS", | |
1763 "SPLICE_SITE_DISRUPTION" | |
1764 ], | |
1765 "type": "string" | |
1766 }, | |
1767 "alternateBases": { | |
1768 "description": "The alternate allele for this variant. If mu
ltiple alternate alleles exist at this location, create a separate variant for e
ach one, as they may represent distinct conditions.", | |
1769 "type": "string" | |
1770 }, | |
1771 "geneId": { | |
1772 "description": "Google annotation ID of the gene affected by
this variant. This should be provided when the variant is created.", | |
1773 "type": "string" | |
1774 }, | |
1775 "transcriptIds": { | |
1776 "description": "Google annotation IDs of the transcripts aff
ected by this variant. These should be provided when the variant is created.", | |
1777 "items": { | |
1778 "type": "string" | |
1779 }, | |
1780 "type": "array" | |
1781 }, | |
1782 "conditions": { | |
1783 "description": "The set of conditions associated with this v
ariant. A condition describes the way a variant influences human health.", | |
1784 "items": { | |
1785 "$ref": "ClinicalCondition" | |
1786 }, | |
1787 "type": "array" | |
1788 }, | |
1789 "clinicalSignificance": { | |
1790 "description": "Describes the clinical significance of a var
iant. It is adapted from the ClinVar controlled vocabulary for clinical signific
ance described at: http://www.ncbi.nlm.nih.gov/clinvar/docs/clinsig/", | |
1791 "enum": [ | |
1792 "CLINICAL_SIGNIFICANCE_UNSPECIFIED", | |
1793 "CLINICAL_SIGNIFICANCE_OTHER", | |
1794 "UNCERTAIN", | |
1795 "BENIGN", | |
1796 "LIKELY_BENIGN", | |
1797 "LIKELY_PATHOGENIC", | |
1798 "PATHOGENIC", | |
1799 "DRUG_RESPONSE", | |
1800 "HISTOCOMPATIBILITY", | |
1801 "CONFERS_SENSITIVITY", | |
1802 "RISK_FACTOR", | |
1803 "ASSOCIATION", | |
1804 "PROTECTIVE", | |
1805 "MULTIPLE_REPORTED" | |
1806 ], | |
1807 "type": "string" | |
1808 } | 1759 } |
1809 }, | 1760 }, |
1810 "type": "object" | 1761 "type": "object" |
1811 }, | 1762 }, |
1812 "ClinicalCondition": { | 1763 "ImportReadGroupSetsResponse": { |
1813 "id": "ClinicalCondition", | 1764 "description": "The read group set import response.", |
| 1765 "id": "ImportReadGroupSetsResponse", |
1814 "properties": { | 1766 "properties": { |
1815 "names": { | 1767 "readGroupSetIds": { |
1816 "description": "A set of names for the condition.", | 1768 "description": "IDs of the read group sets that were created
.", |
1817 "items": { | 1769 "items": { |
1818 "type": "string" | 1770 "type": "string" |
1819 }, | 1771 }, |
1820 "type": "array" | 1772 "type": "array" |
1821 }, | |
1822 "externalIds": { | |
1823 "description": "The set of external IDs for this condition."
, | |
1824 "items": { | |
1825 "$ref": "ExternalId" | |
1826 }, | |
1827 "type": "array" | |
1828 }, | |
1829 "conceptId": { | |
1830 "description": "The MedGen concept id associated with this g
ene. Search for these IDs at http://www.ncbi.nlm.nih.gov/medgen/", | |
1831 "type": "string" | |
1832 }, | |
1833 "omimId": { | |
1834 "description": "The OMIM id for this condition. Search for t
hese IDs at http://omim.org/", | |
1835 "type": "string" | |
1836 } | |
1837 }, | |
1838 "type": "object" | |
1839 }, | |
1840 "ExternalId": { | |
1841 "id": "ExternalId", | |
1842 "properties": { | |
1843 "sourceName": { | |
1844 "description": "The name of the source of this data.", | |
1845 "type": "string" | |
1846 }, | |
1847 "id": { | |
1848 "description": "The id used by the source of this data.", | |
1849 "type": "string" | |
1850 } | |
1851 }, | |
1852 "type": "object" | |
1853 }, | |
1854 "Transcript": { | |
1855 "description": "A transcript represents the assertion that a particu
lar region of the reference genome may be transcribed as RNA.", | |
1856 "id": "Transcript", | |
1857 "properties": { | |
1858 "geneId": { | |
1859 "description": "The annotation ID of the gene from which thi
s transcript is transcribed.", | |
1860 "type": "string" | |
1861 }, | |
1862 "exons": { | |
1863 "description": "The exons that compose this transcript. This
field should be unset for genomes where transcript splicing does not occur, for
example prokaryotes. Introns are regions of the transcript that are not include
d in the spliced RNA product. Though not explicitly modeled here, intron ranges
can be deduced; all regions of this transcript that are not exons are introns. E
xonic sequences do not necessarily code for a translational product (amino acids
). Only the regions of exons bounded by the codingSequence correspond to coding
DNA sequence. Exons are ordered by start position and may not overlap.", | |
1864 "items": { | |
1865 "$ref": "Exon" | |
1866 }, | |
1867 "type": "array" | |
1868 }, | |
1869 "codingSequence": { | |
1870 "$ref": "CodingSequence", | |
1871 "description": "The range of the coding sequence for this tr
anscript, if any. To determine the exact ranges of coding sequence, intersect th
is range with those of the exons, if any. If there are any exons, the codingSequ
ence must start and end within them. Note that in some cases, the reference geno
me will not exactly match the observed mRNA transcript e.g. due to variance in t
he source genome from reference. In these cases, exon.frame will not necessarily
match the expected reference reading frame and coding exon reference bases cann
ot necessarily be concatenated to produce the original transcript mRNA." | |
1872 } | |
1873 }, | |
1874 "type": "object" | |
1875 }, | |
1876 "Exon": { | |
1877 "id": "Exon", | |
1878 "properties": { | |
1879 "start": { | |
1880 "description": "The start position of the exon on this annot
ation's reference sequence, 0-based inclusive. Note that this is relative to the
reference start, and **not** the containing annotation start.", | |
1881 "format": "int64", | |
1882 "type": "string" | |
1883 }, | |
1884 "end": { | |
1885 "description": "The end position of the exon on this annotat
ion's reference sequence, 0-based exclusive. Note that this is relative to the r
eference start, and *not* the containing annotation start.", | |
1886 "format": "int64", | |
1887 "type": "string" | |
1888 }, | |
1889 "frame": { | |
1890 "description": "The frame of this exon. Contains a value of
0, 1, or 2, which indicates the offset of the first coding base of the exon with
in the reading frame of the coding DNA sequence, if any. This field is dependent
on the strandedness of this annotation (see Annotation.reverse_strand). For for
ward stranded annotations, this offset is relative to the exon.start. For revers
e strand annotations, this offset is relative to the exon.end `- 1`. Unset if th
is exon does not intersect the coding sequence. Upon creation of a transcript, t
he frame must be populated for all or none of the coding exons.", | |
1891 "format": "int32", | |
1892 "type": "integer" | |
1893 } | |
1894 }, | |
1895 "type": "object" | |
1896 }, | |
1897 "CodingSequence": { | |
1898 "id": "CodingSequence", | |
1899 "properties": { | |
1900 "start": { | |
1901 "description": "The start of the coding sequence on this ann
otation's reference sequence, 0-based inclusive. Note that this position is rela
tive to the reference start, and *not* the containing annotation start.", | |
1902 "format": "int64", | |
1903 "type": "string" | |
1904 }, | |
1905 "end": { | |
1906 "description": "The end of the coding sequence on this annot
ation's reference sequence, 0-based exclusive. Note that this position is relati
ve to the reference start, and *not* the containing annotation start.", | |
1907 "format": "int64", | |
1908 "type": "string" | |
1909 } | |
1910 }, | |
1911 "type": "object" | |
1912 }, | |
1913 "BatchCreateAnnotationsRequest": { | |
1914 "id": "BatchCreateAnnotationsRequest", | |
1915 "properties": { | |
1916 "annotations": { | |
1917 "description": "The annotations to be created. At most 4096
can be specified in a single request.", | |
1918 "items": { | |
1919 "$ref": "Annotation" | |
1920 }, | |
1921 "type": "array" | |
1922 }, | |
1923 "requestId": { | |
1924 "description": "A unique request ID which enables the server
to detect duplicated requests. If provided, duplicated requests will result in
the same response; if not provided, duplicated requests may result in duplicated
data. For a given annotation set, callers should not reuse `request_id`s when w
riting different batches of annotations - behavior in this case is undefined. A
common approach is to use a UUID. For batch jobs where worker crashes are a poss
ibility, consider using some unique variant of a worker or run ID.", | |
1925 "type": "string" | |
1926 } | |
1927 }, | |
1928 "type": "object" | |
1929 }, | |
1930 "BatchCreateAnnotationsResponse": { | |
1931 "id": "BatchCreateAnnotationsResponse", | |
1932 "properties": { | |
1933 "entries": { | |
1934 "description": "The resulting per-annotation entries, ordere
d consistently with the original request.", | |
1935 "items": { | |
1936 "$ref": "Entry" | |
1937 }, | |
1938 "type": "array" | |
1939 } | 1773 } |
1940 }, | 1774 }, |
1941 "type": "object" | 1775 "type": "object" |
1942 }, | 1776 }, |
1943 "Entry": { | 1777 "VariantCall": { |
1944 "id": "Entry", | 1778 "description": "A call represents the determination of genotype with
respect to a particular\nvariant. It may include associated information such as
quality and phasing.\nFor example, a call might assign a probability of 0.32 to
the occurrence of\na SNP named rs1234 in a call set with the name NA12345.", |
| 1779 "id": "VariantCall", |
1945 "properties": { | 1780 "properties": { |
1946 "status": { | 1781 "phaseset": { |
1947 "$ref": "Status", | 1782 "description": "If this field is present, this variant call'
s genotype ordering implies\nthe phase of the bases and is consistent with any o
ther variant calls in\nthe same reference sequence which have the same phaseset
value.\nWhen importing data from VCF, if the genotype data was phased but no\nph
ase set was specified this field will be set to `*`.", |
1948 "description": "The creation status." | 1783 "type": "string" |
1949 }, | 1784 }, |
1950 "annotation": { | 1785 "info": { |
1951 "$ref": "Annotation", | 1786 "additionalProperties": { |
1952 "description": "The created annotation, if creation was succ
essful." | 1787 "items": { |
| 1788 "type": "any" |
| 1789 }, |
| 1790 "type": "array" |
| 1791 }, |
| 1792 "description": "A map of additional variant call information
. This must be of the form\nmap<string, string[]> (string key mapping to a list
of string values).", |
| 1793 "type": "object" |
| 1794 }, |
| 1795 "callSetName": { |
| 1796 "description": "The name of the call set this variant call b
elongs to.", |
| 1797 "type": "string" |
| 1798 }, |
| 1799 "genotypeLikelihood": { |
| 1800 "description": "The genotype likelihoods for this variant ca
ll. Each array entry\nrepresents how likely a specific genotype is for this call
. The value\nordering is defined by the GL tag in the VCF spec.\nIf Phred-scaled
genotype likelihood scores (PL) are available and\nlog10(P) genotype likelihood
scores (GL) are not, PL scores are converted\nto GL scores. If both are availa
ble, PL scores are stored in `info`.", |
| 1801 "items": { |
| 1802 "format": "double", |
| 1803 "type": "number" |
| 1804 }, |
| 1805 "type": "array" |
| 1806 }, |
| 1807 "callSetId": { |
| 1808 "description": "The ID of the call set this variant call bel
ongs to.", |
| 1809 "type": "string" |
| 1810 }, |
| 1811 "genotype": { |
| 1812 "description": "The genotype of this variant call. Each valu
e represents either the value\nof the `referenceBases` field or a 1-based index
into\n`alternateBases`. If a variant had a `referenceBases`\nvalue of `T` and an
`alternateBases`\nvalue of `[\"A\", \"C\"]`, and the `genotype` was\n`[2, 1]`,
that would mean the call\nrepresented the heterozygous value `CA` for this varia
nt.\nIf the `genotype` was instead `[0, 1]`, the\nrepresented value would be `TA
`. Ordering of the\ngenotype values is important if the `phaseset` is present.\n
If a genotype is not called (that is, a `.` is present in the\nGT string) -1 is
returned.", |
| 1813 "items": { |
| 1814 "format": "int32", |
| 1815 "type": "integer" |
| 1816 }, |
| 1817 "type": "array" |
| 1818 } |
| 1819 }, |
| 1820 "type": "object" |
| 1821 }, |
| 1822 "SearchVariantsResponse": { |
| 1823 "description": "The variant search response.", |
| 1824 "id": "SearchVariantsResponse", |
| 1825 "properties": { |
| 1826 "nextPageToken": { |
| 1827 "description": "The continuation token, which is used to pag
e through large result sets.\nProvide this value in a subsequent request to retu
rn the next page of\nresults. This field will be empty if there aren't any addit
ional results.", |
| 1828 "type": "string" |
| 1829 }, |
| 1830 "variants": { |
| 1831 "description": "The list of matching Variants.", |
| 1832 "items": { |
| 1833 "$ref": "Variant" |
| 1834 }, |
| 1835 "type": "array" |
| 1836 } |
| 1837 }, |
| 1838 "type": "object" |
| 1839 }, |
| 1840 "ListBasesResponse": { |
| 1841 "id": "ListBasesResponse", |
| 1842 "properties": { |
| 1843 "sequence": { |
| 1844 "description": "A substring of the bases that make up this r
eference.", |
| 1845 "type": "string" |
| 1846 }, |
| 1847 "offset": { |
| 1848 "description": "The offset position (0-based) of the given `
sequence` from the\nstart of this `Reference`. This value will differ for each p
age\nin a paginated request.", |
| 1849 "format": "int64", |
| 1850 "type": "string" |
| 1851 }, |
| 1852 "nextPageToken": { |
| 1853 "description": "The continuation token, which is used to pag
e through large result sets.\nProvide this value in a subsequent request to retu
rn the next page of\nresults. This field will be empty if there aren't any addit
ional results.", |
| 1854 "type": "string" |
1953 } | 1855 } |
1954 }, | 1856 }, |
1955 "type": "object" | 1857 "type": "object" |
1956 }, | 1858 }, |
1957 "Status": { | 1859 "Status": { |
1958 "description": "The `Status` type defines a logical error model that
is suitable for different programming environments, including REST APIs and RPC
APIs. It is used by [gRPC](https://github.com/grpc). The error model is designe
d to be: - Simple to use and understand for most users - Flexible enough to meet
unexpected needs # Overview The `Status` message contains three pieces of data:
error code, error message, and error details. The error code should be an enum
value of google.rpc.Code, but it may accept additional error codes if needed. Th
e error message should be a developer-facing English message that helps develope
rs *understand* and *resolve* the error. If a localized user-facing error messag
e is needed, put the localized message in the error details or localize it in th
e client. The optional error details may contain arbitrary information about the
error. There is a predefined set of error detail types in the package `google.r
pc` which can be used for common error conditions. # Language mapping The `Statu
s` message is the logical representation of the error model, but it is not neces
sarily the actual wire format. When the `Status` message is exposed in different
client libraries and different wire protocols, it can be mapped differently. Fo
r example, it will likely be mapped to some exceptions in Java, but more likely
mapped to some error codes in C. # Other uses The error model and the `Status` m
essage can be used in a variety of environments, either with or without APIs, to
provide a consistent developer experience across different environments. Exampl
e uses of this error model include: - Partial errors. If a service needs to retu
rn partial errors to the client, it may embed the `Status` in the normal respons
e to indicate the partial errors. - Workflow errors. A typical workflow has mult
iple steps. Each step may have a `Status` message for error reporting purpose. -
Batch operations. If a client uses batch request and batch response, the `Statu
s` message should be used directly inside batch response, one for each error sub
-response. - Asynchronous operations. If an API call embeds asynchronous operati
on results in its response, the status of those operations should be represented
directly using the `Status` message. - Logging. If some API errors are stored i
n logs, the message `Status` could be used directly after any stripping needed f
or security/privacy reasons.", | 1860 "description": "The `Status` type defines a logical error model that
is suitable for different\nprogramming environments, including REST APIs and RP
C APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is desig
ned to be:\n\n- Simple to use and understand for most users\n- Flexible enough t
o meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pie
ces of data: error code, error message,\nand error details. The error code shoul
d be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes
if needed. The\nerror message should be a developer-facing English message tha
t helps\ndevelopers *understand* and *resolve* the error. If a localized user-fa
cing\nerror message is needed, put the localized message in the error details or
\nlocalize it in the client. The optional error details may contain arbitrary\ni
nformation about the error. There is a predefined set of error detail types\nin
the package `google.rpc` which can be used for common error conditions.\n\n# Lan
guage mapping\n\nThe `Status` message is the logical representation of the error
model, but it\nis not necessarily the actual wire format. When the `Status` mes
sage is\nexposed in different client libraries and different wire protocols, it
can be\nmapped differently. For example, it will likely be mapped to some except
ions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\
n\nThe error model and the `Status` message can be used in a variety of\nenviron
ments, either with or without APIs, to provide a\nconsistent developer experienc
e across different environments.\n\nExample uses of this error model include:\n\
n- Partial errors. If a service needs to return partial errors to the client,\n
it may embed the `Status` in the normal response to indicate the partial\n
errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step
may\n have a `Status` message for error reporting purpose.\n\n- Batch operati
ons. If a client uses batch request and batch response, the\n `Status` messag
e should be used directly inside batch response, one for\n each error sub-res
ponse.\n\n- Asynchronous operations. If an API call embeds asynchronous operatio
n\n results in its response, the status of those operations should be\n re
presented directly using the `Status` message.\n\n- Logging. If some API errors
are stored in logs, the message `Status` could\n be used directly after any s
tripping needed for security/privacy reasons.", |
1959 "id": "Status", | 1861 "id": "Status", |
1960 "properties": { | 1862 "properties": { |
1961 "code": { | 1863 "code": { |
1962 "description": "The status code, which should be an enum val
ue of google.rpc.Code.", | 1864 "description": "The status code, which should be an enum val
ue of google.rpc.Code.", |
1963 "format": "int32", | 1865 "format": "int32", |
1964 "type": "integer" | 1866 "type": "integer" |
1965 }, | 1867 }, |
1966 "message": { | 1868 "message": { |
1967 "description": "A developer-facing error message, which shou
ld be in English. Any user-facing error message should be localized and sent in
the google.rpc.Status.details field, or localized by the client.", | 1869 "description": "A developer-facing error message, which shou
ld be in English. Any\nuser-facing error message should be localized and sent in
the\ngoogle.rpc.Status.details field, or localized by the client.", |
1968 "type": "string" | 1870 "type": "string" |
1969 }, | 1871 }, |
1970 "details": { | 1872 "details": { |
1971 "description": "A list of messages that carry the error deta
ils. There will be a common set of message types for APIs to use.", | 1873 "description": "A list of messages that carry the error deta
ils. There will be a\ncommon set of message types for APIs to use.", |
1972 "items": { | 1874 "items": { |
1973 "additionalProperties": { | 1875 "additionalProperties": { |
1974 "description": "Properties of the object. Contains f
ield @type with type URL.", | 1876 "description": "Properties of the object. Contains f
ield @type with type URL.", |
1975 "type": "any" | 1877 "type": "any" |
1976 }, | 1878 }, |
1977 "type": "object" | 1879 "type": "object" |
1978 }, | 1880 }, |
1979 "type": "array" | 1881 "type": "array" |
1980 } | 1882 } |
1981 }, | 1883 }, |
1982 "type": "object" | 1884 "type": "object" |
1983 }, | 1885 }, |
1984 "SearchAnnotationsRequest": { | |
1985 "id": "SearchAnnotationsRequest", | |
1986 "properties": { | |
1987 "annotationSetIds": { | |
1988 "description": "Required. The annotation sets to search with
in. The caller must have `READ` access to these annotation sets. All queried ann
otation sets must have the same type.", | |
1989 "items": { | |
1990 "type": "string" | |
1991 }, | |
1992 "type": "array" | |
1993 }, | |
1994 "referenceId": { | |
1995 "description": "The ID of the reference to query.", | |
1996 "type": "string" | |
1997 }, | |
1998 "referenceName": { | |
1999 "description": "The name of the reference to query, within t
he reference set associated with this query.", | |
2000 "type": "string" | |
2001 }, | |
2002 "start": { | |
2003 "description": "The start position of the range on the refer
ence, 0-based inclusive. If specified, referenceId or referenceName must be spec
ified. Defaults to 0.", | |
2004 "format": "int64", | |
2005 "type": "string" | |
2006 }, | |
2007 "end": { | |
2008 "description": "The end position of the range on the referen
ce, 0-based exclusive. If referenceId or referenceName must be specified, Defaul
ts to the length of the reference.", | |
2009 "format": "int64", | |
2010 "type": "string" | |
2011 }, | |
2012 "pageToken": { | |
2013 "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.", | |
2014 "type": "string" | |
2015 }, | |
2016 "pageSize": { | |
2017 "description": "The maximum number of results to return in a
single page. If unspecified, defaults to 256. The maximum value is 2048.", | |
2018 "format": "int32", | |
2019 "type": "integer" | |
2020 } | |
2021 }, | |
2022 "type": "object" | |
2023 }, | |
2024 "SearchAnnotationsResponse": { | |
2025 "id": "SearchAnnotationsResponse", | |
2026 "properties": { | |
2027 "annotations": { | |
2028 "description": "The matching annotations.", | |
2029 "items": { | |
2030 "$ref": "Annotation" | |
2031 }, | |
2032 "type": "array" | |
2033 }, | |
2034 "nextPageToken": { | |
2035 "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.", | |
2036 "type": "string" | |
2037 } | |
2038 }, | |
2039 "type": "object" | |
2040 }, | |
2041 "ListDatasetsResponse": { | |
2042 "description": "The dataset list response.", | |
2043 "id": "ListDatasetsResponse", | |
2044 "properties": { | |
2045 "datasets": { | |
2046 "description": "The list of matching Datasets.", | |
2047 "items": { | |
2048 "$ref": "Dataset" | |
2049 }, | |
2050 "type": "array" | |
2051 }, | |
2052 "nextPageToken": { | |
2053 "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.", | |
2054 "type": "string" | |
2055 } | |
2056 }, | |
2057 "type": "object" | |
2058 }, | |
2059 "Dataset": { | |
2060 "description": "A Dataset is a collection of genomic data. For more
genomics resource definitions, see [Fundamentals of Google Genomics](https://clo
ud.google.com/genomics/fundamentals-of-google-genomics)", | |
2061 "id": "Dataset", | |
2062 "properties": { | |
2063 "id": { | |
2064 "description": "The server-generated dataset ID, unique acro
ss all datasets.", | |
2065 "type": "string" | |
2066 }, | |
2067 "projectId": { | |
2068 "description": "The Google Cloud project ID that this datase
t belongs to.", | |
2069 "type": "string" | |
2070 }, | |
2071 "name": { | |
2072 "description": "The dataset name.", | |
2073 "type": "string" | |
2074 }, | |
2075 "createTime": { | |
2076 "description": "The time this dataset was created, in second
s from the epoch.", | |
2077 "type": "string" | |
2078 } | |
2079 }, | |
2080 "type": "object" | |
2081 }, | |
2082 "UndeleteDatasetRequest": { | 1886 "UndeleteDatasetRequest": { |
2083 "id": "UndeleteDatasetRequest", | 1887 "id": "UndeleteDatasetRequest", |
2084 "type": "object" | 1888 "properties": {}, |
2085 }, | |
2086 "SetIamPolicyRequest": { | |
2087 "description": "Request message for `SetIamPolicy` method.", | |
2088 "id": "SetIamPolicyRequest", | |
2089 "properties": { | |
2090 "policy": { | |
2091 "$ref": "Policy", | |
2092 "description": "REQUIRED: The complete policy to be applied
to the `resource`. The size of the policy is limited to a few 10s of KB. An empt
y policy is a valid policy but certain Cloud Platform services (such as Projects
) might reject them." | |
2093 } | |
2094 }, | |
2095 "type": "object" | |
2096 }, | |
2097 "Policy": { | |
2098 "description": "Defines an Identity and Access Management (IAM) poli
cy. It is used to specify access control policies for Cloud Platform resources.
A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `member
s` to a `role`, where the members can be user accounts, Google groups, Google do
mains, and service accounts. A `role` is a named list of permissions defined by
IAM. **Example** { \"bindings\": [ { \"role\": \"roles/owner\", \"members\": [ \
"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \
"serviceAccount:my-other-app@appspot.gserviceaccount.com\", ] }, { \"role\": \"r
oles/viewer\", \"members\": [\"user:sean@example.com\"] } ] } For a description
of IAM and its features, see the [IAM developer's guide](https://cloud.google.co
m/iam).", | |
2099 "id": "Policy", | |
2100 "properties": { | |
2101 "version": { | |
2102 "description": "Version of the `Policy`. The default version
is 0.", | |
2103 "format": "int32", | |
2104 "type": "integer" | |
2105 }, | |
2106 "bindings": { | |
2107 "description": "Associates a list of `members` to a `role`.
Multiple `bindings` must not be specified for the same `role`. `bindings` with n
o members will result in an error.", | |
2108 "items": { | |
2109 "$ref": "Binding" | |
2110 }, | |
2111 "type": "array" | |
2112 }, | |
2113 "etag": { | |
2114 "description": "`etag` is used for optimistic concurrency co
ntrol as a way to help prevent simultaneous updates of a policy from overwriting
each other. It is strongly suggested that systems make use of the `etag` in the
read-modify-write cycle to perform policy updates in order to avoid race condit
ions: An `etag` is returned in the response to `getIamPolicy`, and systems are e
xpected to put that etag in the request to `setIamPolicy` to ensure that their c
hange will be applied to the same version of the policy. If no `etag` is provide
d in the call to `setIamPolicy`, then the existing policy is overwritten blindly
.", | |
2115 "format": "byte", | |
2116 "type": "string" | |
2117 } | |
2118 }, | |
2119 "type": "object" | 1889 "type": "object" |
2120 }, | 1890 }, |
2121 "Binding": { | 1891 "Binding": { |
2122 "description": "Associates `members` with a `role`.", | 1892 "description": "Associates `members` with a `role`.", |
2123 "id": "Binding", | 1893 "id": "Binding", |
2124 "properties": { | 1894 "properties": { |
| 1895 "members": { |
| 1896 "description": "Specifies the identities requesting access f
or a Cloud Platform resource.\n`members` can have the following values:\n\n* `al
lUsers`: A special identifier that represents anyone who is\n on the internet;
with or without a Google account.\n\n* `allAuthenticatedUsers`: A special ident
ifier that represents anyone\n who is authenticated with a Google account or a
service account.\n\n* `user:{emailid}`: An email address that represents a spec
ific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\
n\n* `serviceAccount:{emailid}`: An email address that represents a service\n
account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{e
mailid}`: An email address that represents a Google group.\n For example, `adm
ins@example.com`.\n\n* `domain:{domain}`: A Google Apps domain name that represe
nts all the\n users of that domain. For example, `google.com` or `example.com`
.\n\n", |
| 1897 "items": { |
| 1898 "type": "string" |
| 1899 }, |
| 1900 "type": "array" |
| 1901 }, |
2125 "role": { | 1902 "role": { |
2126 "description": "Role that is assigned to `members`. For exam
ple, `roles/viewer`, `roles/editor`, or `roles/owner`. Required", | 1903 "description": "Role that is assigned to `members`.\nFor exa
mple, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired", |
2127 "type": "string" | 1904 "type": "string" |
2128 }, | 1905 } |
2129 "members": { | 1906 }, |
2130 "description": "Specifies the identities requesting access f
or a Cloud Platform resource. `members` can have the following values: * `allUse
rs`: A special identifier that represents anyone who is on the internet; with or
without a Google account. * `allAuthenticatedUsers`: A special identifier that
represents anyone who is authenticated with a Google account or a service accoun
t. * `user:{emailid}`: An email address that represents a specific Google accoun
t. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{email
id}`: An email address that represents a service account. For example, `my-other
-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that re
presents a Google group. For example, `admins@example.com`. * `domain:{domain}`:
A Google Apps domain name that represents all the users of that domain. For exa
mple, `google.com` or `example.com`.", | 1907 "type": "object" |
2131 "items": { | 1908 }, |
2132 "type": "string" | 1909 "Range": { |
2133 }, | 1910 "description": "A 0-based half-open genomic coordinate range for sea
rch requests.", |
2134 "type": "array" | 1911 "id": "Range", |
2135 } | 1912 "properties": { |
2136 }, | 1913 "start": { |
2137 "type": "object" | 1914 "description": "The start position of the range on the refer
ence, 0-based inclusive.", |
2138 }, | 1915 "format": "int64", |
2139 "GetIamPolicyRequest": { | 1916 "type": "string" |
2140 "description": "Request message for `GetIamPolicy` method.", | 1917 }, |
2141 "id": "GetIamPolicyRequest", | 1918 "end": { |
2142 "type": "object" | 1919 "description": "The end position of the range on the referen
ce, 0-based exclusive.", |
2143 }, | 1920 "format": "int64", |
2144 "TestIamPermissionsRequest": { | 1921 "type": "string" |
2145 "description": "Request message for `TestIamPermissions` method.", | 1922 }, |
2146 "id": "TestIamPermissionsRequest", | 1923 "referenceName": { |
2147 "properties": { | 1924 "description": "The reference sequence name, for example `ch
r1`,\n`1`, or `chrX`.", |
2148 "permissions": { | 1925 "type": "string" |
2149 "description": "REQUIRED: The set of permissions to check fo
r the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are no
t allowed. Allowed permissions are: * `genomics.datasets.create` * `genomics.dat
asets.delete` * `genomics.datasets.get` * `genomics.datasets.list` * `genomics.d
atasets.update` * `genomics.datasets.getIamPolicy` * `genomics.datasets.setIamPo
licy`", | 1926 } |
2150 "items": { | 1927 }, |
2151 "type": "string" | 1928 "type": "object" |
2152 }, | 1929 }, |
2153 "type": "array" | 1930 "VariantSet": { |
2154 } | 1931 "description": "A variant set is a collection of call sets and varia
nts. It contains summary\nstatistics of those contents. A variant set belongs to
a dataset.\n\nFor more genomics resource definitions, see [Fundamentals of Goog
le\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
", |
2155 }, | 1932 "id": "VariantSet", |
2156 "type": "object" | 1933 "properties": { |
2157 }, | 1934 "description": { |
2158 "TestIamPermissionsResponse": { | 1935 "description": "A textual description of this variant set.", |
2159 "description": "Response message for `TestIamPermissions` method.", | 1936 "type": "string" |
2160 "id": "TestIamPermissionsResponse", | 1937 }, |
2161 "properties": { | 1938 "datasetId": { |
2162 "permissions": { | 1939 "description": "The dataset to which this variant set belong
s.", |
2163 "description": "A subset of `TestPermissionsRequest.permissi
ons` that the caller is allowed.", | 1940 "type": "string" |
2164 "items": { | 1941 }, |
2165 "type": "string" | 1942 "name": { |
2166 }, | 1943 "description": "User-specified, mutable name.", |
2167 "type": "array" | 1944 "type": "string" |
2168 } | 1945 }, |
2169 }, | 1946 "referenceSetId": { |
2170 "type": "object" | 1947 "description": "The reference set to which the variant set i
s mapped. The reference set\ndescribes the alignment provenance of the variant s
et, while the\n`referenceBounds` describe the shape of the actual variant data.
The\nreference set's reference names are a superset of those found in the\n`refe
renceBounds`.\n\nFor example, given a variant set that is mapped to the GRCh38 r
eference set\nand contains a single variant on reference 'X', `referenceBounds`
would\ncontain only an entry for 'X', while the associated reference set\nenumer
ates all possible references: '1', '2', 'X', 'Y', 'MT', etc.", |
| 1948 "type": "string" |
| 1949 }, |
| 1950 "metadata": { |
| 1951 "description": "The metadata associated with this variant se
t.", |
| 1952 "items": { |
| 1953 "$ref": "VariantSetMetadata" |
| 1954 }, |
| 1955 "type": "array" |
| 1956 }, |
| 1957 "referenceBounds": { |
| 1958 "description": "A list of all references used by the variant
s in a variant set\nwith associated coordinate upper bounds for each one.", |
| 1959 "items": { |
| 1960 "$ref": "ReferenceBound" |
| 1961 }, |
| 1962 "type": "array" |
| 1963 }, |
| 1964 "id": { |
| 1965 "description": "The server-generated variant set ID, unique
across all variant sets.", |
| 1966 "type": "string" |
| 1967 } |
| 1968 }, |
| 1969 "type": "object" |
| 1970 }, |
| 1971 "ReferenceBound": { |
| 1972 "description": "ReferenceBound records an upper bound for the starti
ng coordinate of\nvariants in a particular reference.", |
| 1973 "id": "ReferenceBound", |
| 1974 "properties": { |
| 1975 "upperBound": { |
| 1976 "description": "An upper bound (inclusive) on the starting c
oordinate of any\nvariant in the reference sequence.", |
| 1977 "format": "int64", |
| 1978 "type": "string" |
| 1979 }, |
| 1980 "referenceName": { |
| 1981 "description": "The name of the reference associated with th
is reference bound.", |
| 1982 "type": "string" |
| 1983 } |
| 1984 }, |
| 1985 "type": "object" |
| 1986 }, |
| 1987 "BatchCreateAnnotationsResponse": { |
| 1988 "id": "BatchCreateAnnotationsResponse", |
| 1989 "properties": { |
| 1990 "entries": { |
| 1991 "description": "The resulting per-annotation entries, ordere
d consistently with the\noriginal request.", |
| 1992 "items": { |
| 1993 "$ref": "Entry" |
| 1994 }, |
| 1995 "type": "array" |
| 1996 } |
| 1997 }, |
| 1998 "type": "object" |
| 1999 }, |
| 2000 "SearchCallSetsResponse": { |
| 2001 "description": "The call set search response.", |
| 2002 "id": "SearchCallSetsResponse", |
| 2003 "properties": { |
| 2004 "callSets": { |
| 2005 "description": "The list of matching call sets.", |
| 2006 "items": { |
| 2007 "$ref": "CallSet" |
| 2008 }, |
| 2009 "type": "array" |
| 2010 }, |
| 2011 "nextPageToken": { |
| 2012 "description": "The continuation token, which is used to pag
e through large result sets.\nProvide this value in a subsequent request to retu
rn the next page of\nresults. This field will be empty if there aren't any addit
ional results.", |
| 2013 "type": "string" |
| 2014 } |
| 2015 }, |
| 2016 "type": "object" |
| 2017 }, |
| 2018 "Variant": { |
| 2019 "description": "A variant represents a change in DNA sequence relati
ve to a reference\nsequence. For example, a variant could represent a SNP or an
insertion.\nVariants belong to a variant set.\n\nFor more genomics resource defi
nitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomic
s/fundamentals-of-google-genomics)\n\nEach of the calls on a variant represent a
determination of genotype with\nrespect to that variant. For example, a call mi
ght assign probability of 0.32\nto the occurrence of a SNP named rs1234 in a sam
ple named NA12345. A call\nbelongs to a call set, which contains related calls t
ypically from one\nsample.", |
| 2020 "id": "Variant", |
| 2021 "properties": { |
| 2022 "variantSetId": { |
| 2023 "description": "The ID of the variant set this variant belon
gs to.", |
| 2024 "type": "string" |
| 2025 }, |
| 2026 "referenceName": { |
| 2027 "description": "The reference on which this variant occurs.\
n(such as `chr20` or `X`)", |
| 2028 "type": "string" |
| 2029 }, |
| 2030 "info": { |
| 2031 "additionalProperties": { |
| 2032 "items": { |
| 2033 "type": "any" |
| 2034 }, |
| 2035 "type": "array" |
| 2036 }, |
| 2037 "description": "A map of additional variant information. Thi
s must be of the form\nmap<string, string[]> (string key mapping to a list of st
ring values).", |
| 2038 "type": "object" |
| 2039 }, |
| 2040 "referenceBases": { |
| 2041 "description": "The reference bases for this variant. They s
tart at the given\nposition.", |
| 2042 "type": "string" |
| 2043 }, |
| 2044 "names": { |
| 2045 "description": "Names for the variant, for example a RefSNP
ID.", |
| 2046 "items": { |
| 2047 "type": "string" |
| 2048 }, |
| 2049 "type": "array" |
| 2050 }, |
| 2051 "alternateBases": { |
| 2052 "description": "The bases that appear instead of the referen
ce bases.", |
| 2053 "items": { |
| 2054 "type": "string" |
| 2055 }, |
| 2056 "type": "array" |
| 2057 }, |
| 2058 "end": { |
| 2059 "description": "The end position (0-based) of this variant.
This corresponds to the first\nbase after the last base in the reference allele.
So, the length of\nthe reference allele is (end - start). This is useful for va
riants\nthat don't explicitly give alternate bases, for example large deletions.
", |
| 2060 "format": "int64", |
| 2061 "type": "string" |
| 2062 }, |
| 2063 "filter": { |
| 2064 "description": "A list of filters (normally quality filters)
this variant has failed.\n`PASS` indicates this variant has passed all filters.
", |
| 2065 "items": { |
| 2066 "type": "string" |
| 2067 }, |
| 2068 "type": "array" |
| 2069 }, |
| 2070 "calls": { |
| 2071 "description": "The variant calls for this particular varian
t. Each one represents the\ndetermination of genotype with respect to this varia
nt.", |
| 2072 "items": { |
| 2073 "$ref": "VariantCall" |
| 2074 }, |
| 2075 "type": "array" |
| 2076 }, |
| 2077 "created": { |
| 2078 "description": "The date this variant was created, in millis
econds from the epoch.", |
| 2079 "format": "int64", |
| 2080 "type": "string" |
| 2081 }, |
| 2082 "start": { |
| 2083 "description": "The position at which this variant occurs (0
-based).\nThis corresponds to the first base of the string of reference bases.", |
| 2084 "format": "int64", |
| 2085 "type": "string" |
| 2086 }, |
| 2087 "quality": { |
| 2088 "description": "A measure of how likely this variant is to b
e real.\nA higher value is better.", |
| 2089 "format": "double", |
| 2090 "type": "number" |
| 2091 }, |
| 2092 "id": { |
| 2093 "description": "The server-generated variant ID, unique acro
ss all variants.", |
| 2094 "type": "string" |
| 2095 } |
| 2096 }, |
| 2097 "type": "object" |
2171 }, | 2098 }, |
2172 "ListOperationsResponse": { | 2099 "ListOperationsResponse": { |
2173 "description": "The response message for Operations.ListOperations."
, | 2100 "description": "The response message for Operations.ListOperations."
, |
2174 "id": "ListOperationsResponse", | 2101 "id": "ListOperationsResponse", |
2175 "properties": { | 2102 "properties": { |
| 2103 "nextPageToken": { |
| 2104 "description": "The standard List next-page token.", |
| 2105 "type": "string" |
| 2106 }, |
2176 "operations": { | 2107 "operations": { |
2177 "description": "A list of operations that matches the specif
ied filter in the request.", | 2108 "description": "A list of operations that matches the specif
ied filter in the request.", |
2178 "items": { | 2109 "items": { |
2179 "$ref": "Operation" | 2110 "$ref": "Operation" |
2180 }, | 2111 }, |
2181 "type": "array" | 2112 "type": "array" |
| 2113 } |
| 2114 }, |
| 2115 "type": "object" |
| 2116 }, |
| 2117 "OperationMetadata": { |
| 2118 "description": "Metadata describing an Operation.", |
| 2119 "id": "OperationMetadata", |
| 2120 "properties": { |
| 2121 "projectId": { |
| 2122 "description": "The Google Cloud Project in which the job is
scoped.", |
| 2123 "type": "string" |
2182 }, | 2124 }, |
2183 "nextPageToken": { | 2125 "clientId": { |
2184 "description": "The standard List next-page token.", | 2126 "description": "This field is deprecated. Use `labels` inste
ad. Optionally provided by the\ncaller when submitting the request that creates
the operation.", |
| 2127 "type": "string" |
| 2128 }, |
| 2129 "endTime": { |
| 2130 "description": "The time at which the job stopped running.", |
| 2131 "format": "google-datetime", |
| 2132 "type": "string" |
| 2133 }, |
| 2134 "events": { |
| 2135 "description": "Optional event messages that were generated
during the job's execution.\nThis also contains any warnings that were generated
during import\nor export.", |
| 2136 "items": { |
| 2137 "$ref": "OperationEvent" |
| 2138 }, |
| 2139 "type": "array" |
| 2140 }, |
| 2141 "startTime": { |
| 2142 "description": "The time at which the job began to run.", |
| 2143 "format": "google-datetime", |
| 2144 "type": "string" |
| 2145 }, |
| 2146 "request": { |
| 2147 "additionalProperties": { |
| 2148 "description": "Properties of the object. Contains field
@type with type URL.", |
| 2149 "type": "any" |
| 2150 }, |
| 2151 "description": "The original request that started the operat
ion. Note that this will be in\ncurrent version of the API. If the operation was
started with v1beta2 API\nand a GetOperation is performed on v1 API, a v1 reque
st will be returned.", |
| 2152 "type": "object" |
| 2153 }, |
| 2154 "runtimeMetadata": { |
| 2155 "additionalProperties": { |
| 2156 "description": "Properties of the object. Contains field
@type with type URL.", |
| 2157 "type": "any" |
| 2158 }, |
| 2159 "description": "Runtime metadata on this Operation.", |
| 2160 "type": "object" |
| 2161 }, |
| 2162 "labels": { |
| 2163 "additionalProperties": { |
| 2164 "type": "string" |
| 2165 }, |
| 2166 "description": "Optionally provided by the caller when submi
tting the request that creates\nthe operation.", |
| 2167 "type": "object" |
| 2168 }, |
| 2169 "createTime": { |
| 2170 "description": "The time at which the job was submitted to t
he Genomics service.", |
| 2171 "format": "google-datetime", |
2185 "type": "string" | 2172 "type": "string" |
2186 } | 2173 } |
2187 }, | 2174 }, |
2188 "type": "object" | 2175 "type": "object" |
2189 }, | 2176 }, |
2190 "Operation": { | 2177 "SearchVariantsRequest": { |
2191 "description": "This resource represents a long-running operation th
at is the result of a network API call.", | 2178 "description": "The variant search request.", |
2192 "id": "Operation", | 2179 "id": "SearchVariantsRequest", |
2193 "properties": { | 2180 "properties": { |
2194 "name": { | 2181 "referenceName": { |
2195 "description": "The server-assigned name, which is only uniq
ue within the same service that originally returns it. For example: `operations/
CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`", | 2182 "description": "Required. Only return variants in this refer
ence sequence.", |
2196 "type": "string" | 2183 "type": "string" |
2197 }, | 2184 }, |
2198 "metadata": { | 2185 "variantSetIds": { |
2199 "additionalProperties": { | 2186 "description": "At most one variant set ID must be provided.
Only variants from this\nvariant set will be returned. If omitted, a call set i
d must be included in\nthe request.", |
2200 "description": "Properties of the object. Contains field
@type with type URL.", | |
2201 "type": "any" | |
2202 }, | |
2203 "description": "An OperationMetadata object. This will alway
s be returned with the Operation.", | |
2204 "type": "object" | |
2205 }, | |
2206 "done": { | |
2207 "description": "If the value is `false`, it means the operat
ion is still in progress. If true, the operation is completed, and either `error
` or `response` is available.", | |
2208 "type": "boolean" | |
2209 }, | |
2210 "error": { | |
2211 "$ref": "Status", | |
2212 "description": "The error result of the operation in case of
failure or cancellation." | |
2213 }, | |
2214 "response": { | |
2215 "additionalProperties": { | |
2216 "description": "Properties of the object. Contains field
@type with type URL.", | |
2217 "type": "any" | |
2218 }, | |
2219 "description": "If importing ReadGroupSets, an ImportReadGro
upSetsResponse is returned. If importing Variants, an ImportVariantsResponse is
returned. For exports, an empty response is returned.", | |
2220 "type": "object" | |
2221 } | |
2222 }, | |
2223 "type": "object" | |
2224 }, | |
2225 "CancelOperationRequest": { | |
2226 "description": "The request message for Operations.CancelOperation."
, | |
2227 "id": "CancelOperationRequest", | |
2228 "type": "object" | |
2229 }, | |
2230 "ImportReadGroupSetsRequest": { | |
2231 "description": "The read group set import request.", | |
2232 "id": "ImportReadGroupSetsRequest", | |
2233 "properties": { | |
2234 "datasetId": { | |
2235 "description": "Required. The ID of the dataset these read g
roup sets will belong to. The caller must have WRITE permissions to this dataset
.", | |
2236 "type": "string" | |
2237 }, | |
2238 "referenceSetId": { | |
2239 "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.", | |
2240 "type": "string" | |
2241 }, | |
2242 "sourceUris": { | |
2243 "description": "A list of URIs pointing at [BAM files](https
://samtools.github.io/hts-specs/SAMv1.pdf) in Google Cloud Storage.", | |
2244 "items": { | 2187 "items": { |
2245 "type": "string" | 2188 "type": "string" |
2246 }, | 2189 }, |
2247 "type": "array" | 2190 "type": "array" |
2248 }, | 2191 }, |
2249 "partitionStrategy": { | 2192 "end": { |
2250 "description": "The partition strategy describes how read gr
oups are partitioned into read group sets.", | 2193 "description": "The end of the window, 0-based exclusive. If
unspecified or 0, defaults to\nthe length of the reference.", |
2251 "enum": [ | 2194 "format": "int64", |
2252 "PARTITION_STRATEGY_UNSPECIFIED", | 2195 "type": "string" |
2253 "PER_FILE_PER_SAMPLE", | 2196 }, |
2254 "MERGE_ALL" | 2197 "maxCalls": { |
2255 ], | 2198 "description": "The maximum number of calls to return in a s
ingle page. Note that this\nlimit may be exceeded in the event that a matching v
ariant contains more\ncalls than the requested maximum. If unspecified, defaults
to 5000. The\nmaximum value is 10000.", |
| 2199 "format": "int32", |
| 2200 "type": "integer" |
| 2201 }, |
| 2202 "pageToken": { |
| 2203 "description": "The continuation token, which is used to pag
e through large result sets.\nTo get the next page of results, set this paramete
r to the value of\n`nextPageToken` from the previous response.", |
| 2204 "type": "string" |
| 2205 }, |
| 2206 "pageSize": { |
| 2207 "description": "The maximum number of variants to return in
a single page. If unspecified,\ndefaults to 5000. The maximum value is 10000.", |
| 2208 "format": "int32", |
| 2209 "type": "integer" |
| 2210 }, |
| 2211 "callSetIds": { |
| 2212 "description": "Only return variant calls which belong to ca
ll sets with these ids.\nLeaving this blank returns all variant calls. If a vari
ant has no\ncalls belonging to any of these call sets, it won't be returned at a
ll.", |
| 2213 "items": { |
| 2214 "type": "string" |
| 2215 }, |
| 2216 "type": "array" |
| 2217 }, |
| 2218 "start": { |
| 2219 "description": "The beginning of the window (0-based, inclus
ive) for which\noverlapping variants should be returned. If unspecified, default
s to 0.", |
| 2220 "format": "int64", |
| 2221 "type": "string" |
| 2222 }, |
| 2223 "variantName": { |
| 2224 "description": "Only return variants which have exactly this
name.", |
2256 "type": "string" | 2225 "type": "string" |
2257 } | 2226 } |
2258 }, | 2227 }, |
2259 "type": "object" | 2228 "type": "object" |
2260 }, | |
2261 "ExportReadGroupSetRequest": { | |
2262 "description": "The read group set export request.", | |
2263 "id": "ExportReadGroupSetRequest", | |
2264 "properties": { | |
2265 "projectId": { | |
2266 "description": "Required. The Google Cloud project ID that o
wns this export. The caller must have WRITE access to this project.", | |
2267 "type": "string" | |
2268 }, | |
2269 "exportUri": { | |
2270 "description": "Required. A Google Cloud Storage URI for the
exported BAM file. The currently authenticated user must have write access to t
he new file. An error will be returned if the URI already contains data.", | |
2271 "type": "string" | |
2272 }, | |
2273 "referenceNames": { | |
2274 "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.", | |
2275 "items": { | |
2276 "type": "string" | |
2277 }, | |
2278 "type": "array" | |
2279 } | |
2280 }, | |
2281 "type": "object" | |
2282 }, | 2229 }, |
2283 "SearchReadGroupSetsRequest": { | 2230 "SearchReadGroupSetsRequest": { |
2284 "description": "The read group set search request.", | 2231 "description": "The read group set search request.", |
2285 "id": "SearchReadGroupSetsRequest", | 2232 "id": "SearchReadGroupSetsRequest", |
2286 "properties": { | 2233 "properties": { |
2287 "datasetIds": { | |
2288 "description": "Restricts this query to read group sets with
in the given datasets. At least one ID must be provided.", | |
2289 "items": { | |
2290 "type": "string" | |
2291 }, | |
2292 "type": "array" | |
2293 }, | |
2294 "name": { | 2234 "name": { |
2295 "description": "Only return read group sets for which a subs
tring of the name matches this string.", | 2235 "description": "Only return read group sets for which a subs
tring of the name matches this\nstring.", |
2296 "type": "string" | 2236 "type": "string" |
2297 }, | 2237 }, |
2298 "pageToken": { | 2238 "pageToken": { |
2299 "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.", | 2239 "description": "The continuation token, which is used to pag
e through large result sets.\nTo get the next page of results, set this paramete
r to the value of\n`nextPageToken` from the previous response.", |
2300 "type": "string" | 2240 "type": "string" |
2301 }, | 2241 }, |
2302 "pageSize": { | 2242 "pageSize": { |
2303 "description": "The maximum number of results to return in a
single page. If unspecified, defaults to 256. The maximum value is 1024.", | 2243 "description": "The maximum number of results to return in a
single page. If unspecified,\ndefaults to 256. The maximum value is 1024.", |
2304 "format": "int32", | 2244 "format": "int32", |
2305 "type": "integer" | 2245 "type": "integer" |
2306 } | 2246 }, |
2307 }, | 2247 "datasetIds": { |
2308 "type": "object" | 2248 "description": "Restricts this query to read group sets with
in the given datasets. At least\none ID must be provided.", |
2309 }, | 2249 "items": { |
2310 "SearchReadGroupSetsResponse": { | 2250 "type": "string" |
2311 "description": "The read group set search response.", | 2251 }, |
2312 "id": "SearchReadGroupSetsResponse", | 2252 "type": "array" |
2313 "properties": { | 2253 } |
2314 "readGroupSets": { | 2254 }, |
2315 "description": "The list of matching read group sets.", | 2255 "type": "object" |
2316 "items": { | 2256 }, |
2317 "$ref": "ReadGroupSet" | 2257 "SearchAnnotationsResponse": { |
| 2258 "id": "SearchAnnotationsResponse", |
| 2259 "properties": { |
| 2260 "annotations": { |
| 2261 "description": "The matching annotations.", |
| 2262 "items": { |
| 2263 "$ref": "Annotation" |
2318 }, | 2264 }, |
2319 "type": "array" | 2265 "type": "array" |
2320 }, | 2266 }, |
2321 "nextPageToken": { | 2267 "nextPageToken": { |
2322 "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.", | 2268 "description": "The continuation token, which is used to pag
e through large result sets.\nProvide this value in a subsequent request to retu
rn the next page of\nresults. This field will be empty if there aren't any addit
ional results.", |
2323 "type": "string" | 2269 "type": "string" |
2324 } | 2270 } |
2325 }, | 2271 }, |
2326 "type": "object" | 2272 "type": "object" |
2327 }, | 2273 }, |
2328 "ReadGroupSet": { | 2274 "ClinicalCondition": { |
2329 "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. * A read group set belongs to one dataset. * A read group belongs to o
ne read group set. * A read belongs to one read group. For more genomics resourc
e definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/ge
nomics/fundamentals-of-google-genomics)", | 2275 "id": "ClinicalCondition", |
2330 "id": "ReadGroupSet", | 2276 "properties": { |
2331 "properties": { | 2277 "conceptId": { |
| 2278 "description": "The MedGen concept id associated with this g
ene.\nSearch for these IDs at http://www.ncbi.nlm.nih.gov/medgen/", |
| 2279 "type": "string" |
| 2280 }, |
| 2281 "names": { |
| 2282 "description": "A set of names for the condition.", |
| 2283 "items": { |
| 2284 "type": "string" |
| 2285 }, |
| 2286 "type": "array" |
| 2287 }, |
| 2288 "omimId": { |
| 2289 "description": "The OMIM id for this condition.\nSearch for
these IDs at http://omim.org/", |
| 2290 "type": "string" |
| 2291 }, |
| 2292 "externalIds": { |
| 2293 "description": "The set of external IDs for this condition."
, |
| 2294 "items": { |
| 2295 "$ref": "ExternalId" |
| 2296 }, |
| 2297 "type": "array" |
| 2298 } |
| 2299 }, |
| 2300 "type": "object" |
| 2301 }, |
| 2302 "SearchReadsResponse": { |
| 2303 "description": "The read search response.", |
| 2304 "id": "SearchReadsResponse", |
| 2305 "properties": { |
| 2306 "nextPageToken": { |
| 2307 "description": "The continuation token, which is used to pag
e through large result sets.\nProvide this value in a subsequent request to retu
rn the next page of\nresults. This field will be empty if there aren't any addit
ional results.", |
| 2308 "type": "string" |
| 2309 }, |
| 2310 "alignments": { |
| 2311 "description": "The list of matching alignments sorted by ma
pped genomic coordinate,\nif any, ascending in position within the same referenc
e. Unmapped reads,\nwhich have no position, are returned contiguously and are so
rted in\nascending lexicographic order by fragment name.", |
| 2312 "items": { |
| 2313 "$ref": "Read" |
| 2314 }, |
| 2315 "type": "array" |
| 2316 } |
| 2317 }, |
| 2318 "type": "object" |
| 2319 }, |
| 2320 "Program": { |
| 2321 "id": "Program", |
| 2322 "properties": { |
| 2323 "name": { |
| 2324 "description": "The display name of the program. This is typ
ically the colloquial name of\nthe tool used, for example 'bwa' or 'picard'.", |
| 2325 "type": "string" |
| 2326 }, |
| 2327 "commandLine": { |
| 2328 "description": "The command line used to run this program.", |
| 2329 "type": "string" |
| 2330 }, |
| 2331 "prevProgramId": { |
| 2332 "description": "The ID of the program run before this one.", |
| 2333 "type": "string" |
| 2334 }, |
2332 "id": { | 2335 "id": { |
2333 "description": "The server-generated read group set ID, uniq
ue for all read group sets.", | 2336 "description": "The user specified locally unique ID of the
program. Used along with\n`prevProgramId` to define an ordering between programs
.", |
2334 "type": "string" | 2337 "type": "string" |
2335 }, | 2338 }, |
2336 "datasetId": { | 2339 "version": { |
2337 "description": "The dataset to which this read group set bel
ongs.", | 2340 "description": "The version of the program run.", |
2338 "type": "string" | 2341 "type": "string" |
2339 }, | 2342 } |
2340 "referenceSetId": { | 2343 }, |
2341 "description": "The reference set to which the reads in this
read group set are aligned.", | 2344 "type": "object" |
| 2345 }, |
| 2346 "CoverageBucket": { |
| 2347 "description": "A bucket over which read coverage has been precomput
ed. A bucket corresponds\nto a specific range of the reference sequence.", |
| 2348 "id": "CoverageBucket", |
| 2349 "properties": { |
| 2350 "meanCoverage": { |
| 2351 "description": "The average number of reads which are aligne
d to each individual\nreference base in this bucket.", |
| 2352 "format": "float", |
| 2353 "type": "number" |
| 2354 }, |
| 2355 "range": { |
| 2356 "$ref": "Range", |
| 2357 "description": "The genomic coordinate range spanned by this
bucket." |
| 2358 } |
| 2359 }, |
| 2360 "type": "object" |
| 2361 }, |
| 2362 "ComputeEngine": { |
| 2363 "description": "Describes a Compute Engine resource that is being ma
naged by a running\npipeline.", |
| 2364 "id": "ComputeEngine", |
| 2365 "properties": { |
| 2366 "instanceName": { |
| 2367 "description": "The instance on which the operation is runni
ng.", |
| 2368 "type": "string" |
| 2369 }, |
| 2370 "zone": { |
| 2371 "description": "The availability zone in which the instance
resides.", |
| 2372 "type": "string" |
| 2373 }, |
| 2374 "machineType": { |
| 2375 "description": "The machine type of the instance.", |
| 2376 "type": "string" |
| 2377 }, |
| 2378 "diskNames": { |
| 2379 "description": "The names of the disks that were created for
this pipeline.", |
| 2380 "items": { |
| 2381 "type": "string" |
| 2382 }, |
| 2383 "type": "array" |
| 2384 } |
| 2385 }, |
| 2386 "type": "object" |
| 2387 }, |
| 2388 "ExternalId": { |
| 2389 "id": "ExternalId", |
| 2390 "properties": { |
| 2391 "sourceName": { |
| 2392 "description": "The name of the source of this data.", |
| 2393 "type": "string" |
| 2394 }, |
| 2395 "id": { |
| 2396 "description": "The id used by the source of this data.", |
| 2397 "type": "string" |
| 2398 } |
| 2399 }, |
| 2400 "type": "object" |
| 2401 }, |
| 2402 "Reference": { |
| 2403 "description": "A reference is a canonical assembled DNA sequence, i
ntended to act as a\nreference coordinate space for other genomic annotations. A
single reference\nmight represent the human chromosome 1 or mitochandrial DNA,
for instance. A\nreference belongs to one or more reference sets.\n\nFor more ge
nomics resource definitions, see [Fundamentals of Google\nGenomics](https://clou
d.google.com/genomics/fundamentals-of-google-genomics)", |
| 2404 "id": "Reference", |
| 2405 "properties": { |
| 2406 "md5checksum": { |
| 2407 "description": "MD5 of the upper-case sequence excluding all
whitespace characters (this\nis equivalent to SQ:M5 in SAM). This value is repr
esented in lower case\nhexadecimal format.", |
| 2408 "type": "string" |
| 2409 }, |
| 2410 "id": { |
| 2411 "description": "The server-generated reference ID, unique ac
ross all references.", |
| 2412 "type": "string" |
| 2413 }, |
| 2414 "length": { |
| 2415 "description": "The length of this reference's sequence.", |
| 2416 "format": "int64", |
| 2417 "type": "string" |
| 2418 }, |
| 2419 "sourceAccessions": { |
| 2420 "description": "All known corresponding accession IDs in INS
DC (GenBank/ENA/DDBJ) ideally\nwith a version number, for example `GCF_000001405
.26`.", |
| 2421 "items": { |
| 2422 "type": "string" |
| 2423 }, |
| 2424 "type": "array" |
| 2425 }, |
| 2426 "ncbiTaxonId": { |
| 2427 "description": "ID from http://www.ncbi.nlm.nih.gov/taxonomy
. For example, 9606 for human.", |
| 2428 "format": "int32", |
| 2429 "type": "integer" |
| 2430 }, |
| 2431 "sourceUri": { |
| 2432 "description": "The URI from which the sequence was obtained
. Typically specifies a FASTA\nformat file.", |
2342 "type": "string" | 2433 "type": "string" |
2343 }, | 2434 }, |
2344 "name": { | 2435 "name": { |
2345 "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.
", | 2436 "description": "The name of this reference, for example `22`
.", |
2346 "type": "string" | 2437 "type": "string" |
2347 }, | 2438 } |
2348 "filename": { | 2439 }, |
2349 "description": "The filename of the original source file for
this read group set, if any.", | 2440 "type": "object" |
2350 "type": "string" | 2441 }, |
2351 }, | 2442 "VariantSetMetadata": { |
2352 "readGroups": { | 2443 "description": "Metadata describes a single piece of variant call me
tadata.\nThese data include a top level key and either a single value string (va
lue)\nor a list of key-value pairs (info.)\nValue and info are mutually exclusiv
e.", |
2353 "description": "The read groups in this set. There are typic
ally 1-10 read groups in a read group set.", | 2444 "id": "VariantSetMetadata", |
2354 "items": { | 2445 "properties": { |
2355 "$ref": "ReadGroup" | 2446 "description": { |
2356 }, | 2447 "description": "A textual description of this metadata.", |
2357 "type": "array" | 2448 "type": "string" |
2358 }, | 2449 }, |
2359 "info": { | 2450 "info": { |
2360 "additionalProperties": { | 2451 "additionalProperties": { |
2361 "items": { | 2452 "items": { |
2362 "type": "any" | 2453 "type": "any" |
2363 }, | 2454 }, |
2364 "type": "array" | 2455 "type": "array" |
2365 }, | 2456 }, |
2366 "description": "A map of additional read group set informati
on.", | 2457 "description": "Remaining structured metadata key-value pair
s. This must be of the form\nmap<string, string[]> (string key mapping to a list
of string values).", |
2367 "type": "object" | 2458 "type": "object" |
2368 } | 2459 }, |
2369 }, | 2460 "type": { |
2370 "type": "object" | 2461 "description": "The type of data. Possible types include: In
teger, Float,\nFlag, Character, and String.", |
2371 }, | 2462 "enum": [ |
2372 "ReadGroup": { | 2463 "TYPE_UNSPECIFIED", |
2373 "description": "A read group is all the data that's processed the sa
me way by the sequencer.", | 2464 "INTEGER", |
2374 "id": "ReadGroup", | 2465 "FLOAT", |
2375 "properties": { | 2466 "FLAG", |
| 2467 "CHARACTER", |
| 2468 "STRING" |
| 2469 ], |
| 2470 "enumDescriptions": [ |
| 2471 "", |
| 2472 "", |
| 2473 "", |
| 2474 "", |
| 2475 "", |
| 2476 "" |
| 2477 ], |
| 2478 "type": "string" |
| 2479 }, |
| 2480 "number": { |
| 2481 "description": "The number of values that can be included in
a field described by this\nmetadata.", |
| 2482 "type": "string" |
| 2483 }, |
| 2484 "value": { |
| 2485 "description": "The value field for simple metadata", |
| 2486 "type": "string" |
| 2487 }, |
2376 "id": { | 2488 "id": { |
2377 "description": "The server-generated read group ID, unique f
or all read groups. Note: This is different than the @RG ID field in the SAM spe
c. For that value, see name.", | 2489 "description": "User-provided ID field, not enforced by this
API.\nTwo or more pieces of structured metadata with identical\nid and key fiel
ds are considered equivalent.", |
2378 "type": "string" | 2490 "type": "string" |
2379 }, | 2491 }, |
2380 "datasetId": { | 2492 "key": { |
2381 "description": "The dataset to which this read group belongs
.", | 2493 "description": "The top-level key.", |
2382 "type": "string" | 2494 "type": "string" |
2383 }, | 2495 } |
2384 "name": { | 2496 }, |
2385 "description": "The read group name. This corresponds to the
@RG ID field in the SAM spec.", | 2497 "type": "object" |
2386 "type": "string" | 2498 }, |
2387 }, | 2499 "SearchVariantSetsRequest": { |
2388 "description": { | 2500 "description": "The search variant sets request.", |
2389 "description": "A free-form text description of this read gr
oup.", | 2501 "id": "SearchVariantSetsRequest", |
2390 "type": "string" | 2502 "properties": { |
2391 }, | 2503 "pageToken": { |
2392 "sampleId": { | 2504 "description": "The continuation token, which is used to pag
e through large result sets.\nTo get the next page of results, set this paramete
r to the value of\n`nextPageToken` from the previous response.", |
2393 "description": "A client-supplied sample identifier for the
reads in this read group.", | 2505 "type": "string" |
2394 "type": "string" | 2506 }, |
2395 }, | 2507 "pageSize": { |
2396 "experiment": { | 2508 "description": "The maximum number of results to return in a
single page. If unspecified,\ndefaults to 1024.", |
2397 "$ref": "Experiment", | |
2398 "description": "The experiment used to generate this read gr
oup." | |
2399 }, | |
2400 "predictedInsertSize": { | |
2401 "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.", | |
2402 "format": "int32", | 2509 "format": "int32", |
2403 "type": "integer" | 2510 "type": "integer" |
2404 }, | 2511 }, |
2405 "programs": { | 2512 "datasetIds": { |
2406 "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.", | 2513 "description": "Exactly one dataset ID must be provided here
. Only variant sets which\nbelong to this dataset will be returned.", |
2407 "items": { | 2514 "items": { |
2408 "$ref": "Program" | 2515 "type": "string" |
2409 }, | 2516 }, |
2410 "type": "array" | 2517 "type": "array" |
2411 }, | 2518 } |
2412 "referenceSetId": { | 2519 }, |
2413 "description": "The reference set the reads in this read gro
up are aligned to.", | 2520 "type": "object" |
2414 "type": "string" | 2521 }, |
| 2522 "SearchReferenceSetsRequest": { |
| 2523 "id": "SearchReferenceSetsRequest", |
| 2524 "properties": { |
| 2525 "pageSize": { |
| 2526 "description": "The maximum number of results to return in a
single page. If unspecified,\ndefaults to 1024. The maximum value is 4096.", |
| 2527 "format": "int32", |
| 2528 "type": "integer" |
| 2529 }, |
| 2530 "assemblyId": { |
| 2531 "description": "If present, return reference sets for which
a substring of their\n`assemblyId` matches this string (case insensitive).", |
| 2532 "type": "string" |
| 2533 }, |
| 2534 "md5checksums": { |
| 2535 "description": "If present, return reference sets for which
the\nmd5checksum matches exactly.", |
| 2536 "items": { |
| 2537 "type": "string" |
| 2538 }, |
| 2539 "type": "array" |
| 2540 }, |
| 2541 "accessions": { |
| 2542 "description": "If present, return reference sets for which
a prefix of any of\nsourceAccessions\nmatch any of these strings. Accession numb
ers typically have a main number\nand a version, for example `NC_000001.11`.", |
| 2543 "items": { |
| 2544 "type": "string" |
| 2545 }, |
| 2546 "type": "array" |
| 2547 }, |
| 2548 "pageToken": { |
| 2549 "description": "The continuation token, which is used to pag
e through large result sets.\nTo get the next page of results, set this paramete
r to the value of\n`nextPageToken` from the previous response.", |
| 2550 "type": "string" |
| 2551 } |
| 2552 }, |
| 2553 "type": "object" |
| 2554 }, |
| 2555 "SetIamPolicyRequest": { |
| 2556 "description": "Request message for `SetIamPolicy` method.", |
| 2557 "id": "SetIamPolicyRequest", |
| 2558 "properties": { |
| 2559 "policy": { |
| 2560 "$ref": "Policy", |
| 2561 "description": "REQUIRED: The complete policy to be applied
to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An emp
ty policy is a\nvalid policy but certain Cloud Platform services (such as Projec
ts)\nmight reject them." |
| 2562 } |
| 2563 }, |
| 2564 "type": "object" |
| 2565 }, |
| 2566 "MergeVariantsRequest": { |
| 2567 "id": "MergeVariantsRequest", |
| 2568 "properties": { |
| 2569 "infoMergeConfig": { |
| 2570 "additionalProperties": { |
| 2571 "enum": [ |
| 2572 "INFO_MERGE_OPERATION_UNSPECIFIED", |
| 2573 "IGNORE_NEW", |
| 2574 "MOVE_TO_CALLS" |
| 2575 ], |
| 2576 "type": "string" |
| 2577 }, |
| 2578 "description": "A mapping between info field keys and the In
foMergeOperations to\nbe performed on them.", |
| 2579 "type": "object" |
| 2580 }, |
| 2581 "variantSetId": { |
| 2582 "description": "The destination variant set.", |
| 2583 "type": "string" |
| 2584 }, |
| 2585 "variants": { |
| 2586 "description": "The variants to be merged with existing vari
ants.", |
| 2587 "items": { |
| 2588 "$ref": "Variant" |
| 2589 }, |
| 2590 "type": "array" |
| 2591 } |
| 2592 }, |
| 2593 "type": "object" |
| 2594 }, |
| 2595 "BatchCreateAnnotationsRequest": { |
| 2596 "id": "BatchCreateAnnotationsRequest", |
| 2597 "properties": { |
| 2598 "annotations": { |
| 2599 "description": "The annotations to be created. At most 4096
can be specified in a single\nrequest.", |
| 2600 "items": { |
| 2601 "$ref": "Annotation" |
| 2602 }, |
| 2603 "type": "array" |
| 2604 }, |
| 2605 "requestId": { |
| 2606 "description": "A unique request ID which enables the server
to detect duplicated requests.\nIf provided, duplicated requests will result in
the same response; if not\nprovided, duplicated requests may result in duplicat
ed data. For a given\nannotation set, callers should not reuse `request_id`s whe
n writing\ndifferent batches of annotations - behavior in this case is undefined
.\nA common approach is to use a UUID. For batch jobs where worker crashes are\n
a possibility, consider using some unique variant of a worker or run ID.", |
| 2607 "type": "string" |
| 2608 } |
| 2609 }, |
| 2610 "type": "object" |
| 2611 }, |
| 2612 "Read": { |
| 2613 "description": "A read alignment describes a linear alignment of a s
tring of DNA to a\nreference sequence, in addition to metadata\nabout the fragme
nt (the molecule of DNA sequenced) and the read (the bases\nwhich were read by t
he sequencer). A read is equivalent to a line in a SAM\nfile. A read belongs to
exactly one read group and exactly one\nread group set.\n\nFor more genomics res
ource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.c
om/genomics/fundamentals-of-google-genomics)\n\n### Reverse-stranded reads\n\nMa
pped reads (reads having a non-null `alignment`) can be aligned to either\nthe f
orward or the reverse strand of their associated reference. Strandedness\nof a m
apped read is encoded by `alignment.position.reverseStrand`.\n\nIf we consider t
he reference to be a forward-stranded coordinate space of\n`[0, reference.length
)` with `0` as the left-most position and\n`reference.length` as the right-most
position, reads are always aligned left\nto right. That is, `alignment.position.
position` always refers to the\nleft-most reference coordinate and `alignment.ci
gar` describes the alignment\nof this read to the reference from left to right.
All per-base fields such as\n`alignedSequence` and `alignedQuality` share this s
ame left-to-right\norientation; this is true of reads which are aligned to eithe
r strand. For\nreverse-stranded reads, this means that `alignedSequence` is the
reverse\ncomplement of the bases that were originally reported by the sequencing
\nmachine.\n\n### Generating a reference-aligned sequence string\n\nWhen interac
ting with mapped reads, it's often useful to produce a string\nrepresenting the
local alignment of the read to reference. The following\npseudocode demonstrates
one way of doing this:\n\n out = \"\"\n offset = 0\n for c in read.ali
gnment.cigar {\n switch c.operation {\n case \"ALIGNMENT_MATCH\", \"SE
QUENCE_MATCH\", \"SEQUENCE_MISMATCH\":\n out += read.alignedSequence[offs
et:offset+c.operationLength]\n offset += c.operationLength\n break
\n case \"CLIP_SOFT\", \"INSERT\":\n offset += c.operationLength\n
break\n case \"PAD\":\n out += repeat(\"*\", c.operationLength
)\n break\n case \"DELETE\":\n out += repeat(\"-\", c.operati
onLength)\n break\n case \"SKIP\":\n out += repeat(\" \", c.o
perationLength)\n break\n case \"CLIP_HARD\":\n break\n
}\n }\n return out\n\n### Converting to SAM's CIGAR string\n\nThe followin
g pseudocode generates a SAM CIGAR string from the\n`cigar` field. Note that thi
s is a lossy conversion\n(`cigar.referenceSequence` is lost).\n\n cigarMap =
{\n \"ALIGNMENT_MATCH\": \"M\",\n \"INSERT\": \"I\",\n \"DELETE\"
: \"D\",\n \"SKIP\": \"N\",\n \"CLIP_SOFT\": \"S\",\n \"CLIP_HARD
\": \"H\",\n \"PAD\": \"P\",\n \"SEQUENCE_MATCH\": \"=\",\n \"SEQ
UENCE_MISMATCH\": \"X\",\n }\n cigarStr = \"\"\n for c in read.alignmen
t.cigar {\n cigarStr += c.operationLength + cigarMap[c.operation]\n }\n
return cigarStr", |
| 2614 "id": "Read", |
| 2615 "properties": { |
| 2616 "nextMatePosition": { |
| 2617 "$ref": "Position", |
| 2618 "description": "The mapping of the primary alignment of the\
n`(readNumber+1)%numberReads` read in the fragment. It replaces\nmate position a
nd mate strand in SAM." |
2415 }, | 2619 }, |
2416 "info": { | 2620 "info": { |
2417 "additionalProperties": { | 2621 "additionalProperties": { |
2418 "items": { | 2622 "items": { |
2419 "type": "any" | 2623 "type": "any" |
2420 }, | 2624 }, |
2421 "type": "array" | 2625 "type": "array" |
2422 }, | 2626 }, |
2423 "description": "A map of additional read group information.
This must be of the form map (string key mapping to a list of string values).", | 2627 "description": "A map of additional read alignment informati
on. This must be of the form\nmap<string, string[]> (string key mapping to a lis
t of string values).", |
2424 "type": "object" | 2628 "type": "object" |
2425 } | |
2426 }, | |
2427 "type": "object" | |
2428 }, | |
2429 "Experiment": { | |
2430 "id": "Experiment", | |
2431 "properties": { | |
2432 "libraryId": { | |
2433 "description": "A client-supplied library identifier; a libr
ary is a collection of DNA fragments which have been prepared for sequencing fro
m a sample. This field is important for quality control as error or bias can be
introduced during sample preparation.", | |
2434 "type": "string" | |
2435 }, | |
2436 "platformUnit": { | |
2437 "description": "The platform unit used as part of this exper
iment, for example flowcell-barcode.lane for Illumina or slide for SOLiD. Corres
ponds to the @RG PU field in the SAM spec.", | |
2438 "type": "string" | |
2439 }, | |
2440 "sequencingCenter": { | |
2441 "description": "The sequencing center used as part of this e
xperiment.", | |
2442 "type": "string" | |
2443 }, | |
2444 "instrumentModel": { | |
2445 "description": "The instrument model used as part of this ex
periment. This maps to sequencing technology in the SAM spec.", | |
2446 "type": "string" | |
2447 } | |
2448 }, | |
2449 "type": "object" | |
2450 }, | |
2451 "Program": { | |
2452 "id": "Program", | |
2453 "properties": { | |
2454 "commandLine": { | |
2455 "description": "The command line used to run this program.", | |
2456 "type": "string" | |
2457 }, | |
2458 "id": { | |
2459 "description": "The user specified locally unique ID of the
program. Used along with `prevProgramId` to define an ordering between programs.
", | |
2460 "type": "string" | |
2461 }, | |
2462 "name": { | |
2463 "description": "The display name of the program. This is typ
ically the colloquial name of the tool used, for example 'bwa' or 'picard'.", | |
2464 "type": "string" | |
2465 }, | |
2466 "prevProgramId": { | |
2467 "description": "The ID of the program run before this one.", | |
2468 "type": "string" | |
2469 }, | |
2470 "version": { | |
2471 "description": "The version of the program run.", | |
2472 "type": "string" | |
2473 } | |
2474 }, | |
2475 "type": "object" | |
2476 }, | |
2477 "ListCoverageBucketsResponse": { | |
2478 "id": "ListCoverageBucketsResponse", | |
2479 "properties": { | |
2480 "bucketWidth": { | |
2481 "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`).", | |
2482 "format": "int64", | |
2483 "type": "string" | |
2484 }, | |
2485 "coverageBuckets": { | |
2486 "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
its end is the end of the reference sequence.", | |
2487 "items": { | |
2488 "$ref": "CoverageBucket" | |
2489 }, | |
2490 "type": "array" | |
2491 }, | |
2492 "nextPageToken": { | |
2493 "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.", | |
2494 "type": "string" | |
2495 } | |
2496 }, | |
2497 "type": "object" | |
2498 }, | |
2499 "CoverageBucket": { | |
2500 "description": "A bucket over which read coverage has been precomput
ed. A bucket corresponds to a specific range of the reference sequence.", | |
2501 "id": "CoverageBucket", | |
2502 "properties": { | |
2503 "range": { | |
2504 "$ref": "Range", | |
2505 "description": "The genomic coordinate range spanned by this
bucket." | |
2506 }, | |
2507 "meanCoverage": { | |
2508 "description": "The average number of reads which are aligne
d to each individual reference base in this bucket.", | |
2509 "format": "float", | |
2510 "type": "number" | |
2511 } | |
2512 }, | |
2513 "type": "object" | |
2514 }, | |
2515 "Range": { | |
2516 "description": "A 0-based half-open genomic coordinate range for sea
rch requests.", | |
2517 "id": "Range", | |
2518 "properties": { | |
2519 "referenceName": { | |
2520 "description": "The reference sequence name, for example `ch
r1`, `1`, or `chrX`.", | |
2521 "type": "string" | |
2522 }, | |
2523 "start": { | |
2524 "description": "The start position of the range on the refer
ence, 0-based inclusive.", | |
2525 "format": "int64", | |
2526 "type": "string" | |
2527 }, | |
2528 "end": { | |
2529 "description": "The end position of the range on the referen
ce, 0-based exclusive.", | |
2530 "format": "int64", | |
2531 "type": "string" | |
2532 } | |
2533 }, | |
2534 "type": "object" | |
2535 }, | |
2536 "SearchReadsRequest": { | |
2537 "description": "The read search request.", | |
2538 "id": "SearchReadsRequest", | |
2539 "properties": { | |
2540 "readGroupSetIds": { | |
2541 "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`.", | |
2542 "items": { | |
2543 "type": "string" | |
2544 }, | |
2545 "type": "array" | |
2546 }, | |
2547 "readGroupIds": { | |
2548 "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`.", | |
2549 "items": { | |
2550 "type": "string" | |
2551 }, | |
2552 "type": "array" | |
2553 }, | |
2554 "referenceName": { | |
2555 "description": "The reference sequence name, for example `ch
r1`, `1`, or `chrX`. If set to `*`, only unmapped reads are returned. If unspeci
fied, all reads (mapped and unmapped) are returned.", | |
2556 "type": "string" | |
2557 }, | |
2558 "start": { | |
2559 "description": "The start position of the range on the refer
ence, 0-based inclusive. If specified, `referenceName` must also be specified.", | |
2560 "format": "int64", | |
2561 "type": "string" | |
2562 }, | |
2563 "end": { | |
2564 "description": "The end position of the range on the referen
ce, 0-based exclusive. If specified, `referenceName` must also be specified.", | |
2565 "format": "int64", | |
2566 "type": "string" | |
2567 }, | |
2568 "pageToken": { | |
2569 "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.", | |
2570 "type": "string" | |
2571 }, | |
2572 "pageSize": { | |
2573 "description": "The maximum number of results to return in a
single page. If unspecified, defaults to 256. The maximum value is 2048.", | |
2574 "format": "int32", | |
2575 "type": "integer" | |
2576 } | |
2577 }, | |
2578 "type": "object" | |
2579 }, | |
2580 "SearchReadsResponse": { | |
2581 "description": "The read search response.", | |
2582 "id": "SearchReadsResponse", | |
2583 "properties": { | |
2584 "alignments": { | |
2585 "description": "The list of matching alignments sorted by ma
pped genomic coordinate, if any, ascending in position within the same reference
. Unmapped reads, which have no position, are returned contiguously and are sort
ed in ascending lexicographic order by fragment name.", | |
2586 "items": { | |
2587 "$ref": "Read" | |
2588 }, | |
2589 "type": "array" | |
2590 }, | |
2591 "nextPageToken": { | |
2592 "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.", | |
2593 "type": "string" | |
2594 } | |
2595 }, | |
2596 "type": "object" | |
2597 }, | |
2598 "Read": { | |
2599 "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. For more genomics resource de
finitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomi
cs/fundamentals-of-google-genomics) ### Reverse-stranded reads Mapped reads (rea
ds having a non-null `alignment`) can be aligned to either the forward or the re
verse strand of their associated reference. Strandedness of a mapped read is enc
oded by `alignment.position.reverseStrand`. If we consider the reference to be a
forward-stranded coordinate space of `[0, reference.length)` with `0` as the le
ft-most position and `reference.length` as the right-most position, reads are al
ways aligned left to right. That is, `alignment.position.position` always refers
to the left-most reference coordinate and `alignment.cigar` describes the align
ment of this read to the reference from left to right. All per-base fields such
as `alignedSequence` and `alignedQuality` share this same left-to-right orientat
ion; this is true of reads which are aligned to either strand. For reverse-stran
ded reads, this means that `alignedSequence` is the reverse complement of the ba
ses that were originally reported by the sequencing machine. ### Generating a re
ference-aligned sequence string When interacting with mapped reads, it's often u
seful to produce a string representing the local alignment of the read to refere
nce. The following pseudocode demonstrates one way of doing this: out = \"\" off
set = 0 for c in read.alignment.cigar { switch c.operation { case \"ALIGNMENT_MA
TCH\", \"SEQUENCE_MATCH\", \"SEQUENCE_MISMATCH\": out += read.alignedSequence[of
fset:offset+c.operationLength] offset += c.operationLength break case \"CLIP_SOF
T\", \"INSERT\": offset += c.operationLength break case \"PAD\": out += repeat(\
"*\", c.operationLength) break case \"DELETE\": out += repeat(\"-\", c.operation
Length) break case \"SKIP\": out += repeat(\" \", c.operationLength) break case
\"CLIP_HARD\": break } } return out ### Converting to SAM's CIGAR string The fol
lowing pseudocode generates a SAM CIGAR string from the `cigar` field. Note that
this is a lossy conversion (`cigar.referenceSequence` is lost). cigarMap = { \"
ALIGNMENT_MATCH\": \"M\", \"INSERT\": \"I\", \"DELETE\": \"D\", \"SKIP\": \"N\",
\"CLIP_SOFT\": \"S\", \"CLIP_HARD\": \"H\", \"PAD\": \"P\", \"SEQUENCE_MATCH\":
\"=\", \"SEQUENCE_MISMATCH\": \"X\", } cigarStr = \"\" for c in read.alignment.
cigar { cigarStr += c.operationLength + cigarMap[c.operation] } return cigarStr"
, | |
2600 "id": "Read", | |
2601 "properties": { | |
2602 "id": { | |
2603 "description": "The server-generated read ID, unique across
all reads. This is different from the `fragmentName`.", | |
2604 "type": "string" | |
2605 }, | |
2606 "readGroupId": { | |
2607 "description": "The ID of the read group this read belongs t
o. A read belongs to exactly one read group. This is a server-generated ID which
is distinct from SAM's RG tag (for that value, see ReadGroup.name).", | |
2608 "type": "string" | |
2609 }, | |
2610 "readGroupSetId": { | |
2611 "description": "The ID of the read group set this read belon
gs to. A read belongs to exactly one read group set.", | |
2612 "type": "string" | |
2613 }, | |
2614 "fragmentName": { | |
2615 "description": "The fragment name. Equivalent to QNAME (quer
y template name) in SAM.", | |
2616 "type": "string" | |
2617 }, | 2629 }, |
2618 "properPlacement": { | 2630 "properPlacement": { |
2619 "description": "The orientation and the distance between rea
ds from the fragment are consistent with the sequencing protocol (SAM flag 0x2).
", | 2631 "description": "The orientation and the distance between rea
ds from the fragment are\nconsistent with the sequencing protocol (SAM flag 0x2)
.", |
2620 "type": "boolean" | 2632 "type": "boolean" |
2621 }, | 2633 }, |
2622 "duplicateFragment": { | 2634 "supplementaryAlignment": { |
2623 "description": "The fragment is a PCR or optical duplicate (
SAM flag 0x400).", | 2635 "description": "Whether this alignment is supplementary. Equ
ivalent to SAM flag 0x800.\nSupplementary alignments are used in the representat
ion of a chimeric\nalignment. In a chimeric alignment, a read is split into mult
iple\nlinear alignments that map to different reference contigs. The first\nline
ar alignment in the read will be designated as the representative\nalignment; th
e remaining linear alignments will be designated as\nsupplementary alignments. T
hese alignments may have different mapping\nquality scores. In each linear align
ment in a chimeric alignment, the read\nwill be hard clipped. The `alignedSequen
ce` and\n`alignedQuality` fields in the alignment record will only\nrepresent th
e bases for its respective linear alignment.", |
2624 "type": "boolean" | 2636 "type": "boolean" |
2625 }, | 2637 }, |
2626 "fragmentLength": { | 2638 "fragmentLength": { |
2627 "description": "The observed length of the fragment, equival
ent to TLEN in SAM.", | 2639 "description": "The observed length of the fragment, equival
ent to TLEN in SAM.", |
2628 "format": "int32", | 2640 "format": "int32", |
2629 "type": "integer" | 2641 "type": "integer" |
2630 }, | 2642 }, |
2631 "readNumber": { | 2643 "failedVendorQualityChecks": { |
2632 "description": "The read number in sequencing. 0-based and l
ess than numberReads. This field replaces SAM flag 0x40 and 0x80.", | 2644 "description": "Whether this read did not pass filters, such
as platform or vendor quality\ncontrols (SAM flag 0x200).", |
2633 "format": "int32", | 2645 "type": "boolean" |
2634 "type": "integer" | 2646 }, |
| 2647 "alignedQuality": { |
| 2648 "description": "The quality of the read sequence contained i
n this alignment record\n(equivalent to QUAL in SAM).\n`alignedSequence` and `al
ignedQuality` may be shorter than the full read\nsequence and quality. This will
occur if the alignment is part of a\nchimeric alignment, or if the read was tri
mmed. When this occurs, the CIGAR\nfor this read will begin/end with a hard clip
operator that will indicate\nthe length of the excised sequence.", |
| 2649 "items": { |
| 2650 "format": "int32", |
| 2651 "type": "integer" |
| 2652 }, |
| 2653 "type": "array" |
| 2654 }, |
| 2655 "alignment": { |
| 2656 "$ref": "LinearAlignment", |
| 2657 "description": "The linear alignment for this alignment reco
rd. This field is null for\nunmapped reads." |
| 2658 }, |
| 2659 "id": { |
| 2660 "description": "The server-generated read ID, unique across
all reads. This is different\nfrom the `fragmentName`.", |
| 2661 "type": "string" |
2635 }, | 2662 }, |
2636 "numberReads": { | 2663 "numberReads": { |
2637 "description": "The number of reads in the fragment (extensi
on to SAM flag 0x1).", | 2664 "description": "The number of reads in the fragment (extensi
on to SAM flag 0x1).", |
2638 "format": "int32", | 2665 "format": "int32", |
2639 "type": "integer" | 2666 "type": "integer" |
2640 }, | 2667 }, |
2641 "failedVendorQualityChecks": { | 2668 "secondaryAlignment": { |
2642 "description": "Whether this read did not pass filters, such
as platform or vendor quality controls (SAM flag 0x200).", | 2669 "description": "Whether this alignment is secondary. Equival
ent to SAM flag 0x100.\nA secondary alignment represents an alternative to the p
rimary alignment\nfor this read. Aligners may return secondary alignments if a r
ead can map\nambiguously to multiple coordinates in the genome. By convention, e
ach read\nhas one and only one alignment where both `secondaryAlignment`\nand `s
upplementaryAlignment` are false.", |
2643 "type": "boolean" | 2670 "type": "boolean" |
2644 }, | 2671 }, |
2645 "alignment": { | 2672 "fragmentName": { |
2646 "$ref": "LinearAlignment", | 2673 "description": "The fragment name. Equivalent to QNAME (quer
y template name) in SAM.", |
2647 "description": "The linear alignment for this alignment reco
rd. This field is null for unmapped reads." | 2674 "type": "string" |
2648 }, | 2675 }, |
2649 "secondaryAlignment": { | 2676 "readGroupSetId": { |
2650 "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 `supple
mentaryAlignment` are false.", | 2677 "description": "The ID of the read group set this read belon
gs to. A read belongs to\nexactly one read group set.", |
| 2678 "type": "string" |
| 2679 }, |
| 2680 "duplicateFragment": { |
| 2681 "description": "The fragment is a PCR or optical duplicate (
SAM flag 0x400).", |
2651 "type": "boolean" | 2682 "type": "boolean" |
2652 }, | 2683 }, |
2653 "supplementaryAlignment": { | 2684 "readNumber": { |
2654 "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
`alignedQuality` fields in the alignment record will only represent the bases fo
r its respective linear alignment.", | 2685 "description": "The read number in sequencing. 0-based and l
ess than numberReads. This\nfield replaces SAM flag 0x40 and 0x80.", |
2655 "type": "boolean" | 2686 "format": "int32", |
| 2687 "type": "integer" |
| 2688 }, |
| 2689 "readGroupId": { |
| 2690 "description": "The ID of the read group this read belongs t
o. A read belongs to exactly\none read group. This is a server-generated ID whic
h is distinct from SAM's\nRG tag (for that value, see\nReadGroup.name).", |
| 2691 "type": "string" |
2656 }, | 2692 }, |
2657 "alignedSequence": { | 2693 "alignedSequence": { |
2658 "description": "The bases of the read sequence contained in
this alignment record, **without CIGAR operations applied** (equivalent to SEQ i
n SAM). `alignedSequence` and `alignedQuality` may be shorter than the full read
sequence and quality. This will occur if the alignment is part of a chimeric al
ignment, or if the read was trimmed. When this occurs, the CIGAR for this read w
ill begin/end with a hard clip operator that will indicate the length of the exc
ised sequence.", | 2694 "description": "The bases of the read sequence contained in
this alignment record,\n**without CIGAR operations applied** (equivalent to SEQ
in SAM).\n`alignedSequence` and `alignedQuality` may be\nshorter than the full r
ead sequence and quality. This will occur if the\nalignment is part of a chimeri
c alignment, or if the read was trimmed. When\nthis occurs, the CIGAR for this r
ead will begin/end with a hard clip\noperator that will indicate the length of t
he excised sequence.", |
2659 "type": "string" | 2695 "type": "string" |
2660 }, | |
2661 "alignedQuality": { | |
2662 "description": "The quality of the read sequence contained i
n this alignment record (equivalent to QUAL in SAM). `alignedSequence` and `alig
nedQuality` may be shorter than the full read sequence and quality. This will oc
cur 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 oper
ator that will indicate the length of the excised sequence.", | |
2663 "items": { | |
2664 "format": "int32", | |
2665 "type": "integer" | |
2666 }, | |
2667 "type": "array" | |
2668 }, | |
2669 "nextMatePosition": { | |
2670 "$ref": "Position", | |
2671 "description": "The mapping of the primary alignment of the
`(readNumber+1)%numberReads` read in the fragment. It replaces mate position and
mate strand in SAM." | |
2672 }, | |
2673 "info": { | |
2674 "additionalProperties": { | |
2675 "items": { | |
2676 "type": "any" | |
2677 }, | |
2678 "type": "array" | |
2679 }, | |
2680 "description": "A map of additional read alignment informati
on. This must be of the form map (string key mapping to a list of string values)
.", | |
2681 "type": "object" | |
2682 } | 2696 } |
2683 }, | 2697 }, |
2684 "type": "object" | 2698 "type": "object" |
2685 }, | 2699 }, |
2686 "LinearAlignment": { | 2700 "ReferenceSet": { |
2687 "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.", | 2701 "description": "A reference set is a set of references which typical
ly comprise a reference\nassembly for a species, such as `GRCh38` which is repre
sentative\nof the human genome. A reference set defines a common coordinate spac
e for\ncomparing reference-aligned experimental data. A reference set contains 1
or\nmore references.\n\nFor more genomics resource definitions, see [Fundamenta
ls of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google
-genomics)", |
2688 "id": "LinearAlignment", | 2702 "id": "ReferenceSet", |
2689 "properties": { | 2703 "properties": { |
2690 "position": { | 2704 "referenceIds": { |
2691 "$ref": "Position", | 2705 "description": "The IDs of the reference objects that are pa
rt of this set.\n`Reference.md5checksum` must be unique within this set.", |
2692 "description": "The position of this alignment." | 2706 "items": { |
| 2707 "type": "string" |
| 2708 }, |
| 2709 "type": "array" |
2693 }, | 2710 }, |
2694 "mappingQuality": { | 2711 "assemblyId": { |
2695 "description": "The mapping quality of this alignment. Repre
sents how likely the read maps to this position as opposed to other locations. S
pecifically, this is -10 log10 Pr(mapping position is wrong), rounded to the nea
rest integer.", | 2712 "description": "Public id of this reference set, such as `GR
Ch37`.", |
| 2713 "type": "string" |
| 2714 }, |
| 2715 "md5checksum": { |
| 2716 "description": "Order-independent MD5 checksum which identif
ies this reference set. The\nchecksum is computed by sorting all lower case hexi
decimal string\n`reference.md5checksum` (for all reference in this set) in\nasce
nding lexicographic order, concatenating, and taking the MD5 of that\nvalue. The
resulting value is represented in lower case hexadecimal format.", |
| 2717 "type": "string" |
| 2718 }, |
| 2719 "id": { |
| 2720 "description": "The server-generated reference set ID, uniqu
e across all reference sets.", |
| 2721 "type": "string" |
| 2722 }, |
| 2723 "description": { |
| 2724 "description": "Free text description of this reference set.
", |
| 2725 "type": "string" |
| 2726 }, |
| 2727 "sourceAccessions": { |
| 2728 "description": "All known corresponding accession IDs in INS
DC (GenBank/ENA/DDBJ) ideally\nwith a version number, for example `NC_000001.11`
.", |
| 2729 "items": { |
| 2730 "type": "string" |
| 2731 }, |
| 2732 "type": "array" |
| 2733 }, |
| 2734 "ncbiTaxonId": { |
| 2735 "description": "ID from http://www.ncbi.nlm.nih.gov/taxonomy
(for example, 9606 for human)\nindicating the species which this reference set
is intended to model. Note\nthat contained references may specify a different `n
cbiTaxonId`, as\nassemblies may contain reference sequences which do not belong
to the\nmodeled species, for example EBV in a human reference genome.", |
2696 "format": "int32", | 2736 "format": "int32", |
2697 "type": "integer" | 2737 "type": "integer" |
2698 }, | 2738 }, |
2699 "cigar": { | 2739 "sourceUri": { |
2700 "description": "Represents the local alignment of this seque
nce (alignment matches, indels, etc) against the reference.", | 2740 "description": "The URI from which the references were obtai
ned.", |
2701 "items": { | 2741 "type": "string" |
2702 "$ref": "CigarUnit" | |
2703 }, | |
2704 "type": "array" | |
2705 } | 2742 } |
2706 }, | 2743 }, |
2707 "type": "object" | 2744 "type": "object" |
2708 }, | |
2709 "Position": { | |
2710 "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.", | |
2711 "id": "Position", | |
2712 "properties": { | |
2713 "referenceName": { | |
2714 "description": "The name of the reference in whatever refere
nce set is being used.", | |
2715 "type": "string" | |
2716 }, | |
2717 "position": { | |
2718 "description": "The 0-based offset from the start of the for
ward strand for that reference.", | |
2719 "format": "int64", | |
2720 "type": "string" | |
2721 }, | |
2722 "reverseStrand": { | |
2723 "description": "Whether this position is on the reverse stra
nd, as opposed to the forward strand.", | |
2724 "type": "boolean" | |
2725 } | |
2726 }, | |
2727 "type": "object" | |
2728 }, | 2745 }, |
2729 "CigarUnit": { | 2746 "CigarUnit": { |
2730 "description": "A single CIGAR operation.", | 2747 "description": "A single CIGAR operation.", |
2731 "id": "CigarUnit", | 2748 "id": "CigarUnit", |
2732 "properties": { | 2749 "properties": { |
| 2750 "referenceSequence": { |
| 2751 "description": "`referenceSequence` is only used at mismatch
es\n(`SEQUENCE_MISMATCH`) and deletions (`DELETE`).\nFilling this field replaces
SAM's MD tag. If the relevant information is\nnot available, this field is unse
t.", |
| 2752 "type": "string" |
| 2753 }, |
| 2754 "operationLength": { |
| 2755 "description": "The number of genomic bases that the operati
on runs for. Required.", |
| 2756 "format": "int64", |
| 2757 "type": "string" |
| 2758 }, |
2733 "operation": { | 2759 "operation": { |
2734 "enum": [ | 2760 "enum": [ |
2735 "OPERATION_UNSPECIFIED", | 2761 "OPERATION_UNSPECIFIED", |
2736 "ALIGNMENT_MATCH", | 2762 "ALIGNMENT_MATCH", |
2737 "INSERT", | 2763 "INSERT", |
2738 "DELETE", | 2764 "DELETE", |
2739 "SKIP", | 2765 "SKIP", |
2740 "CLIP_SOFT", | 2766 "CLIP_SOFT", |
2741 "CLIP_HARD", | 2767 "CLIP_HARD", |
2742 "PAD", | 2768 "PAD", |
2743 "SEQUENCE_MATCH", | 2769 "SEQUENCE_MATCH", |
2744 "SEQUENCE_MISMATCH" | 2770 "SEQUENCE_MISMATCH" |
2745 ], | 2771 ], |
2746 "type": "string" | 2772 "enumDescriptions": [ |
2747 }, | 2773 "", |
2748 "operationLength": { | 2774 "An alignment match indicates that a sequence can be ali
gned to the\nreference without evidence of an INDEL. Unlike the\n`SEQUENCE_MATCH
` and `SEQUENCE_MISMATCH` operators,\nthe `ALIGNMENT_MATCH` operator does not in
dicate whether the\nreference and read sequences are an exact match. This operat
or is\nequivalent to SAM's `M`.", |
2749 "description": "The number of genomic bases that the operati
on runs for. Required.", | 2775 "The insert operator indicates that the read contains ev
idence of bases\nbeing inserted into the reference. This operator is equivalent
to SAM's\n`I`.", |
2750 "format": "int64", | 2776 "The delete operator indicates that the read contains ev
idence of bases\nbeing deleted from the reference. This operator is equivalent t
o SAM's\n`D`.", |
2751 "type": "string" | 2777 "The skip operator indicates that this read skips a long
segment of the\nreference, but the bases have not been deleted. This operator i
s commonly\nused when working with RNA-seq data, where reads may skip long segme
nts\nof the reference between exons. This operator is equivalent to SAM's\n`N`."
, |
2752 }, | 2778 "The soft clip operator indicates that bases at the star
t/end of a read\nhave not been considered during alignment. This may occur if th
e majority\nof a read maps, except for low quality bases at the start/end of a r
ead.\nThis operator is equivalent to SAM's `S`. Bases that are soft\nclipped wil
l still be stored in the read.", |
2753 "referenceSequence": { | 2779 "The hard clip operator indicates that bases at the star
t/end of a read\nhave been omitted from this alignment. This may occur if this l
inear\nalignment is part of a chimeric alignment, or if the read has been\ntrimm
ed (for example, during error correction or to trim poly-A tails for\nRNA-seq).
This operator is equivalent to SAM's `H`.", |
2754 "description": "`referenceSequence` is only used at mismatch
es (`SEQUENCE_MISMATCH`) and deletions (`DELETE`). Filling this field replaces S
AM's MD tag. If the relevant information is not available, this field is unset."
, | 2780 "The pad operator indicates that there is padding in an
alignment. This\noperator is equivalent to SAM's `P`.", |
| 2781 "This operator indicates that this portion of the aligne
d sequence exactly\nmatches the reference. This operator is equivalent to SAM's
`=`.", |
| 2782 "This operator indicates that this portion of the aligne
d sequence is an\nalignment match to the reference, but a sequence mismatch. Thi
s can\nindicate a SNP or a read error. This operator is equivalent to SAM's\n`X`
." |
| 2783 ], |
2755 "type": "string" | 2784 "type": "string" |
2756 } | 2785 } |
2757 }, | 2786 }, |
2758 "type": "object" | 2787 "type": "object" |
2759 }, | 2788 }, |
2760 "StreamReadsRequest": { | 2789 "Transcript": { |
2761 "description": "The stream reads request.", | 2790 "description": "A transcript represents the assertion that a particu
lar region of the\nreference genome may be transcribed as RNA.", |
2762 "id": "StreamReadsRequest", | 2791 "id": "Transcript", |
2763 "properties": { | 2792 "properties": { |
2764 "projectId": { | 2793 "exons": { |
2765 "description": "The Google Cloud project ID which will be bi
lled for this access. The caller must have WRITE access to this project. Require
d.", | 2794 "description": "The <a href=\"http://en.wikipedia.org/wiki/E
xon\">exons</a> that compose\nthis transcript. This field should be unset for ge
nomes where transcript\nsplicing does not occur, for example prokaryotes.\n\nInt
rons are regions of the transcript that are not included in the\nspliced RNA pro
duct. Though not explicitly modeled here, intron ranges can\nbe deduced; all reg
ions of this transcript that are not exons are introns.\n\nExonic sequences do n
ot necessarily code for a translational product\n(amino acids). Only the regions
of exons bounded by the\ncodingSequence correspond\nto coding DNA sequence.\n\n
Exons are ordered by start position and may not overlap.", |
| 2795 "items": { |
| 2796 "$ref": "Exon" |
| 2797 }, |
| 2798 "type": "array" |
| 2799 }, |
| 2800 "codingSequence": { |
| 2801 "$ref": "CodingSequence", |
| 2802 "description": "The range of the coding sequence for this tr
anscript, if any. To determine\nthe exact ranges of coding sequence, intersect t
his range with those of the\nexons, if any. If there are any\nexons, the\ncoding
Sequence must start\nand end within them.\n\nNote that in some cases, the refere
nce genome will not exactly match the\nobserved mRNA transcript e.g. due to vari
ance in the source genome from\nreference. In these cases,\nexon.frame will not
necessarily\nmatch the expected reference reading frame and coding exon referenc
e bases\ncannot necessarily be concatenated to produce the original transcript m
RNA." |
| 2803 }, |
| 2804 "geneId": { |
| 2805 "description": "The annotation ID of the gene from which thi
s transcript is transcribed.", |
2766 "type": "string" | 2806 "type": "string" |
2767 }, | |
2768 "readGroupSetId": { | |
2769 "description": "The ID of the read group set from which to s
tream reads.", | |
2770 "type": "string" | |
2771 }, | |
2772 "referenceName": { | |
2773 "description": "The reference sequence name, for example `ch
r1`, `1`, or `chrX`. If set to *, only unmapped reads are returned.", | |
2774 "type": "string" | |
2775 }, | |
2776 "start": { | |
2777 "description": "The start position of the range on the refer
ence, 0-based inclusive. If specified, `referenceName` must also be specified.", | |
2778 "format": "int64", | |
2779 "type": "string" | |
2780 }, | |
2781 "end": { | |
2782 "description": "The end position of the range on the referen
ce, 0-based exclusive. If specified, `referenceName` must also be specified.", | |
2783 "format": "int64", | |
2784 "type": "string" | |
2785 }, | |
2786 "shard": { | |
2787 "description": "Restricts results to a shard containing appr
oximately `1/totalShards` of the normal response payload for this query. Results
from a sharded request are disjoint from those returned by all queries which di
ffer only in their shard parameter. A shard may yield 0 results; this is especia
lly likely for large values of `totalShards`. Valid values are `[0, totalShards)
`.", | |
2788 "format": "int32", | |
2789 "type": "integer" | |
2790 }, | |
2791 "totalShards": { | |
2792 "description": "Specifying `totalShards` causes a disjoint s
ubset of the normal response payload to be returned for each query with a unique
`shard` parameter specified. A best effort is made to yield equally sized shard
s. Sharding can be used to distribute processing amongst workers, where each wor
ker is assigned a unique `shard` number and all workers specify the same `totalS
hards` number. The union of reads returned for all sharded queries `[0, totalSha
rds)` is equal to those returned by a single unsharded query. Queries for differ
ent values of `totalShards` with common divisors will share shard boundaries. Fo
r example, streaming `shard` 2 of 5 `totalShards` yields the same results as str
eaming `shard`s 4 and 5 of 10 `totalShards`. This property can be leveraged for
adaptive retries.", | |
2793 "format": "int32", | |
2794 "type": "integer" | |
2795 } | 2807 } |
2796 }, | 2808 }, |
2797 "type": "object" | 2809 "type": "object" |
2798 }, | 2810 }, |
2799 "StreamReadsResponse": { | 2811 "AnnotationSet": { |
2800 "id": "StreamReadsResponse", | 2812 "description": "An annotation set is a logical grouping of annotatio
ns that share consistent\ntype information and provenance. Examples of annotatio
n sets include 'all\ngenes from refseq', and 'all variant annotations from ClinV
ar'.", |
| 2813 "id": "AnnotationSet", |
2801 "properties": { | 2814 "properties": { |
2802 "alignments": { | 2815 "datasetId": { |
| 2816 "description": "The dataset to which this annotation set bel
ongs.", |
| 2817 "type": "string" |
| 2818 }, |
| 2819 "sourceUri": { |
| 2820 "description": "The source URI describing the file from whic
h this annotation set was\ngenerated, if any.", |
| 2821 "type": "string" |
| 2822 }, |
| 2823 "name": { |
| 2824 "description": "The display name for this annotation set.", |
| 2825 "type": "string" |
| 2826 }, |
| 2827 "referenceSetId": { |
| 2828 "description": "The ID of the reference set that defines the
coordinate space for this\nset's annotations.", |
| 2829 "type": "string" |
| 2830 }, |
| 2831 "type": { |
| 2832 "description": "The type of annotations contained within thi
s set.", |
| 2833 "enum": [ |
| 2834 "ANNOTATION_TYPE_UNSPECIFIED", |
| 2835 "GENERIC", |
| 2836 "VARIANT", |
| 2837 "GENE", |
| 2838 "TRANSCRIPT" |
| 2839 ], |
| 2840 "enumDescriptions": [ |
| 2841 "", |
| 2842 "A `GENERIC` annotation type should be used when no othe
r annotation\ntype will suffice. This represents an untyped annotation of the re
ference\ngenome.", |
| 2843 "A `VARIANT` annotation type.", |
| 2844 "A `GENE` annotation type represents the existence of a
gene at the\nassociated reference coordinates. The start coordinate is typically
the\ngene's transcription start site and the end is typically the end of the\ng
ene's last exon.", |
| 2845 "A `TRANSCRIPT` annotation type represents the assertion
that a\nparticular region of the reference genome may be transcribed as RNA." |
| 2846 ], |
| 2847 "type": "string" |
| 2848 }, |
| 2849 "info": { |
| 2850 "additionalProperties": { |
| 2851 "items": { |
| 2852 "type": "any" |
| 2853 }, |
| 2854 "type": "array" |
| 2855 }, |
| 2856 "description": "A map of additional read alignment informati
on. This must be of the form\nmap<string, string[]> (string key mapping to a lis
t of string values).", |
| 2857 "type": "object" |
| 2858 }, |
| 2859 "id": { |
| 2860 "description": "The server-generated annotation set ID, uniq
ue across all annotation sets.", |
| 2861 "type": "string" |
| 2862 } |
| 2863 }, |
| 2864 "type": "object" |
| 2865 }, |
| 2866 "Experiment": { |
| 2867 "id": "Experiment", |
| 2868 "properties": { |
| 2869 "platformUnit": { |
| 2870 "description": "The platform unit used as part of this exper
iment, for example\nflowcell-barcode.lane for Illumina or slide for SOLiD. Corre
sponds to the\n@RG PU field in the SAM spec.", |
| 2871 "type": "string" |
| 2872 }, |
| 2873 "libraryId": { |
| 2874 "description": "A client-supplied library identifier; a libr
ary is a collection of DNA\nfragments which have been prepared for sequencing fr
om a sample. This\nfield is important for quality control as error or bias can b
e introduced\nduring sample preparation.", |
| 2875 "type": "string" |
| 2876 }, |
| 2877 "instrumentModel": { |
| 2878 "description": "The instrument model used as part of this ex
periment. This maps to\nsequencing technology in the SAM spec.", |
| 2879 "type": "string" |
| 2880 }, |
| 2881 "sequencingCenter": { |
| 2882 "description": "The sequencing center used as part of this e
xperiment.", |
| 2883 "type": "string" |
| 2884 } |
| 2885 }, |
| 2886 "type": "object" |
| 2887 }, |
| 2888 "ListDatasetsResponse": { |
| 2889 "description": "The dataset list response.", |
| 2890 "id": "ListDatasetsResponse", |
| 2891 "properties": { |
| 2892 "datasets": { |
| 2893 "description": "The list of matching Datasets.", |
2803 "items": { | 2894 "items": { |
2804 "$ref": "Read" | 2895 "$ref": "Dataset" |
| 2896 }, |
| 2897 "type": "array" |
| 2898 }, |
| 2899 "nextPageToken": { |
| 2900 "description": "The continuation token, which is used to pag
e through large result sets.\nProvide this value in a subsequent request to retu
rn the next page of\nresults. This field will be empty if there aren't any addit
ional results.", |
| 2901 "type": "string" |
| 2902 } |
| 2903 }, |
| 2904 "type": "object" |
| 2905 }, |
| 2906 "TestIamPermissionsRequest": { |
| 2907 "description": "Request message for `TestIamPermissions` method.", |
| 2908 "id": "TestIamPermissionsRequest", |
| 2909 "properties": { |
| 2910 "permissions": { |
| 2911 "description": "REQUIRED: The set of permissions to check fo
r the 'resource'.\nPermissions with wildcards (such as '*' or 'storage.*') are n
ot allowed.\nAllowed permissions are:\n\n* `genomics.datasets.create`\n* `ge
nomics.datasets.delete`\n* `genomics.datasets.get`\n* `genomics.datasets.list`\n
* `genomics.datasets.update`\n* `genomics.datasets.getIamPolicy`\n* `genomics.da
tasets.setIamPolicy`", |
| 2912 "items": { |
| 2913 "type": "string" |
2805 }, | 2914 }, |
2806 "type": "array" | 2915 "type": "array" |
2807 } | 2916 } |
2808 }, | 2917 }, |
2809 "type": "object" | 2918 "type": "object" |
2810 }, | 2919 }, |
2811 "SearchReferenceSetsRequest": { | 2920 "ExportReadGroupSetRequest": { |
2812 "id": "SearchReferenceSetsRequest", | 2921 "description": "The read group set export request.", |
| 2922 "id": "ExportReadGroupSetRequest", |
2813 "properties": { | 2923 "properties": { |
2814 "md5checksums": { | 2924 "projectId": { |
2815 "description": "If present, return reference sets for which
the md5checksum matches exactly.", | 2925 "description": "Required. The Google Cloud project ID that o
wns this\nexport. The caller must have WRITE access to this project.", |
| 2926 "type": "string" |
| 2927 }, |
| 2928 "exportUri": { |
| 2929 "description": "Required. A Google Cloud Storage URI for the
exported BAM file.\nThe currently authenticated user must have write access to
the new file.\nAn error will be returned if the URI already contains data.", |
| 2930 "type": "string" |
| 2931 }, |
| 2932 "referenceNames": { |
| 2933 "description": "The reference names to export. If this is no
t specified, all reference\nsequences, including unmapped reads, are exported.\n
Use `*` to export only unmapped reads.", |
2816 "items": { | 2934 "items": { |
2817 "type": "string" | 2935 "type": "string" |
2818 }, | 2936 }, |
2819 "type": "array" | |
2820 }, | |
2821 "accessions": { | |
2822 "description": "If present, return reference sets for which
a prefix of any of sourceAccessions match any of these strings. Accession number
s typically have a main number and a version, for example `NC_000001.11`.", | |
2823 "items": { | |
2824 "type": "string" | |
2825 }, | |
2826 "type": "array" | |
2827 }, | |
2828 "assemblyId": { | |
2829 "description": "If present, return reference sets for which
a substring of their `assemblyId` matches this string (case insensitive).", | |
2830 "type": "string" | |
2831 }, | |
2832 "pageToken": { | |
2833 "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.", | |
2834 "type": "string" | |
2835 }, | |
2836 "pageSize": { | |
2837 "description": "The maximum number of results to return in a
single page. If unspecified, defaults to 1024. The maximum value is 4096.", | |
2838 "format": "int32", | |
2839 "type": "integer" | |
2840 } | |
2841 }, | |
2842 "type": "object" | |
2843 }, | |
2844 "SearchReferenceSetsResponse": { | |
2845 "id": "SearchReferenceSetsResponse", | |
2846 "properties": { | |
2847 "referenceSets": { | |
2848 "description": "The matching references sets.", | |
2849 "items": { | |
2850 "$ref": "ReferenceSet" | |
2851 }, | |
2852 "type": "array" | |
2853 }, | |
2854 "nextPageToken": { | |
2855 "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.", | |
2856 "type": "string" | |
2857 } | |
2858 }, | |
2859 "type": "object" | |
2860 }, | |
2861 "ReferenceSet": { | |
2862 "description": "A reference set is a set of references which typical
ly comprise a reference assembly for a species, such as `GRCh38` which is repres
entative of the human genome. A reference set defines a common coordinate space
for comparing reference-aligned experimental data. A reference set contains 1 or
more references. For more genomics resource definitions, see [Fundamentals of G
oogle Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomic
s)", | |
2863 "id": "ReferenceSet", | |
2864 "properties": { | |
2865 "id": { | |
2866 "description": "The server-generated reference set ID, uniqu
e across all reference sets.", | |
2867 "type": "string" | |
2868 }, | |
2869 "referenceIds": { | |
2870 "description": "The IDs of the reference objects that are pa
rt of this set. `Reference.md5checksum` must be unique within this set.", | |
2871 "items": { | |
2872 "type": "string" | |
2873 }, | |
2874 "type": "array" | |
2875 }, | |
2876 "md5checksum": { | |
2877 "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 ascendi
ng lexicographic order, concatenating, and taking the MD5 of that value. The res
ulting value is represented in lower case hexadecimal format.", | |
2878 "type": "string" | |
2879 }, | |
2880 "ncbiTaxonId": { | |
2881 "description": "ID from http://www.ncbi.nlm.nih.gov/taxonomy
(for example, 9606 for human) indicating the species which this reference set i
s intended to model. Note that contained references may specify a different `ncb
iTaxonId`, as assemblies may contain reference sequences which do not belong to
the modeled species, for example EBV in a human reference genome.", | |
2882 "format": "int32", | |
2883 "type": "integer" | |
2884 }, | |
2885 "description": { | |
2886 "description": "Free text description of this reference set.
", | |
2887 "type": "string" | |
2888 }, | |
2889 "assemblyId": { | |
2890 "description": "Public id of this reference set, such as `GR
Ch37`.", | |
2891 "type": "string" | |
2892 }, | |
2893 "sourceUri": { | |
2894 "description": "The URI from which the references were obtai
ned.", | |
2895 "type": "string" | |
2896 }, | |
2897 "sourceAccessions": { | |
2898 "description": "All known corresponding accession IDs in INS
DC (GenBank/ENA/DDBJ) ideally with a version number, for example `NC_000001.11`.
", | |
2899 "items": { | |
2900 "type": "string" | |
2901 }, | |
2902 "type": "array" | 2937 "type": "array" |
2903 } | 2938 } |
2904 }, | 2939 }, |
2905 "type": "object" | 2940 "type": "object" |
2906 }, | 2941 }, |
2907 "SearchReferencesRequest": { | 2942 "Exon": { |
2908 "id": "SearchReferencesRequest", | 2943 "id": "Exon", |
2909 "properties": { | 2944 "properties": { |
2910 "md5checksums": { | 2945 "start": { |
2911 "description": "If present, return references for which the
md5checksum matches exactly.", | 2946 "description": "The start position of the exon on this annot
ation's reference sequence,\n0-based inclusive. Note that this is relative to th
e reference start, and\n**not** the containing annotation start.", |
2912 "items": { | 2947 "format": "int64", |
2913 "type": "string" | |
2914 }, | |
2915 "type": "array" | |
2916 }, | |
2917 "accessions": { | |
2918 "description": "If present, return references for which a pr
efix of any of sourceAccessions match any of these strings. Accession numbers ty
pically have a main number and a version, for example `GCF_000001405.26`.", | |
2919 "items": { | |
2920 "type": "string" | |
2921 }, | |
2922 "type": "array" | |
2923 }, | |
2924 "referenceSetId": { | |
2925 "description": "If present, return only references which bel
ong to this reference set.", | |
2926 "type": "string" | 2948 "type": "string" |
2927 }, | 2949 }, |
2928 "pageToken": { | 2950 "end": { |
2929 "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.", | 2951 "description": "The end position of the exon on this annotat
ion's reference sequence,\n0-based exclusive. Note that this is relative to the
reference start, and\n*not* the containing annotation start.", |
| 2952 "format": "int64", |
2930 "type": "string" | 2953 "type": "string" |
2931 }, | 2954 }, |
2932 "pageSize": { | 2955 "frame": { |
2933 "description": "The maximum number of results to return in a
single page. If unspecified, defaults to 1024. The maximum value is 4096.", | 2956 "description": "The frame of this exon. Contains a value of
0, 1, or 2, which indicates\nthe offset of the first coding base of the exon wit
hin the reading frame\nof the coding DNA sequence, if any. This field is depende
nt on the\nstrandedness of this annotation (see\nAnnotation.reverse_strand).\nFo
r forward stranded annotations, this offset is relative to the\nexon.start. For
reverse\nstrand annotations, this offset is relative to the\nexon.end `- 1`.\n\n
Unset if this exon does not intersect the coding sequence. Upon creation\nof a t
ranscript, the frame must be populated for all or none of the\ncoding exons.", |
2934 "format": "int32", | 2957 "format": "int32", |
2935 "type": "integer" | 2958 "type": "integer" |
2936 } | 2959 } |
2937 }, | 2960 }, |
2938 "type": "object" | 2961 "type": "object" |
2939 }, | 2962 }, |
2940 "SearchReferencesResponse": { | 2963 "CallSet": { |
2941 "id": "SearchReferencesResponse", | 2964 "description": "A call set is a collection of variant calls, typical
ly for one sample. It\nbelongs to a variant set.\n\nFor more genomics resource d
efinitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/geno
mics/fundamentals-of-google-genomics)", |
| 2965 "id": "CallSet", |
2942 "properties": { | 2966 "properties": { |
2943 "references": { | 2967 "info": { |
2944 "description": "The matching references.", | 2968 "additionalProperties": { |
| 2969 "items": { |
| 2970 "type": "any" |
| 2971 }, |
| 2972 "type": "array" |
| 2973 }, |
| 2974 "description": "A map of additional call set information. Th
is must be of the form\nmap<string, string[]> (string key mapping to a list of s
tring values).", |
| 2975 "type": "object" |
| 2976 }, |
| 2977 "variantSetIds": { |
| 2978 "description": "The IDs of the variant sets this call set be
longs to. This field must\nhave exactly length one, as a call set belongs to a s
ingle variant set.\nThis field is repeated for compatibility with the\n[GA4GH 0.
5.1\nAPI](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/v
ariants.avdl#L76).", |
2945 "items": { | 2979 "items": { |
2946 "$ref": "Reference" | 2980 "type": "string" |
2947 }, | 2981 }, |
2948 "type": "array" | 2982 "type": "array" |
2949 }, | 2983 }, |
2950 "nextPageToken": { | 2984 "id": { |
2951 "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.", | 2985 "description": "The server-generated call set ID, unique acr
oss all call sets.", |
| 2986 "type": "string" |
| 2987 }, |
| 2988 "created": { |
| 2989 "description": "The date this call set was created in millis
econds from the epoch.", |
| 2990 "format": "int64", |
| 2991 "type": "string" |
| 2992 }, |
| 2993 "sampleId": { |
| 2994 "description": "The sample ID this call set corresponds to."
, |
| 2995 "type": "string" |
| 2996 }, |
| 2997 "name": { |
| 2998 "description": "The call set name.", |
2952 "type": "string" | 2999 "type": "string" |
2953 } | 3000 } |
2954 }, | 3001 }, |
2955 "type": "object" | 3002 "type": "object" |
2956 }, | 3003 }, |
2957 "Reference": { | 3004 "SearchAnnotationSetsResponse": { |
2958 "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. For more genomics
resource definitions, see [Fundamentals of Google Genomics](https://cloud.googl
e.com/genomics/fundamentals-of-google-genomics)", | 3005 "id": "SearchAnnotationSetsResponse", |
2959 "id": "Reference", | |
2960 "properties": { | 3006 "properties": { |
2961 "id": { | 3007 "nextPageToken": { |
2962 "description": "The server-generated reference ID, unique ac
ross all references.", | 3008 "description": "The continuation token, which is used to pag
e through large result sets.\nProvide this value in a subsequent request to retu
rn the next page of\nresults. This field will be empty if there aren't any addit
ional results.", |
2963 "type": "string" | 3009 "type": "string" |
2964 }, | 3010 }, |
2965 "length": { | 3011 "annotationSets": { |
2966 "description": "The length of this reference's sequence.", | 3012 "description": "The matching annotation sets.", |
2967 "format": "int64", | |
2968 "type": "string" | |
2969 }, | |
2970 "md5checksum": { | |
2971 "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.", | |
2972 "type": "string" | |
2973 }, | |
2974 "name": { | |
2975 "description": "The name of this reference, for example `22`
.", | |
2976 "type": "string" | |
2977 }, | |
2978 "sourceUri": { | |
2979 "description": "The URI from which the sequence was obtained
. Typically specifies a FASTA format file.", | |
2980 "type": "string" | |
2981 }, | |
2982 "sourceAccessions": { | |
2983 "description": "All known corresponding accession IDs in INS
DC (GenBank/ENA/DDBJ) ideally with a version number, for example `GCF_000001405.
26`.", | |
2984 "items": { | 3013 "items": { |
2985 "type": "string" | 3014 "$ref": "AnnotationSet" |
2986 }, | 3015 }, |
2987 "type": "array" | 3016 "type": "array" |
2988 }, | |
2989 "ncbiTaxonId": { | |
2990 "description": "ID from http://www.ncbi.nlm.nih.gov/taxonomy
. For example, 9606 for human.", | |
2991 "format": "int32", | |
2992 "type": "integer" | |
2993 } | 3017 } |
2994 }, | 3018 }, |
2995 "type": "object" | 3019 "type": "object" |
2996 }, | |
2997 "ListBasesResponse": { | |
2998 "id": "ListBasesResponse", | |
2999 "properties": { | |
3000 "offset": { | |
3001 "description": "The offset position (0-based) of the given `
sequence` from the start of this `Reference`. This value will differ for each pa
ge in a paginated request.", | |
3002 "format": "int64", | |
3003 "type": "string" | |
3004 }, | |
3005 "sequence": { | |
3006 "description": "A substring of the bases that make up this r
eference.", | |
3007 "type": "string" | |
3008 }, | |
3009 "nextPageToken": { | |
3010 "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.", | |
3011 "type": "string" | |
3012 } | |
3013 }, | |
3014 "type": "object" | |
3015 }, | 3020 }, |
3016 "ImportVariantsRequest": { | 3021 "ImportVariantsRequest": { |
3017 "description": "The variant data import request.", | 3022 "description": "The variant data import request.", |
3018 "id": "ImportVariantsRequest", | 3023 "id": "ImportVariantsRequest", |
3019 "properties": { | 3024 "properties": { |
3020 "variantSetId": { | |
3021 "description": "Required. The variant set to which variant d
ata should be imported.", | |
3022 "type": "string" | |
3023 }, | |
3024 "sourceUris": { | |
3025 "description": "A list of URIs referencing variant files in
Google Cloud Storage. URIs can include wildcards [as described here](https://clo
ud.google.com/storage/docs/gsutil/addlhelp/WildcardNames). Note that recursive w
ildcards ('**') are not supported.", | |
3026 "items": { | |
3027 "type": "string" | |
3028 }, | |
3029 "type": "array" | |
3030 }, | |
3031 "format": { | |
3032 "description": "The format of the variant data being importe
d. If unspecified, defaults to to `VCF`.", | |
3033 "enum": [ | |
3034 "FORMAT_UNSPECIFIED", | |
3035 "FORMAT_VCF", | |
3036 "FORMAT_COMPLETE_GENOMICS" | |
3037 ], | |
3038 "type": "string" | |
3039 }, | |
3040 "normalizeReferenceNames": { | |
3041 "description": "Convert reference names to the canonical rep
resentation. hg19 haploytypes (those reference names containing \"_hap\") are no
t modified in any way. All other reference names are modified according to the f
ollowing rules: The reference name is capitalized. The \"chr\" prefix is dropped
for all autosomes and sex chromsomes. For example \"chr17\" becomes \"17\" and
\"chrX\" becomes \"X\". All mitochondrial chromosomes (\"chrM\", \"chrMT\", etc)
become \"MT\".", | |
3042 "type": "boolean" | |
3043 }, | |
3044 "infoMergeConfig": { | 3025 "infoMergeConfig": { |
3045 "additionalProperties": { | 3026 "additionalProperties": { |
3046 "enum": [ | 3027 "enum": [ |
3047 "INFO_MERGE_OPERATION_UNSPECIFIED", | 3028 "INFO_MERGE_OPERATION_UNSPECIFIED", |
3048 "IGNORE_NEW", | 3029 "IGNORE_NEW", |
3049 "MOVE_TO_CALLS" | 3030 "MOVE_TO_CALLS" |
3050 ], | 3031 ], |
3051 "type": "string" | 3032 "type": "string" |
3052 }, | 3033 }, |
3053 "description": "A mapping between info field keys and the In
foMergeOperations to be performed on them. This is plumbed down to the MergeVari
antRequests generated by the resulting import job.", | 3034 "description": "A mapping between info field keys and the In
foMergeOperations to\nbe performed on them. This is plumbed down to the MergeVar
iantRequests\ngenerated by the resulting import job.", |
3054 "type": "object" | 3035 "type": "object" |
3055 } | 3036 }, |
3056 }, | 3037 "variantSetId": { |
3057 "type": "object" | 3038 "description": "Required. The variant set to which variant d
ata should be imported.", |
3058 }, | |
3059 "VariantSet": { | |
3060 "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. For more genomics resource definitions, see [Fundamentals of Google G
enomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", | |
3061 "id": "VariantSet", | |
3062 "properties": { | |
3063 "datasetId": { | |
3064 "description": "The dataset to which this variant set belong
s.", | |
3065 "type": "string" | 3039 "type": "string" |
3066 }, | 3040 }, |
3067 "id": { | 3041 "sourceUris": { |
3068 "description": "The server-generated variant set ID, unique
across all variant sets.", | 3042 "description": "A list of URIs referencing variant files in
Google Cloud Storage. URIs can\ninclude wildcards [as described\nhere](https://c
loud.google.com/storage/docs/gsutil/addlhelp/WildcardNames).\nNote that recursiv
e wildcards ('**') are not supported.", |
3069 "type": "string" | |
3070 }, | |
3071 "referenceSetId": { | |
3072 "description": "The reference set to which the variant set i
s mapped. The reference set describes the alignment provenance of the variant se
t, while the `referenceBounds` describe the shape of the actual variant data. Th
e reference set's reference names are a superset of those found in the `referenc
eBounds`. For example, given a variant set that is mapped to the GRCh38 referenc
e set and contains a single variant on reference 'X', `referenceBounds` would co
ntain only an entry for 'X', while the associated reference set enumerates all p
ossible references: '1', '2', 'X', 'Y', 'MT', etc.", | |
3073 "type": "string" | |
3074 }, | |
3075 "referenceBounds": { | |
3076 "description": "A list of all references used by the variant
s in a variant set with associated coordinate upper bounds for each one.", | |
3077 "items": { | 3043 "items": { |
3078 "$ref": "ReferenceBound" | 3044 "type": "string" |
3079 }, | 3045 }, |
3080 "type": "array" | 3046 "type": "array" |
3081 }, | 3047 }, |
3082 "metadata": { | 3048 "normalizeReferenceNames": { |
3083 "description": "The metadata associated with this variant se
t.", | 3049 "description": "Convert reference names to the canonical rep
resentation.\nhg19 haploytypes (those reference names containing \"_hap\")\nare
not modified in any way.\nAll other reference names are modified according to th
e following rules:\nThe reference name is capitalized.\nThe \"chr\" prefix is dr
opped for all autosomes and sex chromsomes.\nFor example \"chr17\" becomes \"17\
" and \"chrX\" becomes \"X\".\nAll mitochondrial chromosomes (\"chrM\", \"chrMT\
", etc) become \"MT\".", |
3084 "items": { | 3050 "type": "boolean" |
3085 "$ref": "VariantSetMetadata" | |
3086 }, | |
3087 "type": "array" | |
3088 }, | 3051 }, |
3089 "name": { | 3052 "format": { |
3090 "description": "User-specified, mutable name.", | 3053 "description": "The format of the variant data being importe
d. If unspecified, defaults to\nto `VCF`.", |
3091 "type": "string" | 3054 "enum": [ |
3092 }, | 3055 "FORMAT_UNSPECIFIED", |
3093 "description": { | 3056 "FORMAT_VCF", |
3094 "description": "A textual description of this variant set.", | 3057 "FORMAT_COMPLETE_GENOMICS" |
| 3058 ], |
| 3059 "enumDescriptions": [ |
| 3060 "", |
| 3061 "VCF (Variant Call Format). The VCF files may be gzip co
mpressed. gVCF is\nalso supported.", |
| 3062 "Complete Genomics masterVarBeta format. The masterVarBe
ta files may\nbe bzip2 compressed." |
| 3063 ], |
3095 "type": "string" | 3064 "type": "string" |
3096 } | 3065 } |
3097 }, | 3066 }, |
3098 "type": "object" | 3067 "type": "object" |
3099 }, | 3068 }, |
3100 "ReferenceBound": { | 3069 "VariantAnnotation": { |
3101 "description": "ReferenceBound records an upper bound for the starti
ng coordinate of variants in a particular reference.", | 3070 "id": "VariantAnnotation", |
3102 "id": "ReferenceBound", | |
3103 "properties": { | 3071 "properties": { |
3104 "referenceName": { | 3072 "conditions": { |
3105 "description": "The name of the reference associated with th
is reference bound.", | 3073 "description": "The set of conditions associated with this v
ariant.\nA condition describes the way a variant influences human health.", |
| 3074 "items": { |
| 3075 "$ref": "ClinicalCondition" |
| 3076 }, |
| 3077 "type": "array" |
| 3078 }, |
| 3079 "effect": { |
| 3080 "description": "Effect of the variant on the coding sequence
.", |
| 3081 "enum": [ |
| 3082 "EFFECT_UNSPECIFIED", |
| 3083 "EFFECT_OTHER", |
| 3084 "FRAMESHIFT", |
| 3085 "FRAME_PRESERVING_INDEL", |
| 3086 "SYNONYMOUS_SNP", |
| 3087 "NONSYNONYMOUS_SNP", |
| 3088 "STOP_GAIN", |
| 3089 "STOP_LOSS", |
| 3090 "SPLICE_SITE_DISRUPTION" |
| 3091 ], |
| 3092 "enumDescriptions": [ |
| 3093 "", |
| 3094 "`EFFECT_OTHER` should be used when no other Effect\nwil
l suffice.", |
| 3095 "`FRAMESHIFT` indicates a mutation in which the insertio
n or\ndeletion of nucleotides resulted in a frameshift change.", |
| 3096 "`FRAME_PRESERVING_INDEL` indicates a mutation in which
a\nmultiple of three nucleotides has been inserted or deleted, resulting\nin no
change to the reading frame of the coding sequence.", |
| 3097 "`SYNONYMOUS_SNP` indicates a single nucleotide polymorp
hism\nmutation that results in no amino acid change.", |
| 3098 "`NONSYNONYMOUS_SNP` indicates a single nucleotide\npoly
morphism mutation that results in an amino acid change.", |
| 3099 "`STOP_GAIN` indicates a mutation that leads to the crea
tion\nof a stop codon at the variant site. Frameshift mutations creating\ndownst
ream stop codons do not count as `STOP_GAIN`.", |
| 3100 "`STOP_LOSS` indicates a mutation that eliminates a\nsto
p codon at the variant site.", |
| 3101 "`SPLICE_SITE_DISRUPTION` indicates that this variant is
\nfound in a splice site for the associated transcript, and alters the\nnormal s
plicing pattern." |
| 3102 ], |
3106 "type": "string" | 3103 "type": "string" |
3107 }, | 3104 }, |
3108 "upperBound": { | 3105 "transcriptIds": { |
3109 "description": "An upper bound (inclusive) on the starting c
oordinate of any variant in the reference sequence.", | 3106 "description": "Google annotation IDs of the transcripts aff
ected by this variant. These\nshould be provided when the variant is created.", |
| 3107 "items": { |
| 3108 "type": "string" |
| 3109 }, |
| 3110 "type": "array" |
| 3111 }, |
| 3112 "type": { |
| 3113 "description": "Type has been adapted from ClinVar's list of
variant types.", |
| 3114 "enum": [ |
| 3115 "TYPE_UNSPECIFIED", |
| 3116 "TYPE_OTHER", |
| 3117 "INSERTION", |
| 3118 "DELETION", |
| 3119 "SUBSTITUTION", |
| 3120 "SNP", |
| 3121 "STRUCTURAL", |
| 3122 "CNV" |
| 3123 ], |
| 3124 "enumDescriptions": [ |
| 3125 "", |
| 3126 "`TYPE_OTHER` should be used when no other Type will suf
fice.\nFurther explanation of the variant type may be included in the\ninfo fiel
d.", |
| 3127 "`INSERTION` indicates an insertion.", |
| 3128 "`DELETION` indicates a deletion.", |
| 3129 "`SUBSTITUTION` indicates a block substitution of\ntwo o
r more nucleotides.", |
| 3130 "`SNP` indicates a single nucleotide polymorphism.", |
| 3131 "`STRUCTURAL` indicates a large structural variant,\ninc
luding chromosomal fusions, inversions, etc.", |
| 3132 "`CNV` indicates a variation in copy number." |
| 3133 ], |
| 3134 "type": "string" |
| 3135 }, |
| 3136 "alternateBases": { |
| 3137 "description": "The alternate allele for this variant. If mu
ltiple alternate alleles\nexist at this location, create a separate variant for
each one, as they\nmay represent distinct conditions.", |
| 3138 "type": "string" |
| 3139 }, |
| 3140 "geneId": { |
| 3141 "description": "Google annotation ID of the gene affected by
this variant. This should\nbe provided when the variant is created.", |
| 3142 "type": "string" |
| 3143 }, |
| 3144 "clinicalSignificance": { |
| 3145 "description": "Describes the clinical significance of a var
iant.\nIt is adapted from the ClinVar controlled vocabulary for clinical\nsignif
icance described at:\nhttp://www.ncbi.nlm.nih.gov/clinvar/docs/clinsig/", |
| 3146 "enum": [ |
| 3147 "CLINICAL_SIGNIFICANCE_UNSPECIFIED", |
| 3148 "CLINICAL_SIGNIFICANCE_OTHER", |
| 3149 "UNCERTAIN", |
| 3150 "BENIGN", |
| 3151 "LIKELY_BENIGN", |
| 3152 "LIKELY_PATHOGENIC", |
| 3153 "PATHOGENIC", |
| 3154 "DRUG_RESPONSE", |
| 3155 "HISTOCOMPATIBILITY", |
| 3156 "CONFERS_SENSITIVITY", |
| 3157 "RISK_FACTOR", |
| 3158 "ASSOCIATION", |
| 3159 "PROTECTIVE", |
| 3160 "MULTIPLE_REPORTED" |
| 3161 ], |
| 3162 "enumDescriptions": [ |
| 3163 "", |
| 3164 "`OTHER` should be used when no other clinical significa
nce\nvalue will suffice.", |
| 3165 "", |
| 3166 "", |
| 3167 "", |
| 3168 "", |
| 3169 "", |
| 3170 "", |
| 3171 "", |
| 3172 "", |
| 3173 "", |
| 3174 "", |
| 3175 "", |
| 3176 "`MULTIPLE_REPORTED` should be used when multiple clinic
al\nsignficances are reported for a variant. The original clinical\nsignificance
values may be provided in the `info` field." |
| 3177 ], |
| 3178 "type": "string" |
| 3179 } |
| 3180 }, |
| 3181 "type": "object" |
| 3182 }, |
| 3183 "ListCoverageBucketsResponse": { |
| 3184 "id": "ListCoverageBucketsResponse", |
| 3185 "properties": { |
| 3186 "coverageBuckets": { |
| 3187 "description": "The coverage buckets. The list of buckets is
sparse; a bucket with 0\noverlapping reads is not returned. A bucket never cros
ses more than one\nreference sequence. Each bucket has width `bucketWidth`, unle
ss\nits end is the end of the reference sequence.", |
| 3188 "items": { |
| 3189 "$ref": "CoverageBucket" |
| 3190 }, |
| 3191 "type": "array" |
| 3192 }, |
| 3193 "nextPageToken": { |
| 3194 "description": "The continuation token, which is used to pag
e through large result sets.\nProvide this value in a subsequent request to retu
rn the next page of\nresults. This field will be empty if there aren't any addit
ional results.", |
| 3195 "type": "string" |
| 3196 }, |
| 3197 "bucketWidth": { |
| 3198 "description": "The length of each coverage bucket in base p
airs. Note that buckets at the\nend of a reference sequence may be shorter. This
value is omitted if the\nbucket width is infinity (the default behaviour, with
no range or\n`targetBucketWidth`).", |
3110 "format": "int64", | 3199 "format": "int64", |
3111 "type": "string" | 3200 "type": "string" |
3112 } | 3201 } |
3113 }, | 3202 }, |
3114 "type": "object" | 3203 "type": "object" |
3115 }, | |
3116 "VariantSetMetadata": { | |
3117 "description": "Metadata describes a single piece of variant call me
tadata. These data include a top level key and either a single value string (val
ue) or a list of key-value pairs (info.) Value and info are mutually exclusive."
, | |
3118 "id": "VariantSetMetadata", | |
3119 "properties": { | |
3120 "key": { | |
3121 "description": "The top-level key.", | |
3122 "type": "string" | |
3123 }, | |
3124 "value": { | |
3125 "description": "The value field for simple metadata", | |
3126 "type": "string" | |
3127 }, | |
3128 "id": { | |
3129 "description": "User-provided ID field, not enforced by this
API. Two or more pieces of structured metadata with identical id and key fields
are considered equivalent.", | |
3130 "type": "string" | |
3131 }, | |
3132 "type": { | |
3133 "description": "The type of data. Possible types include: In
teger, Float, Flag, Character, and String.", | |
3134 "enum": [ | |
3135 "TYPE_UNSPECIFIED", | |
3136 "INTEGER", | |
3137 "FLOAT", | |
3138 "FLAG", | |
3139 "CHARACTER", | |
3140 "STRING" | |
3141 ], | |
3142 "type": "string" | |
3143 }, | |
3144 "number": { | |
3145 "description": "The number of values that can be included in
a field described by this metadata.", | |
3146 "type": "string" | |
3147 }, | |
3148 "description": { | |
3149 "description": "A textual description of this metadata.", | |
3150 "type": "string" | |
3151 }, | |
3152 "info": { | |
3153 "additionalProperties": { | |
3154 "items": { | |
3155 "type": "any" | |
3156 }, | |
3157 "type": "array" | |
3158 }, | |
3159 "description": "Remaining structured metadata key-value pair
s. This must be of the form map (string key mapping to a list of string values).
", | |
3160 "type": "object" | |
3161 } | |
3162 }, | |
3163 "type": "object" | |
3164 }, | 3204 }, |
3165 "ExportVariantSetRequest": { | 3205 "ExportVariantSetRequest": { |
3166 "description": "The variant data export request.", | 3206 "description": "The variant data export request.", |
3167 "id": "ExportVariantSetRequest", | 3207 "id": "ExportVariantSetRequest", |
3168 "properties": { | 3208 "properties": { |
3169 "callSetIds": { | |
3170 "description": "If provided, only variant call information f
rom the specified call sets will be exported. By default all variant calls are e
xported.", | |
3171 "items": { | |
3172 "type": "string" | |
3173 }, | |
3174 "type": "array" | |
3175 }, | |
3176 "projectId": { | |
3177 "description": "Required. The Google Cloud project ID that o
wns the destination BigQuery dataset. The caller must have WRITE access to this
project. This project will also own the resulting export job.", | |
3178 "type": "string" | |
3179 }, | |
3180 "format": { | 3209 "format": { |
3181 "description": "The format for the exported data.", | 3210 "description": "The format for the exported data.", |
3182 "enum": [ | 3211 "enum": [ |
3183 "FORMAT_UNSPECIFIED", | 3212 "FORMAT_UNSPECIFIED", |
3184 "FORMAT_BIGQUERY" | 3213 "FORMAT_BIGQUERY" |
3185 ], | 3214 ], |
| 3215 "enumDescriptions": [ |
| 3216 "", |
| 3217 "Export the data to Google BigQuery." |
| 3218 ], |
3186 "type": "string" | 3219 "type": "string" |
3187 }, | 3220 }, |
3188 "bigqueryDataset": { | 3221 "bigqueryDataset": { |
3189 "description": "Required. The BigQuery dataset to export dat
a to. This dataset must already exist. Note that this is distinct from the Genom
ics concept of \"dataset\".", | 3222 "description": "Required. The BigQuery dataset to export dat
a to. This dataset must already\nexist. Note that this is distinct from the Geno
mics concept of \"dataset\".", |
3190 "type": "string" | 3223 "type": "string" |
3191 }, | 3224 }, |
3192 "bigqueryTable": { | 3225 "bigqueryTable": { |
3193 "description": "Required. The BigQuery table to export data
to. If the table doesn't exist, it will be created. If it already exists, it wil
l be overwritten.", | 3226 "description": "Required. The BigQuery table to export data
to.\nIf the table doesn't exist, it will be created. If it already exists, it\nw
ill be overwritten.", |
3194 "type": "string" | 3227 "type": "string" |
3195 } | 3228 }, |
3196 }, | 3229 "callSetIds": { |
3197 "type": "object" | 3230 "description": "If provided, only variant call information f
rom the specified call sets\nwill be exported. By default all variant calls are
exported.", |
3198 }, | 3231 "items": { |
3199 "SearchVariantSetsRequest": { | 3232 "type": "string" |
3200 "description": "The search variant sets request.", | 3233 }, |
3201 "id": "SearchVariantSetsRequest", | 3234 "type": "array" |
3202 "properties": { | 3235 }, |
| 3236 "projectId": { |
| 3237 "description": "Required. The Google Cloud project ID that o
wns the destination\nBigQuery dataset. The caller must have WRITE access to this
project. This\nproject will also own the resulting export job.", |
| 3238 "type": "string" |
| 3239 } |
| 3240 }, |
| 3241 "type": "object" |
| 3242 }, |
| 3243 "SearchAnnotationsRequest": { |
| 3244 "id": "SearchAnnotationsRequest", |
| 3245 "properties": { |
| 3246 "end": { |
| 3247 "description": "The end position of the range on the referen
ce, 0-based exclusive. If\nreferenceId or\nreferenceName\nmust be specified, Def
aults to the length of the reference.", |
| 3248 "format": "int64", |
| 3249 "type": "string" |
| 3250 }, |
| 3251 "pageToken": { |
| 3252 "description": "The continuation token, which is used to pag
e through large result sets.\nTo get the next page of results, set this paramete
r to the value of\n`nextPageToken` from the previous response.", |
| 3253 "type": "string" |
| 3254 }, |
| 3255 "pageSize": { |
| 3256 "description": "The maximum number of results to return in a
single page. If unspecified,\ndefaults to 256. The maximum value is 2048.", |
| 3257 "format": "int32", |
| 3258 "type": "integer" |
| 3259 }, |
| 3260 "start": { |
| 3261 "description": "The start position of the range on the refer
ence, 0-based inclusive. If\nspecified,\nreferenceId or\nreferenceName\nmust be
specified. Defaults to 0.", |
| 3262 "format": "int64", |
| 3263 "type": "string" |
| 3264 }, |
| 3265 "annotationSetIds": { |
| 3266 "description": "Required. The annotation sets to search with
in. The caller must have\n`READ` access to these annotation sets.\nAll queried a
nnotation sets must have the same type.", |
| 3267 "items": { |
| 3268 "type": "string" |
| 3269 }, |
| 3270 "type": "array" |
| 3271 }, |
| 3272 "referenceName": { |
| 3273 "description": "The name of the reference to query, within t
he reference set associated\nwith this query.", |
| 3274 "type": "string" |
| 3275 }, |
| 3276 "referenceId": { |
| 3277 "description": "The ID of the reference to query.", |
| 3278 "type": "string" |
| 3279 } |
| 3280 }, |
| 3281 "type": "object" |
| 3282 }, |
| 3283 "OperationEvent": { |
| 3284 "description": "An event that occurred during an Operation.", |
| 3285 "id": "OperationEvent", |
| 3286 "properties": { |
| 3287 "endTime": { |
| 3288 "description": "Optional time of when event finished. An eve
nt can have a start time and no\nfinish time. If an event has a finish time, the
re must be a start time.", |
| 3289 "format": "google-datetime", |
| 3290 "type": "string" |
| 3291 }, |
| 3292 "startTime": { |
| 3293 "description": "Optional time of when event started.", |
| 3294 "format": "google-datetime", |
| 3295 "type": "string" |
| 3296 }, |
| 3297 "description": { |
| 3298 "description": "Required description of event.", |
| 3299 "type": "string" |
| 3300 } |
| 3301 }, |
| 3302 "type": "object" |
| 3303 }, |
| 3304 "CodingSequence": { |
| 3305 "id": "CodingSequence", |
| 3306 "properties": { |
| 3307 "end": { |
| 3308 "description": "The end of the coding sequence on this annot
ation's reference sequence,\n0-based exclusive. Note that this position is relat
ive to the reference\nstart, and *not* the containing annotation start.", |
| 3309 "format": "int64", |
| 3310 "type": "string" |
| 3311 }, |
| 3312 "start": { |
| 3313 "description": "The start of the coding sequence on this ann
otation's reference sequence,\n0-based inclusive. Note that this position is rel
ative to the reference\nstart, and *not* the containing annotation start.", |
| 3314 "format": "int64", |
| 3315 "type": "string" |
| 3316 } |
| 3317 }, |
| 3318 "type": "object" |
| 3319 }, |
| 3320 "SearchReferencesResponse": { |
| 3321 "id": "SearchReferencesResponse", |
| 3322 "properties": { |
| 3323 "references": { |
| 3324 "description": "The matching references.", |
| 3325 "items": { |
| 3326 "$ref": "Reference" |
| 3327 }, |
| 3328 "type": "array" |
| 3329 }, |
| 3330 "nextPageToken": { |
| 3331 "description": "The continuation token, which is used to pag
e through large result sets.\nProvide this value in a subsequent request to retu
rn the next page of\nresults. This field will be empty if there aren't any addit
ional results.", |
| 3332 "type": "string" |
| 3333 } |
| 3334 }, |
| 3335 "type": "object" |
| 3336 }, |
| 3337 "GetIamPolicyRequest": { |
| 3338 "description": "Request message for `GetIamPolicy` method.", |
| 3339 "id": "GetIamPolicyRequest", |
| 3340 "properties": {}, |
| 3341 "type": "object" |
| 3342 }, |
| 3343 "TestIamPermissionsResponse": { |
| 3344 "description": "Response message for `TestIamPermissions` method.", |
| 3345 "id": "TestIamPermissionsResponse", |
| 3346 "properties": { |
| 3347 "permissions": { |
| 3348 "description": "A subset of `TestPermissionsRequest.permissi
ons` that the caller is\nallowed.", |
| 3349 "items": { |
| 3350 "type": "string" |
| 3351 }, |
| 3352 "type": "array" |
| 3353 } |
| 3354 }, |
| 3355 "type": "object" |
| 3356 }, |
| 3357 "SearchAnnotationSetsRequest": { |
| 3358 "id": "SearchAnnotationSetsRequest", |
| 3359 "properties": { |
| 3360 "pageToken": { |
| 3361 "description": "The continuation token, which is used to pag
e through large result sets.\nTo get the next page of results, set this paramete
r to the value of\n`nextPageToken` from the previous response.", |
| 3362 "type": "string" |
| 3363 }, |
| 3364 "pageSize": { |
| 3365 "description": "The maximum number of results to return in a
single page. If unspecified,\ndefaults to 128. The maximum value is 1024.", |
| 3366 "format": "int32", |
| 3367 "type": "integer" |
| 3368 }, |
3203 "datasetIds": { | 3369 "datasetIds": { |
3204 "description": "Exactly one dataset ID must be provided here
. Only variant sets which belong to this dataset will be returned.", | 3370 "description": "Required. The dataset IDs to search within.
Caller must have `READ` access\nto these datasets.", |
| 3371 "items": { |
| 3372 "type": "string" |
| 3373 }, |
| 3374 "type": "array" |
| 3375 }, |
| 3376 "types": { |
| 3377 "description": "If specified, only annotation sets that have
any of these types are\nreturned.", |
| 3378 "enumDescriptions": [ |
| 3379 "", |
| 3380 "A `GENERIC` annotation type should be used when no othe
r annotation\ntype will suffice. This represents an untyped annotation of the re
ference\ngenome.", |
| 3381 "A `VARIANT` annotation type.", |
| 3382 "A `GENE` annotation type represents the existence of a
gene at the\nassociated reference coordinates. The start coordinate is typically
the\ngene's transcription start site and the end is typically the end of the\ng
ene's last exon.", |
| 3383 "A `TRANSCRIPT` annotation type represents the assertion
that a\nparticular region of the reference genome may be transcribed as RNA." |
| 3384 ], |
| 3385 "items": { |
| 3386 "enum": [ |
| 3387 "ANNOTATION_TYPE_UNSPECIFIED", |
| 3388 "GENERIC", |
| 3389 "VARIANT", |
| 3390 "GENE", |
| 3391 "TRANSCRIPT" |
| 3392 ], |
| 3393 "type": "string" |
| 3394 }, |
| 3395 "type": "array" |
| 3396 }, |
| 3397 "name": { |
| 3398 "description": "Only return annotations sets for which a sub
string of the name matches this\nstring (case insensitive).", |
| 3399 "type": "string" |
| 3400 }, |
| 3401 "referenceSetId": { |
| 3402 "description": "If specified, only annotation sets associate
d with the given reference set\nare returned.", |
| 3403 "type": "string" |
| 3404 } |
| 3405 }, |
| 3406 "type": "object" |
| 3407 }, |
| 3408 "SearchReadGroupSetsResponse": { |
| 3409 "description": "The read group set search response.", |
| 3410 "id": "SearchReadGroupSetsResponse", |
| 3411 "properties": { |
| 3412 "nextPageToken": { |
| 3413 "description": "The continuation token, which is used to pag
e through large result sets.\nProvide this value in a subsequent request to retu
rn the next page of\nresults. This field will be empty if there aren't any addit
ional results.", |
| 3414 "type": "string" |
| 3415 }, |
| 3416 "readGroupSets": { |
| 3417 "description": "The list of matching read group sets.", |
| 3418 "items": { |
| 3419 "$ref": "ReadGroupSet" |
| 3420 }, |
| 3421 "type": "array" |
| 3422 } |
| 3423 }, |
| 3424 "type": "object" |
| 3425 }, |
| 3426 "LinearAlignment": { |
| 3427 "description": "A linear alignment can be represented by one CIGAR s
tring. Describes the\nmapped position and local alignment of the read to the ref
erence.", |
| 3428 "id": "LinearAlignment", |
| 3429 "properties": { |
| 3430 "mappingQuality": { |
| 3431 "description": "The mapping quality of this alignment. Repre
sents how likely\nthe read maps to this position as opposed to other locations.\
n\nSpecifically, this is -10 log10 Pr(mapping position is wrong), rounded to\nth
e nearest integer.", |
| 3432 "format": "int32", |
| 3433 "type": "integer" |
| 3434 }, |
| 3435 "position": { |
| 3436 "$ref": "Position", |
| 3437 "description": "The position of this alignment." |
| 3438 }, |
| 3439 "cigar": { |
| 3440 "description": "Represents the local alignment of this seque
nce (alignment matches, indels,\netc) against the reference.", |
| 3441 "items": { |
| 3442 "$ref": "CigarUnit" |
| 3443 }, |
| 3444 "type": "array" |
| 3445 } |
| 3446 }, |
| 3447 "type": "object" |
| 3448 }, |
| 3449 "SearchReferencesRequest": { |
| 3450 "id": "SearchReferencesRequest", |
| 3451 "properties": { |
| 3452 "md5checksums": { |
| 3453 "description": "If present, return references for which the\
nmd5checksum matches exactly.", |
| 3454 "items": { |
| 3455 "type": "string" |
| 3456 }, |
| 3457 "type": "array" |
| 3458 }, |
| 3459 "accessions": { |
| 3460 "description": "If present, return references for which a pr
efix of any of\nsourceAccessions match\nany of these strings. Accession numbers
typically have a main number and a\nversion, for example `GCF_000001405.26`.", |
3205 "items": { | 3461 "items": { |
3206 "type": "string" | 3462 "type": "string" |
3207 }, | 3463 }, |
3208 "type": "array" | 3464 "type": "array" |
3209 }, | 3465 }, |
3210 "pageToken": { | 3466 "pageToken": { |
3211 "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.", | 3467 "description": "The continuation token, which is used to pag
e through large result sets.\nTo get the next page of results, set this paramete
r to the value of\n`nextPageToken` from the previous response.", |
| 3468 "type": "string" |
| 3469 }, |
| 3470 "referenceSetId": { |
| 3471 "description": "If present, return only references which bel
ong to this reference set.", |
3212 "type": "string" | 3472 "type": "string" |
3213 }, | 3473 }, |
3214 "pageSize": { | 3474 "pageSize": { |
3215 "description": "The maximum number of results to return in a
single page. If unspecified, defaults to 1024.", | 3475 "description": "The maximum number of results to return in a
single page. If unspecified,\ndefaults to 1024. The maximum value is 4096.", |
3216 "format": "int32", | 3476 "format": "int32", |
3217 "type": "integer" | 3477 "type": "integer" |
3218 } | 3478 } |
3219 }, | 3479 }, |
3220 "type": "object" | 3480 "type": "object" |
3221 }, | 3481 }, |
3222 "SearchVariantSetsResponse": { | 3482 "Dataset": { |
3223 "description": "The search variant sets response.", | 3483 "description": "A Dataset is a collection of genomic data.\n\nFor mo
re genomics resource definitions, see [Fundamentals of Google\nGenomics](https:/
/cloud.google.com/genomics/fundamentals-of-google-genomics)", |
3224 "id": "SearchVariantSetsResponse", | 3484 "id": "Dataset", |
3225 "properties": { | 3485 "properties": { |
3226 "variantSets": { | 3486 "projectId": { |
3227 "description": "The variant sets belonging to the requested
dataset.", | 3487 "description": "The Google Cloud project ID that this datase
t belongs to.", |
3228 "items": { | 3488 "type": "string" |
3229 "$ref": "VariantSet" | 3489 }, |
3230 }, | 3490 "id": { |
3231 "type": "array" | 3491 "description": "The server-generated dataset ID, unique acro
ss all datasets.", |
3232 }, | 3492 "type": "string" |
3233 "nextPageToken": { | 3493 }, |
3234 "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.", | 3494 "createTime": { |
3235 "type": "string" | 3495 "description": "The time this dataset was created, in second
s from the epoch.", |
3236 } | 3496 "format": "google-datetime", |
3237 }, | 3497 "type": "string" |
3238 "type": "object" | 3498 }, |
3239 }, | 3499 "name": { |
3240 "SearchVariantsRequest": { | 3500 "description": "The dataset name.", |
3241 "description": "The variant search request.", | 3501 "type": "string" |
3242 "id": "SearchVariantsRequest", | 3502 } |
3243 "properties": { | 3503 }, |
3244 "variantSetIds": { | 3504 "type": "object" |
3245 "description": "At most one variant set ID must be provided.
Only variants from this variant set will be returned. If omitted, a call set id
must be included in the request.", | 3505 }, |
3246 "items": { | 3506 "ImportVariantsResponse": { |
3247 "type": "string" | 3507 "description": "The variant data import response.", |
3248 }, | 3508 "id": "ImportVariantsResponse", |
3249 "type": "array" | 3509 "properties": { |
3250 }, | |
3251 "variantName": { | |
3252 "description": "Only return variants which have exactly this
name.", | |
3253 "type": "string" | |
3254 }, | |
3255 "callSetIds": { | 3510 "callSetIds": { |
3256 "description": "Only return variant calls which belong to ca
ll sets with these ids. Leaving this blank returns all variant calls. If a varia
nt has no calls belonging to any of these call sets, it won't be returned at all
.", | 3511 "description": "IDs of the call sets created during the impo
rt.", |
3257 "items": { | 3512 "items": { |
3258 "type": "string" | 3513 "type": "string" |
3259 }, | 3514 }, |
3260 "type": "array" | 3515 "type": "array" |
3261 }, | 3516 } |
3262 "referenceName": { | 3517 }, |
3263 "description": "Required. Only return variants in this refer
ence sequence.", | 3518 "type": "object" |
3264 "type": "string" | 3519 }, |
3265 }, | 3520 "ReadGroup": { |
3266 "start": { | 3521 "description": "A read group is all the data that's processed the sa
me way by the sequencer.", |
3267 "description": "The beginning of the window (0-based, inclus
ive) for which overlapping variants should be returned. If unspecified, defaults
to 0.", | 3522 "id": "ReadGroup", |
3268 "format": "int64", | 3523 "properties": { |
3269 "type": "string" | 3524 "predictedInsertSize": { |
3270 }, | 3525 "description": "The predicted insert size of this read group
. The insert size is the length\nthe sequenced DNA fragment from end-to-end, not
including the adapters.", |
3271 "end": { | 3526 "format": "int32", |
3272 "description": "The end of the window, 0-based exclusive. If
unspecified or 0, defaults to the length of the reference.", | 3527 "type": "integer" |
3273 "format": "int64", | 3528 }, |
3274 "type": "string" | 3529 "programs": { |
3275 }, | 3530 "description": "The programs used to generate this read grou
p. Programs are always\nidentical for all read groups within a read group set. F
or this reason,\nonly the first read group in a returned set will have this fiel
d\npopulated.", |
3276 "pageToken": { | 3531 "items": { |
3277 "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.", | 3532 "$ref": "Program" |
3278 "type": "string" | 3533 }, |
3279 }, | 3534 "type": "array" |
3280 "pageSize": { | 3535 }, |
3281 "description": "The maximum number of variants to return in
a single page. If unspecified, defaults to 5000. The maximum value is 10000.", | 3536 "description": { |
3282 "format": "int32", | 3537 "description": "A free-form text description of this read gr
oup.", |
3283 "type": "integer" | 3538 "type": "string" |
3284 }, | 3539 }, |
3285 "maxCalls": { | 3540 "sampleId": { |
3286 "description": "The maximum number of calls to return in a s
ingle page. Note that this limit may be exceeded in the event that a matching va
riant contains more calls than the requested maximum. If unspecified, defaults t
o 5000. The maximum value is 10000.", | 3541 "description": "A client-supplied sample identifier for the
reads in this read group.", |
3287 "format": "int32", | 3542 "type": "string" |
3288 "type": "integer" | 3543 }, |
3289 } | 3544 "datasetId": { |
3290 }, | 3545 "description": "The dataset to which this read group belongs
.", |
3291 "type": "object" | 3546 "type": "string" |
3292 }, | 3547 }, |
3293 "SearchVariantsResponse": { | 3548 "experiment": { |
3294 "description": "The variant search response.", | 3549 "$ref": "Experiment", |
3295 "id": "SearchVariantsResponse", | 3550 "description": "The experiment used to generate this read gr
oup." |
3296 "properties": { | 3551 }, |
3297 "variants": { | 3552 "name": { |
3298 "description": "The list of matching Variants.", | 3553 "description": "The read group name. This corresponds to the
@RG ID field in the SAM spec.", |
3299 "items": { | 3554 "type": "string" |
3300 "$ref": "Variant" | 3555 }, |
3301 }, | 3556 "referenceSetId": { |
3302 "type": "array" | 3557 "description": "The reference set the reads in this read gro
up are aligned to.", |
3303 }, | 3558 "type": "string" |
3304 "nextPageToken": { | |
3305 "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.", | |
3306 "type": "string" | |
3307 } | |
3308 }, | |
3309 "type": "object" | |
3310 }, | |
3311 "Variant": { | |
3312 "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. For more genomics resource definitio
ns, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fund
amentals-of-google-genomics) Each of the calls on a variant represent a determin
ation of genotype with respect to that variant. For example, a call might assign
probability of 0.32 to the occurrence of a SNP named rs1234 in a sample named N
A12345. A call belongs to a call set, which contains related calls typically fro
m one sample.", | |
3313 "id": "Variant", | |
3314 "properties": { | |
3315 "variantSetId": { | |
3316 "description": "The ID of the variant set this variant belon
gs to.", | |
3317 "type": "string" | |
3318 }, | |
3319 "id": { | |
3320 "description": "The server-generated variant ID, unique acro
ss all variants.", | |
3321 "type": "string" | |
3322 }, | |
3323 "names": { | |
3324 "description": "Names for the variant, for example a RefSNP
ID.", | |
3325 "items": { | |
3326 "type": "string" | |
3327 }, | |
3328 "type": "array" | |
3329 }, | |
3330 "created": { | |
3331 "description": "The date this variant was created, in millis
econds from the epoch.", | |
3332 "format": "int64", | |
3333 "type": "string" | |
3334 }, | |
3335 "referenceName": { | |
3336 "description": "The reference on which this variant occurs.
(such as `chr20` or `X`)", | |
3337 "type": "string" | |
3338 }, | |
3339 "start": { | |
3340 "description": "The position at which this variant occurs (0
-based). This corresponds to the first base of the string of reference bases.", | |
3341 "format": "int64", | |
3342 "type": "string" | |
3343 }, | |
3344 "end": { | |
3345 "description": "The end position (0-based) of this variant.
This corresponds to the first base after the last base in the reference allele.
So, the length of the reference allele is (end - start). This is useful for vari
ants that don't explicitly give alternate bases, for example large deletions.", | |
3346 "format": "int64", | |
3347 "type": "string" | |
3348 }, | |
3349 "referenceBases": { | |
3350 "description": "The reference bases for this variant. They s
tart at the given position.", | |
3351 "type": "string" | |
3352 }, | |
3353 "alternateBases": { | |
3354 "description": "The bases that appear instead of the referen
ce bases.", | |
3355 "items": { | |
3356 "type": "string" | |
3357 }, | |
3358 "type": "array" | |
3359 }, | |
3360 "quality": { | |
3361 "description": "A measure of how likely this variant is to b
e real. A higher value is better.", | |
3362 "format": "double", | |
3363 "type": "number" | |
3364 }, | |
3365 "filter": { | |
3366 "description": "A list of filters (normally quality filters)
this variant has failed. `PASS` indicates this variant has passed all filters."
, | |
3367 "items": { | |
3368 "type": "string" | |
3369 }, | |
3370 "type": "array" | |
3371 }, | 3559 }, |
3372 "info": { | 3560 "info": { |
3373 "additionalProperties": { | |
3374 "items": { | |
3375 "type": "any" | |
3376 }, | |
3377 "type": "array" | |
3378 }, | |
3379 "description": "A map of additional variant information. Thi
s must be of the form map (string key mapping to a list of string values).", | |
3380 "type": "object" | |
3381 }, | |
3382 "calls": { | |
3383 "description": "The variant calls for this particular varian
t. Each one represents the determination of genotype with respect to this varian
t.", | |
3384 "items": { | |
3385 "$ref": "VariantCall" | |
3386 }, | |
3387 "type": "array" | |
3388 } | |
3389 }, | |
3390 "type": "object" | |
3391 }, | |
3392 "VariantCall": { | |
3393 "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.", | |
3394 "id": "VariantCall", | |
3395 "properties": { | |
3396 "callSetId": { | |
3397 "description": "The ID of the call set this variant call bel
ongs to.", | |
3398 "type": "string" | |
3399 }, | |
3400 "callSetName": { | |
3401 "description": "The name of the call set this variant call b
elongs to.", | |
3402 "type": "string" | |
3403 }, | |
3404 "genotype": { | |
3405 "description": "The genotype of this variant call. Each valu
e represents either the value of the `referenceBases` field or a 1-based index i
nto `alternateBases`. If a variant had a `referenceBases` value of `T` and an `a
lternateBases` value of `[\"A\", \"C\"]`, and the `genotype` was `[2, 1]`, that
would mean the call represented the heterozygous value `CA` for this variant. If
the `genotype` was instead `[0, 1]`, the represented value would be `TA`. Order
ing of the genotype values is important if the `phaseset` is present. If a genot
ype is not called (that is, a `.` is present in the GT string) -1 is returned.", | |
3406 "items": { | |
3407 "format": "int32", | |
3408 "type": "integer" | |
3409 }, | |
3410 "type": "array" | |
3411 }, | |
3412 "phaseset": { | |
3413 "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 `*`.", | |
3414 "type": "string" | |
3415 }, | |
3416 "genotypeLikelihood": { | |
3417 "description": "The genotype likelihoods for this variant ca
ll. Each array entry represents how likely a specific genotype is for this call.
The value ordering is defined by the GL tag in the VCF spec. If Phred-scaled ge
notype likelihood scores (PL) are available and log10(P) genotype likelihood sco
res (GL) are not, PL scores are converted to GL scores. If both are available, P
L scores are stored in `info`.", | |
3418 "items": { | |
3419 "format": "double", | |
3420 "type": "number" | |
3421 }, | |
3422 "type": "array" | |
3423 }, | |
3424 "info": { | |
3425 "additionalProperties": { | |
3426 "items": { | |
3427 "type": "any" | |
3428 }, | |
3429 "type": "array" | |
3430 }, | |
3431 "description": "A map of additional variant call information
. This must be of the form map (string key mapping to a list of string values)."
, | |
3432 "type": "object" | |
3433 } | |
3434 }, | |
3435 "type": "object" | |
3436 }, | |
3437 "MergeVariantsRequest": { | |
3438 "id": "MergeVariantsRequest", | |
3439 "properties": { | |
3440 "variantSetId": { | |
3441 "description": "The destination variant set.", | |
3442 "type": "string" | |
3443 }, | |
3444 "variants": { | |
3445 "description": "The variants to be merged with existing vari
ants.", | |
3446 "items": { | |
3447 "$ref": "Variant" | |
3448 }, | |
3449 "type": "array" | |
3450 }, | |
3451 "infoMergeConfig": { | |
3452 "additionalProperties": { | |
3453 "enum": [ | |
3454 "INFO_MERGE_OPERATION_UNSPECIFIED", | |
3455 "IGNORE_NEW", | |
3456 "MOVE_TO_CALLS" | |
3457 ], | |
3458 "type": "string" | |
3459 }, | |
3460 "description": "A mapping between info field keys and the In
foMergeOperations to be performed on them.", | |
3461 "type": "object" | |
3462 } | |
3463 }, | |
3464 "type": "object" | |
3465 }, | |
3466 "SearchCallSetsRequest": { | |
3467 "description": "The call set search request.", | |
3468 "id": "SearchCallSetsRequest", | |
3469 "properties": { | |
3470 "variantSetIds": { | |
3471 "description": "Restrict the query to call sets within the g
iven variant sets. At least one ID must be provided.", | |
3472 "items": { | |
3473 "type": "string" | |
3474 }, | |
3475 "type": "array" | |
3476 }, | |
3477 "name": { | |
3478 "description": "Only return call sets for which a substring
of the name matches this string.", | |
3479 "type": "string" | |
3480 }, | |
3481 "pageToken": { | |
3482 "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.", | |
3483 "type": "string" | |
3484 }, | |
3485 "pageSize": { | |
3486 "description": "The maximum number of results to return in a
single page. If unspecified, defaults to 1024.", | |
3487 "format": "int32", | |
3488 "type": "integer" | |
3489 } | |
3490 }, | |
3491 "type": "object" | |
3492 }, | |
3493 "SearchCallSetsResponse": { | |
3494 "description": "The call set search response.", | |
3495 "id": "SearchCallSetsResponse", | |
3496 "properties": { | |
3497 "callSets": { | |
3498 "description": "The list of matching call sets.", | |
3499 "items": { | |
3500 "$ref": "CallSet" | |
3501 }, | |
3502 "type": "array" | |
3503 }, | |
3504 "nextPageToken": { | |
3505 "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.", | |
3506 "type": "string" | |
3507 } | |
3508 }, | |
3509 "type": "object" | |
3510 }, | |
3511 "CallSet": { | |
3512 "description": "A call set is a collection of variant calls, typical
ly for one sample. It belongs to a variant set. For more genomics resource defin
itions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/
fundamentals-of-google-genomics)", | |
3513 "id": "CallSet", | |
3514 "properties": { | |
3515 "id": { | |
3516 "description": "The server-generated call set ID, unique acr
oss all call sets.", | |
3517 "type": "string" | |
3518 }, | |
3519 "name": { | |
3520 "description": "The call set name.", | |
3521 "type": "string" | |
3522 }, | |
3523 "sampleId": { | |
3524 "description": "The sample ID this call set corresponds to."
, | |
3525 "type": "string" | |
3526 }, | |
3527 "variantSetIds": { | |
3528 "description": "The IDs of the variant sets this call set be
longs to. This field must have exactly length one, as a call set belongs to a si
ngle variant set. This field is repeated for compatibility with the [GA4GH 0.5.1
API](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/varia
nts.avdl#L76).", | |
3529 "items": { | |
3530 "type": "string" | |
3531 }, | |
3532 "type": "array" | |
3533 }, | |
3534 "created": { | |
3535 "description": "The date this call set was created in millis
econds from the epoch.", | |
3536 "format": "int64", | |
3537 "type": "string" | |
3538 }, | |
3539 "info": { | |
3540 "additionalProperties": { | 3561 "additionalProperties": { |
3541 "items": { | 3562 "items": { |
3542 "type": "any" | 3563 "type": "any" |
3543 }, | 3564 }, |
3544 "type": "array" | 3565 "type": "array" |
3545 }, | 3566 }, |
3546 "description": "A map of additional call set information. Th
is must be of the form map (string key mapping to a list of string values).", | 3567 "description": "A map of additional read group information.
This must be of the form\nmap<string, string[]> (string key mapping to a list of
string values).", |
3547 "type": "object" | 3568 "type": "object" |
3548 } | |
3549 }, | |
3550 "type": "object" | |
3551 }, | |
3552 "StreamVariantsRequest": { | |
3553 "description": "The stream variants request.", | |
3554 "id": "StreamVariantsRequest", | |
3555 "properties": { | |
3556 "projectId": { | |
3557 "description": "The Google Cloud project ID which will be bi
lled for this access. The caller must have WRITE access to this project. Require
d.", | |
3558 "type": "string" | |
3559 }, | 3569 }, |
3560 "variantSetId": { | 3570 "id": { |
3561 "description": "The variant set ID from which to stream vari
ants.", | 3571 "description": "The server-generated read group ID, unique f
or all read groups.\nNote: This is different than the @RG ID field in the SAM sp
ec. For that\nvalue, see name.", |
3562 "type": "string" | |
3563 }, | |
3564 "callSetIds": { | |
3565 "description": "Only return variant calls which belong to ca
ll sets with these IDs. Leaving this blank returns all variant calls.", | |
3566 "items": { | |
3567 "type": "string" | |
3568 }, | |
3569 "type": "array" | |
3570 }, | |
3571 "referenceName": { | |
3572 "description": "Required. Only return variants in this refer
ence sequence.", | |
3573 "type": "string" | |
3574 }, | |
3575 "start": { | |
3576 "description": "The beginning of the window (0-based, inclus
ive) for which overlapping variants should be returned.", | |
3577 "format": "int64", | |
3578 "type": "string" | |
3579 }, | |
3580 "end": { | |
3581 "description": "The end of the window (0-based, exclusive) f
or which overlapping variants should be returned.", | |
3582 "format": "int64", | |
3583 "type": "string" | 3572 "type": "string" |
3584 } | 3573 } |
3585 }, | 3574 }, |
3586 "type": "object" | 3575 "type": "object" |
3587 }, | 3576 }, |
3588 "StreamVariantsResponse": { | 3577 "ReadGroupSet": { |
3589 "id": "StreamVariantsResponse", | 3578 "description": "A read group set is a logical collection of read gro
ups, which are\ncollections of reads produced by a sequencer. A read group set t
ypically\nmodels reads corresponding to one sample, sequenced one way, and align
ed one\nway.\n\n* A read group set belongs to one dataset.\n* A read group belon
gs to one read group set.\n* A read belongs to one read group.\n\nFor more genom
ics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.g
oogle.com/genomics/fundamentals-of-google-genomics)", |
| 3579 "id": "ReadGroupSet", |
3590 "properties": { | 3580 "properties": { |
3591 "variants": { | 3581 "datasetId": { |
| 3582 "description": "The dataset to which this read group set bel
ongs.", |
| 3583 "type": "string" |
| 3584 }, |
| 3585 "filename": { |
| 3586 "description": "The filename of the original source file for
this read group set, if any.", |
| 3587 "type": "string" |
| 3588 }, |
| 3589 "readGroups": { |
| 3590 "description": "The read groups in this set. There are typic
ally 1-10 read groups in a read\ngroup set.", |
3592 "items": { | 3591 "items": { |
3593 "$ref": "Variant" | 3592 "$ref": "ReadGroup" |
3594 }, | 3593 }, |
3595 "type": "array" | 3594 "type": "array" |
| 3595 }, |
| 3596 "name": { |
| 3597 "description": "The read group set name. By default this wil
l be initialized to the sample\nname of the sequenced data contained in this set
.", |
| 3598 "type": "string" |
| 3599 }, |
| 3600 "referenceSetId": { |
| 3601 "description": "The reference set to which the reads in this
read group set are aligned.", |
| 3602 "type": "string" |
| 3603 }, |
| 3604 "info": { |
| 3605 "additionalProperties": { |
| 3606 "items": { |
| 3607 "type": "any" |
| 3608 }, |
| 3609 "type": "array" |
| 3610 }, |
| 3611 "description": "A map of additional read group set informati
on.", |
| 3612 "type": "object" |
| 3613 }, |
| 3614 "id": { |
| 3615 "description": "The server-generated read group set ID, uniq
ue for all read group sets.", |
| 3616 "type": "string" |
3596 } | 3617 } |
3597 }, | 3618 }, |
3598 "type": "object" | 3619 "type": "object" |
3599 }, | 3620 }, |
3600 "ImportReadGroupSetsResponse": { | 3621 "SearchVariantSetsResponse": { |
3601 "description": "The read group set import response.", | 3622 "description": "The search variant sets response.", |
3602 "id": "ImportReadGroupSetsResponse", | 3623 "id": "SearchVariantSetsResponse", |
3603 "properties": { | 3624 "properties": { |
3604 "readGroupSetIds": { | 3625 "variantSets": { |
3605 "description": "IDs of the read group sets that were created
.", | 3626 "description": "The variant sets belonging to the requested
dataset.", |
| 3627 "items": { |
| 3628 "$ref": "VariantSet" |
| 3629 }, |
| 3630 "type": "array" |
| 3631 }, |
| 3632 "nextPageToken": { |
| 3633 "description": "The continuation token, which is used to pag
e through large result sets.\nProvide this value in a subsequent request to retu
rn the next page of\nresults. This field will be empty if there aren't any addit
ional results.", |
| 3634 "type": "string" |
| 3635 } |
| 3636 }, |
| 3637 "type": "object" |
| 3638 }, |
| 3639 "Empty": { |
| 3640 "description": "A generic empty message that you can re-use to avoid
defining duplicated\nempty messages in your APIs. A typical example is to use i
t as the request\nor the response type of an API method. For instance:\n\n se
rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty
);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", |
| 3641 "id": "Empty", |
| 3642 "properties": {}, |
| 3643 "type": "object" |
| 3644 }, |
| 3645 "Entry": { |
| 3646 "id": "Entry", |
| 3647 "properties": { |
| 3648 "status": { |
| 3649 "$ref": "Status", |
| 3650 "description": "The creation status." |
| 3651 }, |
| 3652 "annotation": { |
| 3653 "$ref": "Annotation", |
| 3654 "description": "The created annotation, if creation was succ
essful." |
| 3655 } |
| 3656 }, |
| 3657 "type": "object" |
| 3658 }, |
| 3659 "Position": { |
| 3660 "description": "An abstraction for referring to a genomic position,
in relation to some\nalready known reference. For now, represents a genomic posi
tion as a\nreference name, a base number on that reference (0-based), and a\ndet
ermination of forward or reverse strand.", |
| 3661 "id": "Position", |
| 3662 "properties": { |
| 3663 "position": { |
| 3664 "description": "The 0-based offset from the start of the for
ward strand for that reference.", |
| 3665 "format": "int64", |
| 3666 "type": "string" |
| 3667 }, |
| 3668 "referenceName": { |
| 3669 "description": "The name of the reference in whatever refere
nce set is being used.", |
| 3670 "type": "string" |
| 3671 }, |
| 3672 "reverseStrand": { |
| 3673 "description": "Whether this position is on the reverse stra
nd, as opposed to the forward\nstrand.", |
| 3674 "type": "boolean" |
| 3675 } |
| 3676 }, |
| 3677 "type": "object" |
| 3678 }, |
| 3679 "SearchReferenceSetsResponse": { |
| 3680 "id": "SearchReferenceSetsResponse", |
| 3681 "properties": { |
| 3682 "referenceSets": { |
| 3683 "description": "The matching references sets.", |
| 3684 "items": { |
| 3685 "$ref": "ReferenceSet" |
| 3686 }, |
| 3687 "type": "array" |
| 3688 }, |
| 3689 "nextPageToken": { |
| 3690 "description": "The continuation token, which is used to pag
e through large result sets.\nProvide this value in a subsequent request to retu
rn the next page of\nresults. This field will be empty if there aren't any addit
ional results.", |
| 3691 "type": "string" |
| 3692 } |
| 3693 }, |
| 3694 "type": "object" |
| 3695 }, |
| 3696 "SearchCallSetsRequest": { |
| 3697 "description": "The call set search request.", |
| 3698 "id": "SearchCallSetsRequest", |
| 3699 "properties": { |
| 3700 "name": { |
| 3701 "description": "Only return call sets for which a substring
of the name matches this\nstring.", |
| 3702 "type": "string" |
| 3703 }, |
| 3704 "pageToken": { |
| 3705 "description": "The continuation token, which is used to pag
e through large result sets.\nTo get the next page of results, set this paramete
r to the value of\n`nextPageToken` from the previous response.", |
| 3706 "type": "string" |
| 3707 }, |
| 3708 "pageSize": { |
| 3709 "description": "The maximum number of results to return in a
single page. If unspecified,\ndefaults to 1024.", |
| 3710 "format": "int32", |
| 3711 "type": "integer" |
| 3712 }, |
| 3713 "variantSetIds": { |
| 3714 "description": "Restrict the query to call sets within the g
iven variant sets. At least one\nID must be provided.", |
3606 "items": { | 3715 "items": { |
3607 "type": "string" | 3716 "type": "string" |
3608 }, | 3717 }, |
3609 "type": "array" | 3718 "type": "array" |
3610 } | 3719 } |
3611 }, | 3720 }, |
3612 "type": "object" | 3721 "type": "object" |
3613 }, | 3722 }, |
3614 "ImportVariantsResponse": { | 3723 "ImportReadGroupSetsRequest": { |
3615 "description": "The variant data import response.", | 3724 "description": "The read group set import request.", |
3616 "id": "ImportVariantsResponse", | 3725 "id": "ImportReadGroupSetsRequest", |
3617 "properties": { | 3726 "properties": { |
3618 "callSetIds": { | 3727 "referenceSetId": { |
3619 "description": "IDs of the call sets created during the impo
rt.", | 3728 "description": "The reference set to which the imported read
group sets are aligned to, if\nany. The reference names of this reference set m
ust be a superset of those\nfound in the imported file headers. If no reference
set id is provided, a\nbest effort is made to associate with a matching referenc
e set.", |
| 3729 "type": "string" |
| 3730 }, |
| 3731 "partitionStrategy": { |
| 3732 "description": "The partition strategy describes how read gr
oups are partitioned into read\ngroup sets.", |
| 3733 "enum": [ |
| 3734 "PARTITION_STRATEGY_UNSPECIFIED", |
| 3735 "PER_FILE_PER_SAMPLE", |
| 3736 "MERGE_ALL" |
| 3737 ], |
| 3738 "enumDescriptions": [ |
| 3739 "", |
| 3740 "In most cases, this strategy yields one read group set
per file. This is\nthe default behavior.\n\nAllocate one read group set per file
per sample. For BAM files, read\ngroups are considered to share a sample if the
y have identical sample\nnames. Furthermore, all reads for each file which do no
t belong to a read\ngroup, if any, will be grouped into a single read group set
per-file.", |
| 3741 "Includes all read groups in all imported files into a s
ingle read group\nset. Requires that the headers for all imported files are equi
valent. All\nreads which do not belong to a read group, if any, will be grouped
into a\nseparate read group set." |
| 3742 ], |
| 3743 "type": "string" |
| 3744 }, |
| 3745 "datasetId": { |
| 3746 "description": "Required. The ID of the dataset these read g
roup sets will belong to. The\ncaller must have WRITE permissions to this datase
t.", |
| 3747 "type": "string" |
| 3748 }, |
| 3749 "sourceUris": { |
| 3750 "description": "A list of URIs pointing at [BAM\nfiles](http
s://samtools.github.io/hts-specs/SAMv1.pdf)\nin Google Cloud Storage.\nThose URI
s can include wildcards (*), but do not add or remove\nmatching files before imp
ort has completed.\n\nNote that Google Cloud Storage object listing is only even
tually\nconsistent: files added may be not be immediately visible to\neveryone.
Thus, if using a wildcard it is preferable not to start\nthe import immediately
after the files are created.", |
3620 "items": { | 3751 "items": { |
3621 "type": "string" | 3752 "type": "string" |
3622 }, | 3753 }, |
3623 "type": "array" | |
3624 } | |
3625 }, | |
3626 "type": "object" | |
3627 }, | |
3628 "OperationMetadata": { | |
3629 "description": "Metadata describing an Operation.", | |
3630 "id": "OperationMetadata", | |
3631 "properties": { | |
3632 "projectId": { | |
3633 "description": "The Google Cloud Project in which the job is
scoped.", | |
3634 "type": "string" | |
3635 }, | |
3636 "createTime": { | |
3637 "description": "The time at which the job was submitted to t
he Genomics service.", | |
3638 "type": "string" | |
3639 }, | |
3640 "startTime": { | |
3641 "description": "The time at which the job began to run.", | |
3642 "type": "string" | |
3643 }, | |
3644 "endTime": { | |
3645 "description": "The time at which the job stopped running.", | |
3646 "type": "string" | |
3647 }, | |
3648 "request": { | |
3649 "additionalProperties": { | |
3650 "description": "Properties of the object. Contains field
@type with type URL.", | |
3651 "type": "any" | |
3652 }, | |
3653 "description": "The original request that started the operat
ion. Note that this will be in current version of the API. If the operation was
started with v1beta2 API and a GetOperation is performed on v1 API, a v1 request
will be returned.", | |
3654 "type": "object" | |
3655 }, | |
3656 "events": { | |
3657 "description": "Optional event messages that were generated
during the job's execution. This also contains any warnings that were generated
during import or export.", | |
3658 "items": { | |
3659 "$ref": "OperationEvent" | |
3660 }, | |
3661 "type": "array" | |
3662 }, | |
3663 "clientId": { | |
3664 "description": "This field is deprecated. Use `labels` inste
ad. Optionally provided by the caller when submitting the request that creates t
he operation.", | |
3665 "type": "string" | |
3666 }, | |
3667 "runtimeMetadata": { | |
3668 "additionalProperties": { | |
3669 "description": "Properties of the object. Contains field
@type with type URL.", | |
3670 "type": "any" | |
3671 }, | |
3672 "description": "Runtime metadata on this Operation.", | |
3673 "type": "object" | |
3674 }, | |
3675 "labels": { | |
3676 "additionalProperties": { | |
3677 "type": "string" | |
3678 }, | |
3679 "description": "Optionally provided by the caller when submi
tting the request that creates the operation.", | |
3680 "type": "object" | |
3681 } | |
3682 }, | |
3683 "type": "object" | |
3684 }, | |
3685 "OperationEvent": { | |
3686 "description": "An event that occurred during an Operation.", | |
3687 "id": "OperationEvent", | |
3688 "properties": { | |
3689 "startTime": { | |
3690 "description": "Optional time of when event started.", | |
3691 "type": "string" | |
3692 }, | |
3693 "endTime": { | |
3694 "description": "Optional time of when event finished. An eve
nt can have a start time and no finish time. If an event has a finish time, ther
e must be a start time.", | |
3695 "type": "string" | |
3696 }, | |
3697 "description": { | |
3698 "description": "Required description of event.", | |
3699 "type": "string" | |
3700 } | |
3701 }, | |
3702 "type": "object" | |
3703 }, | |
3704 "RuntimeMetadata": { | |
3705 "description": "Runtime metadata that will be populated in the runti
meMetadata field of the Operation associated with a RunPipeline execution.", | |
3706 "id": "RuntimeMetadata", | |
3707 "properties": { | |
3708 "computeEngine": { | |
3709 "$ref": "ComputeEngine", | |
3710 "description": "Execution information specific to Google Com
pute Engine." | |
3711 } | |
3712 }, | |
3713 "type": "object" | |
3714 }, | |
3715 "ComputeEngine": { | |
3716 "description": "Describes a Compute Engine resource that is being ma
naged by a running pipeline.", | |
3717 "id": "ComputeEngine", | |
3718 "properties": { | |
3719 "instanceName": { | |
3720 "description": "The instance on which the operation is runni
ng.", | |
3721 "type": "string" | |
3722 }, | |
3723 "zone": { | |
3724 "description": "The availability zone in which the instance
resides.", | |
3725 "type": "string" | |
3726 }, | |
3727 "machineType": { | |
3728 "description": "The machine type of the instance.", | |
3729 "type": "string" | |
3730 }, | |
3731 "diskNames": { | |
3732 "description": "The names of the disks that were created for
this pipeline.", | |
3733 "items": { | |
3734 "type": "string" | |
3735 }, | |
3736 "type": "array" | 3754 "type": "array" |
3737 } | 3755 } |
3738 }, | 3756 }, |
3739 "type": "object" | 3757 "type": "object" |
3740 } | 3758 } |
3741 }, | 3759 }, |
3742 "servicePath": "", | 3760 "servicePath": "", |
3743 "title": "Genomics API", | 3761 "title": "Genomics API", |
3744 "version": "v1" | 3762 "version": "v1" |
3745 } | 3763 } |
OLD | NEW |