OLD | NEW |
1 { | 1 { |
2 "auth": { | 2 "auth": { |
3 "oauth2": { | 3 "oauth2": { |
4 "scopes": { | 4 "scopes": { |
5 "https://www.googleapis.com/auth/cloud-platform": { | 5 "https://www.googleapis.com/auth/cloud-platform": { |
6 "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" |
7 }, | 7 }, |
8 "https://www.googleapis.com/auth/genomics.readonly": { | 8 "https://www.googleapis.com/auth/genomics.readonly": { |
9 "description": "View Genomics data" | 9 "description": "View Genomics data" |
10 }, | 10 }, |
(...skipping 18 matching lines...) Expand all Loading... |
29 "icons": { | 29 "icons": { |
30 "x16": "http://www.google.com/images/icons/product/search-16.gif", | 30 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
31 "x32": "http://www.google.com/images/icons/product/search-32.gif" | 31 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
32 }, | 32 }, |
33 "id": "genomics:v1", | 33 "id": "genomics:v1", |
34 "kind": "discovery#restDescription", | 34 "kind": "discovery#restDescription", |
35 "name": "genomics", | 35 "name": "genomics", |
36 "ownerDomain": "google.com", | 36 "ownerDomain": "google.com", |
37 "ownerName": "Google", | 37 "ownerName": "Google", |
38 "parameters": { | 38 "parameters": { |
| 39 "quotaUser": { |
| 40 "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.", |
| 41 "location": "query", |
| 42 "type": "string" |
| 43 }, |
| 44 "pp": { |
| 45 "default": "true", |
| 46 "description": "Pretty-print response.", |
| 47 "location": "query", |
| 48 "type": "boolean" |
| 49 }, |
| 50 "bearer_token": { |
| 51 "description": "OAuth bearer token.", |
| 52 "location": "query", |
| 53 "type": "string" |
| 54 }, |
| 55 "oauth_token": { |
| 56 "description": "OAuth 2.0 token for the current user.", |
| 57 "location": "query", |
| 58 "type": "string" |
| 59 }, |
| 60 "upload_protocol": { |
| 61 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
| 62 "location": "query", |
| 63 "type": "string" |
| 64 }, |
| 65 "prettyPrint": { |
| 66 "default": "true", |
| 67 "description": "Returns response with indentations and line breaks."
, |
| 68 "location": "query", |
| 69 "type": "boolean" |
| 70 }, |
39 "fields": { | 71 "fields": { |
40 "description": "Selector specifying which fields to include in a par
tial response.", | 72 "description": "Selector specifying which fields to include in a par
tial response.", |
41 "location": "query", | 73 "location": "query", |
42 "type": "string" | 74 "type": "string" |
43 }, | 75 }, |
44 "uploadType": { | 76 "uploadType": { |
45 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | 77 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
46 "location": "query", | 78 "location": "query", |
47 "type": "string" | 79 "type": "string" |
48 }, | 80 }, |
| 81 "callback": { |
| 82 "description": "JSONP", |
| 83 "location": "query", |
| 84 "type": "string" |
| 85 }, |
49 "$.xgafv": { | 86 "$.xgafv": { |
50 "description": "V1 error format.", | 87 "description": "V1 error format.", |
51 "enum": [ | 88 "enum": [ |
52 "1", | 89 "1", |
53 "2" | 90 "2" |
54 ], | 91 ], |
55 "enumDescriptions": [ | 92 "enumDescriptions": [ |
56 "v1 error format", | 93 "v1 error format", |
57 "v2 error format" | 94 "v2 error format" |
58 ], | 95 ], |
59 "location": "query", | 96 "location": "query", |
60 "type": "string" | 97 "type": "string" |
61 }, | 98 }, |
62 "callback": { | |
63 "description": "JSONP", | |
64 "location": "query", | |
65 "type": "string" | |
66 }, | |
67 "alt": { | 99 "alt": { |
68 "default": "json", | 100 "default": "json", |
69 "description": "Data format for response.", | 101 "description": "Data format for response.", |
70 "enum": [ | 102 "enum": [ |
71 "json", | 103 "json", |
72 "media", | 104 "media", |
73 "proto" | 105 "proto" |
74 ], | 106 ], |
75 "enumDescriptions": [ | 107 "enumDescriptions": [ |
76 "Responses with Content-Type of application/json", | 108 "Responses with Content-Type of application/json", |
77 "Media download with context-dependent Content-Type", | 109 "Media download with context-dependent Content-Type", |
78 "Responses with Content-Type of application/x-protobuf" | 110 "Responses with Content-Type of application/x-protobuf" |
79 ], | 111 ], |
80 "location": "query", | 112 "location": "query", |
81 "type": "string" | 113 "type": "string" |
82 }, | 114 }, |
83 "key": { | |
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.", | |
85 "location": "query", | |
86 "type": "string" | |
87 }, | |
88 "access_token": { | 115 "access_token": { |
89 "description": "OAuth access token.", | 116 "description": "OAuth access token.", |
90 "location": "query", | 117 "location": "query", |
91 "type": "string" | 118 "type": "string" |
92 }, | 119 }, |
93 "quotaUser": { | 120 "key": { |
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.", | 121 "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.", |
95 "location": "query", | 122 "location": "query", |
96 "type": "string" | 123 "type": "string" |
97 }, | |
98 "pp": { | |
99 "default": "true", | |
100 "description": "Pretty-print response.", | |
101 "location": "query", | |
102 "type": "boolean" | |
103 }, | |
104 "oauth_token": { | |
105 "description": "OAuth 2.0 token for the current user.", | |
106 "location": "query", | |
107 "type": "string" | |
108 }, | |
109 "bearer_token": { | |
110 "description": "OAuth bearer token.", | |
111 "location": "query", | |
112 "type": "string" | |
113 }, | |
114 "upload_protocol": { | |
115 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | |
116 "location": "query", | |
117 "type": "string" | |
118 }, | |
119 "prettyPrint": { | |
120 "default": "true", | |
121 "description": "Returns response with indentations and line breaks."
, | |
122 "location": "query", | |
123 "type": "boolean" | |
124 } | 124 } |
125 }, | 125 }, |
126 "protocol": "rest", | 126 "protocol": "rest", |
127 "resources": { | 127 "resources": { |
128 "variants": { | 128 "operations": { |
129 "methods": { | 129 "methods": { |
130 "search": { | 130 "list": { |
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).
", | 131 "description": "Lists operations that match the specified fi
lter in the request.", |
132 "httpMethod": "POST", | 132 "httpMethod": "GET", |
133 "id": "genomics.variants.search", | 133 "id": "genomics.operations.list", |
134 "parameterOrder": [], | |
135 "parameters": {}, | |
136 "path": "v1/variants/search", | |
137 "request": { | |
138 "$ref": "SearchVariantsRequest" | |
139 }, | |
140 "response": { | |
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": [ | 134 "parameterOrder": [ |
154 "variantId" | 135 "name" |
155 ], | 136 ], |
156 "parameters": { | 137 "parameters": { |
157 "variantId": { | 138 "name": { |
158 "description": "The ID of the variant to be updated.
", | 139 "description": "The name of the operation collection
.", |
159 "location": "path", | 140 "location": "path", |
| 141 "pattern": "^operations$", |
160 "required": true, | 142 "required": true, |
161 "type": "string" | 143 "type": "string" |
162 }, | 144 }, |
163 "updateMask": { | 145 "pageToken": { |
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.", | 146 "description": "The standard list page token.", |
165 "format": "google-fieldmask", | 147 "location": "query", |
| 148 "type": "string" |
| 149 }, |
| 150 "pageSize": { |
| 151 "description": "The maximum number of results to ret
urn. If unspecified, defaults to\n256. The maximum value is 2048.", |
| 152 "format": "int32", |
| 153 "location": "query", |
| 154 "type": "integer" |
| 155 }, |
| 156 "filter": { |
| 157 "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`", |
166 "location": "query", | 158 "location": "query", |
167 "type": "string" | 159 "type": "string" |
168 } | 160 } |
169 }, | 161 }, |
170 "path": "v1/variants/{variantId}", | 162 "path": "v1/{+name}", |
171 "request": { | |
172 "$ref": "Variant" | |
173 }, | |
174 "response": { | 163 "response": { |
175 "$ref": "Variant" | 164 "$ref": "ListOperationsResponse" |
176 }, | 165 }, |
177 "scopes": [ | 166 "scopes": [ |
178 "https://www.googleapis.com/auth/cloud-platform", | 167 "https://www.googleapis.com/auth/cloud-platform", |
179 "https://www.googleapis.com/auth/genomics" | 168 "https://www.googleapis.com/auth/genomics" |
180 ] | 169 ] |
181 }, | 170 }, |
182 "get": { | 171 "get": { |
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)", | 172 "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.", |
184 "httpMethod": "GET", | 173 "httpMethod": "GET", |
185 "id": "genomics.variants.get", | 174 "id": "genomics.operations.get", |
186 "parameterOrder": [ | 175 "parameterOrder": [ |
187 "variantId" | 176 "name" |
188 ], | 177 ], |
189 "parameters": { | 178 "parameters": { |
190 "variantId": { | 179 "name": { |
191 "description": "The ID of the variant.", | 180 "description": "The name of the operation resource."
, |
192 "location": "path", | 181 "location": "path", |
| 182 "pattern": "^operations/.+$", |
193 "required": true, | 183 "required": true, |
194 "type": "string" | 184 "type": "string" |
195 } | 185 } |
196 }, | 186 }, |
197 "path": "v1/variants/{variantId}", | 187 "path": "v1/{+name}", |
198 "response": { | 188 "response": { |
199 "$ref": "Variant" | 189 "$ref": "Operation" |
200 }, | 190 }, |
201 "scopes": [ | 191 "scopes": [ |
202 "https://www.googleapis.com/auth/cloud-platform", | 192 "https://www.googleapis.com/auth/cloud-platform", |
203 "https://www.googleapis.com/auth/genomics", | 193 "https://www.googleapis.com/auth/genomics" |
204 "https://www.googleapis.com/auth/genomics.readonly" | |
205 ] | 194 ] |
206 }, | 195 }, |
207 "merge": { | 196 "cancel": { |
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.", | 197 "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.", |
209 "httpMethod": "POST", | 198 "httpMethod": "POST", |
210 "id": "genomics.variants.merge", | 199 "id": "genomics.operations.cancel", |
211 "parameterOrder": [], | 200 "parameterOrder": [ |
212 "parameters": {}, | 201 "name" |
213 "path": "v1/variants:merge", | 202 ], |
| 203 "parameters": { |
| 204 "name": { |
| 205 "description": "The name of the operation resource t
o be cancelled.", |
| 206 "location": "path", |
| 207 "pattern": "^operations/.+$", |
| 208 "required": true, |
| 209 "type": "string" |
| 210 } |
| 211 }, |
| 212 "path": "v1/{+name}:cancel", |
214 "request": { | 213 "request": { |
215 "$ref": "MergeVariantsRequest" | 214 "$ref": "CancelOperationRequest" |
216 }, | 215 }, |
217 "response": { | 216 "response": { |
218 "$ref": "Empty" | 217 "$ref": "Empty" |
219 }, | 218 }, |
220 "scopes": [ | 219 "scopes": [ |
221 "https://www.googleapis.com/auth/cloud-platform", | 220 "https://www.googleapis.com/auth/cloud-platform", |
222 "https://www.googleapis.com/auth/genomics" | 221 "https://www.googleapis.com/auth/genomics" |
223 ] | 222 ] |
224 }, | 223 } |
225 "import": { | 224 } |
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.", | 225 }, |
| 226 "referencesets": { |
| 227 "methods": { |
| 228 "search": { |
| 229 "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)", |
227 "httpMethod": "POST", | 230 "httpMethod": "POST", |
228 "id": "genomics.variants.import", | 231 "id": "genomics.referencesets.search", |
229 "parameterOrder": [], | 232 "parameterOrder": [], |
230 "parameters": {}, | 233 "parameters": {}, |
231 "path": "v1/variants:import", | 234 "path": "v1/referencesets/search", |
232 "request": { | 235 "request": { |
233 "$ref": "ImportVariantsRequest" | 236 "$ref": "SearchReferenceSetsRequest" |
| 237 }, |
| 238 "response": { |
| 239 "$ref": "SearchReferenceSetsResponse" |
| 240 }, |
| 241 "scopes": [ |
| 242 "https://www.googleapis.com/auth/cloud-platform", |
| 243 "https://www.googleapis.com/auth/genomics", |
| 244 "https://www.googleapis.com/auth/genomics.readonly" |
| 245 ] |
| 246 }, |
| 247 "get": { |
| 248 "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).", |
| 249 "httpMethod": "GET", |
| 250 "id": "genomics.referencesets.get", |
| 251 "parameterOrder": [ |
| 252 "referenceSetId" |
| 253 ], |
| 254 "parameters": { |
| 255 "referenceSetId": { |
| 256 "description": "The ID of the reference set.", |
| 257 "location": "path", |
| 258 "required": true, |
| 259 "type": "string" |
| 260 } |
| 261 }, |
| 262 "path": "v1/referencesets/{referenceSetId}", |
| 263 "response": { |
| 264 "$ref": "ReferenceSet" |
| 265 }, |
| 266 "scopes": [ |
| 267 "https://www.googleapis.com/auth/cloud-platform", |
| 268 "https://www.googleapis.com/auth/genomics", |
| 269 "https://www.googleapis.com/auth/genomics.readonly" |
| 270 ] |
| 271 } |
| 272 } |
| 273 }, |
| 274 "readgroupsets": { |
| 275 "methods": { |
| 276 "import": { |
| 277 "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)", |
| 278 "httpMethod": "POST", |
| 279 "id": "genomics.readgroupsets.import", |
| 280 "parameterOrder": [], |
| 281 "parameters": {}, |
| 282 "path": "v1/readgroupsets:import", |
| 283 "request": { |
| 284 "$ref": "ImportReadGroupSetsRequest" |
234 }, | 285 }, |
235 "response": { | 286 "response": { |
236 "$ref": "Operation" | 287 "$ref": "Operation" |
237 }, | 288 }, |
238 "scopes": [ | 289 "scopes": [ |
239 "https://www.googleapis.com/auth/cloud-platform", | 290 "https://www.googleapis.com/auth/cloud-platform", |
240 "https://www.googleapis.com/auth/devstorage.read_write", | 291 "https://www.googleapis.com/auth/devstorage.read_write", |
241 "https://www.googleapis.com/auth/genomics" | 292 "https://www.googleapis.com/auth/genomics" |
242 ] | 293 ] |
243 }, | 294 }, |
244 "delete": { | 295 "delete": { |
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)", | 296 "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)
", |
246 "httpMethod": "DELETE", | 297 "httpMethod": "DELETE", |
247 "id": "genomics.variants.delete", | 298 "id": "genomics.readgroupsets.delete", |
248 "parameterOrder": [ | 299 "parameterOrder": [ |
249 "variantId" | 300 "readGroupSetId" |
250 ], | 301 ], |
251 "parameters": { | 302 "parameters": { |
252 "variantId": { | 303 "readGroupSetId": { |
253 "description": "The ID of the variant to be deleted.
", | 304 "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.", |
254 "location": "path", | 305 "location": "path", |
255 "required": true, | 306 "required": true, |
256 "type": "string" | 307 "type": "string" |
257 } | 308 } |
258 }, | 309 }, |
259 "path": "v1/variants/{variantId}", | 310 "path": "v1/readgroupsets/{readGroupSetId}", |
260 "response": { | 311 "response": { |
261 "$ref": "Empty" | 312 "$ref": "Empty" |
262 }, | 313 }, |
263 "scopes": [ | |
264 "https://www.googleapis.com/auth/cloud-platform", | |
265 "https://www.googleapis.com/auth/genomics" | |
266 ] | |
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": [ | 314 "scopes": [ |
310 "https://www.googleapis.com/auth/cloud-platform", | 315 "https://www.googleapis.com/auth/cloud-platform", |
311 "https://www.googleapis.com/auth/genomics" | 316 "https://www.googleapis.com/auth/genomics" |
312 ] | 317 ] |
313 }, | 318 }, |
| 319 "export": { |
| 320 "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.", |
| 321 "httpMethod": "POST", |
| 322 "id": "genomics.readgroupsets.export", |
| 323 "parameterOrder": [ |
| 324 "readGroupSetId" |
| 325 ], |
| 326 "parameters": { |
| 327 "readGroupSetId": { |
| 328 "description": "Required. The ID of the read group s
et to export. The caller must have\nREAD access to this read group set.", |
| 329 "location": "path", |
| 330 "required": true, |
| 331 "type": "string" |
| 332 } |
| 333 }, |
| 334 "path": "v1/readgroupsets/{readGroupSetId}:export", |
| 335 "request": { |
| 336 "$ref": "ExportReadGroupSetRequest" |
| 337 }, |
| 338 "response": { |
| 339 "$ref": "Operation" |
| 340 }, |
| 341 "scopes": [ |
| 342 "https://www.googleapis.com/auth/cloud-platform", |
| 343 "https://www.googleapis.com/auth/devstorage.read_write", |
| 344 "https://www.googleapis.com/auth/genomics" |
| 345 ] |
| 346 }, |
314 "search": { | 347 "search": { |
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.", | 348 "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).", |
316 "httpMethod": "POST", | 349 "httpMethod": "POST", |
317 "id": "genomics.annotationsets.search", | 350 "id": "genomics.readgroupsets.search", |
318 "parameterOrder": [], | 351 "parameterOrder": [], |
319 "parameters": {}, | 352 "parameters": {}, |
320 "path": "v1/annotationsets/search", | 353 "path": "v1/readgroupsets/search", |
321 "request": { | 354 "request": { |
322 "$ref": "SearchAnnotationSetsRequest" | 355 "$ref": "SearchReadGroupSetsRequest" |
323 }, | 356 }, |
324 "response": { | 357 "response": { |
325 "$ref": "SearchAnnotationSetsResponse" | 358 "$ref": "SearchReadGroupSetsResponse" |
326 }, | 359 }, |
327 "scopes": [ | 360 "scopes": [ |
328 "https://www.googleapis.com/auth/cloud-platform", | 361 "https://www.googleapis.com/auth/cloud-platform", |
329 "https://www.googleapis.com/auth/genomics", | 362 "https://www.googleapis.com/auth/genomics", |
330 "https://www.googleapis.com/auth/genomics.readonly" | 363 "https://www.googleapis.com/auth/genomics.readonly" |
331 ] | 364 ] |
332 }, | 365 }, |
333 "get": { | 366 "patch": { |
334 "description": "Gets an annotation set. Caller must have REA
D permission for\nthe associated dataset.", | 367 "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.", |
335 "httpMethod": "GET", | 368 "httpMethod": "PATCH", |
336 "id": "genomics.annotationsets.get", | 369 "id": "genomics.readgroupsets.patch", |
337 "parameterOrder": [ | 370 "parameterOrder": [ |
338 "annotationSetId" | 371 "readGroupSetId" |
339 ], | 372 ], |
340 "parameters": { | 373 "parameters": { |
341 "annotationSetId": { | 374 "readGroupSetId": { |
342 "description": "The ID of the annotation set to be r
etrieved.", | 375 "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.", |
343 "location": "path", | 376 "location": "path", |
344 "required": true, | 377 "required": true, |
345 "type": "string" | 378 "type": "string" |
346 } | 379 }, |
347 }, | |
348 "path": "v1/annotationsets/{annotationSetId}", | |
349 "response": { | |
350 "$ref": "AnnotationSet" | |
351 }, | |
352 "scopes": [ | |
353 "https://www.googleapis.com/auth/cloud-platform", | |
354 "https://www.googleapis.com/auth/genomics", | |
355 "https://www.googleapis.com/auth/genomics.readonly" | |
356 ] | |
357 }, | |
358 "update": { | |
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
.", | |
360 "httpMethod": "PUT", | |
361 "id": "genomics.annotationsets.update", | |
362 "parameterOrder": [ | |
363 "annotationSetId" | |
364 ], | |
365 "parameters": { | |
366 "updateMask": { | 380 "updateMask": { |
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.", | 381 "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.", |
368 "format": "google-fieldmask", | 382 "format": "google-fieldmask", |
369 "location": "query", | 383 "location": "query", |
370 "type": "string" | 384 "type": "string" |
371 }, | |
372 "annotationSetId": { | |
373 "description": "The ID of the annotation set to be u
pdated.", | |
374 "location": "path", | |
375 "required": true, | |
376 "type": "string" | |
377 } | 385 } |
378 }, | 386 }, |
379 "path": "v1/annotationsets/{annotationSetId}", | 387 "path": "v1/readgroupsets/{readGroupSetId}", |
380 "request": { | 388 "request": { |
381 "$ref": "AnnotationSet" | 389 "$ref": "ReadGroupSet" |
382 }, | 390 }, |
383 "response": { | 391 "response": { |
384 "$ref": "AnnotationSet" | 392 "$ref": "ReadGroupSet" |
385 }, | 393 }, |
386 "scopes": [ | 394 "scopes": [ |
387 "https://www.googleapis.com/auth/cloud-platform", | 395 "https://www.googleapis.com/auth/cloud-platform", |
388 "https://www.googleapis.com/auth/genomics" | 396 "https://www.googleapis.com/auth/genomics" |
389 ] | 397 ] |
390 }, | 398 }, |
391 "create": { | |
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).", | |
393 "httpMethod": "POST", | |
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": { | 399 "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).", | 400 "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)", |
434 "httpMethod": "GET", | 401 "httpMethod": "GET", |
435 "id": "genomics.references.get", | 402 "id": "genomics.readgroupsets.get", |
436 "parameterOrder": [ | 403 "parameterOrder": [ |
437 "referenceId" | 404 "readGroupSetId" |
438 ], | 405 ], |
439 "parameters": { | 406 "parameters": { |
440 "referenceId": { | 407 "readGroupSetId": { |
441 "description": "The ID of the reference.", | 408 "description": "The ID of the read group set.", |
442 "location": "path", | 409 "location": "path", |
443 "required": true, | 410 "required": true, |
444 "type": "string" | 411 "type": "string" |
445 } | 412 } |
446 }, | 413 }, |
447 "path": "v1/references/{referenceId}", | 414 "path": "v1/readgroupsets/{readGroupSetId}", |
448 "response": { | 415 "response": { |
449 "$ref": "Reference" | 416 "$ref": "ReadGroupSet" |
450 }, | 417 }, |
451 "scopes": [ | 418 "scopes": [ |
452 "https://www.googleapis.com/auth/cloud-platform", | 419 "https://www.googleapis.com/auth/cloud-platform", |
453 "https://www.googleapis.com/auth/genomics", | 420 "https://www.googleapis.com/auth/genomics", |
454 "https://www.googleapis.com/auth/genomics.readonly" | 421 "https://www.googleapis.com/auth/genomics.readonly" |
455 ] | 422 ] |
456 } | 423 } |
457 }, | 424 }, |
458 "resources": { | 425 "resources": { |
459 "bases": { | 426 "coveragebuckets": { |
460 "methods": { | 427 "methods": { |
461 "list": { | 428 "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).", | 429 "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.", |
463 "httpMethod": "GET", | 430 "httpMethod": "GET", |
464 "id": "genomics.references.bases.list", | 431 "id": "genomics.readgroupsets.coveragebuckets.list", |
465 "parameterOrder": [ | 432 "parameterOrder": [ |
466 "referenceId" | 433 "readGroupSetId" |
467 ], | 434 ], |
468 "parameters": { | 435 "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": { | 436 "start": { |
476 "description": "The start position (0-based)
of this query. Defaults to 0.", | 437 "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.", |
477 "format": "int64", | 438 "format": "int64", |
478 "location": "query", | 439 "location": "query", |
479 "type": "string" | 440 "type": "string" |
480 }, | 441 }, |
481 "referenceId": { | 442 "targetBucketWidth": { |
482 "description": "The ID of the reference.", | 443 "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.", |
| 444 "format": "int64", |
| 445 "location": "query", |
| 446 "type": "string" |
| 447 }, |
| 448 "readGroupSetId": { |
| 449 "description": "Required. The ID of the read
group set over which coverage is requested.", |
483 "location": "path", | 450 "location": "path", |
484 "required": true, | 451 "required": true, |
485 "type": "string" | 452 "type": "string" |
486 }, | 453 }, |
| 454 "referenceName": { |
| 455 "description": "The name of the reference to
query, within the reference set associated\nwith this query. Optional.", |
| 456 "location": "query", |
| 457 "type": "string" |
| 458 }, |
487 "end": { | 459 "end": { |
488 "description": "The end position (0-based, e
xclusive) of this query. Defaults to the length\nof this reference.", | 460 "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.", |
489 "format": "int64", | 461 "format": "int64", |
490 "location": "query", | 462 "location": "query", |
491 "type": "string" | 463 "type": "string" |
492 }, | 464 }, |
493 "pageToken": { | 465 "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.", | 466 "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", | 467 "location": "query", |
496 "type": "string" | 468 "type": "string" |
| 469 }, |
| 470 "pageSize": { |
| 471 "description": "The maximum number of result
s to return in a single page. If unspecified,\ndefaults to 1024. The maximum val
ue is 2048.", |
| 472 "format": "int32", |
| 473 "location": "query", |
| 474 "type": "integer" |
497 } | 475 } |
498 }, | 476 }, |
499 "path": "v1/references/{referenceId}/bases", | 477 "path": "v1/readgroupsets/{readGroupSetId}/coverageb
uckets", |
500 "response": { | 478 "response": { |
501 "$ref": "ListBasesResponse" | 479 "$ref": "ListCoverageBucketsResponse" |
502 }, | 480 }, |
503 "scopes": [ | 481 "scopes": [ |
504 "https://www.googleapis.com/auth/cloud-platform"
, | 482 "https://www.googleapis.com/auth/cloud-platform"
, |
505 "https://www.googleapis.com/auth/genomics", | 483 "https://www.googleapis.com/auth/genomics", |
506 "https://www.googleapis.com/auth/genomics.readon
ly" | 484 "https://www.googleapis.com/auth/genomics.readon
ly" |
507 ] | 485 ] |
508 } | 486 } |
509 } | 487 } |
510 } | 488 } |
511 } | 489 } |
512 }, | 490 }, |
513 "datasets": { | 491 "reads": { |
514 "methods": { | 492 "methods": { |
515 "testIamPermissions": { | 493 "search": { |
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)", | 494 "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).", |
517 "httpMethod": "POST", | 495 "httpMethod": "POST", |
518 "id": "genomics.datasets.testIamPermissions", | 496 "id": "genomics.reads.search", |
519 "parameterOrder": [ | 497 "parameterOrder": [], |
520 "resource" | 498 "parameters": {}, |
521 ], | 499 "path": "v1/reads/search", |
522 "parameters": { | |
523 "resource": { | |
524 "description": "REQUIRED: The resource for which pol
icy is being specified. Format is\n`datasets/<dataset ID>`.", | |
525 "location": "path", | |
526 "pattern": "^datasets/[^/]+$", | |
527 "required": true, | |
528 "type": "string" | |
529 } | |
530 }, | |
531 "path": "v1/{+resource}:testIamPermissions", | |
532 "request": { | 500 "request": { |
533 "$ref": "TestIamPermissionsRequest" | 501 "$ref": "SearchReadsRequest" |
534 }, | 502 }, |
535 "response": { | 503 "response": { |
536 "$ref": "TestIamPermissionsResponse" | 504 "$ref": "SearchReadsResponse" |
537 }, | |
538 "scopes": [ | |
539 "https://www.googleapis.com/auth/cloud-platform", | |
540 "https://www.googleapis.com/auth/genomics" | |
541 ] | |
542 }, | |
543 "delete": { | |
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)", | |
545 "httpMethod": "DELETE", | |
546 "id": "genomics.datasets.delete", | |
547 "parameterOrder": [ | |
548 "datasetId" | |
549 ], | |
550 "parameters": { | |
551 "datasetId": { | |
552 "description": "The ID of the dataset to be deleted.
", | |
553 "location": "path", | |
554 "required": true, | |
555 "type": "string" | |
556 } | |
557 }, | |
558 "path": "v1/datasets/{datasetId}", | |
559 "response": { | |
560 "$ref": "Empty" | |
561 }, | |
562 "scopes": [ | |
563 "https://www.googleapis.com/auth/cloud-platform", | |
564 "https://www.googleapis.com/auth/genomics" | |
565 ] | |
566 }, | |
567 "list": { | |
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)
", | |
569 "httpMethod": "GET", | |
570 "id": "genomics.datasets.list", | |
571 "parameterOrder": [], | |
572 "parameters": { | |
573 "pageSize": { | |
574 "description": "The maximum number of results to ret
urn in a single page. If unspecified,\ndefaults to 50. The maximum value is 1024
.", | |
575 "format": "int32", | |
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", | |
587 "type": "string" | |
588 } | |
589 }, | |
590 "path": "v1/datasets", | |
591 "response": { | |
592 "$ref": "ListDatasetsResponse" | |
593 }, | 505 }, |
594 "scopes": [ | 506 "scopes": [ |
595 "https://www.googleapis.com/auth/cloud-platform", | 507 "https://www.googleapis.com/auth/cloud-platform", |
596 "https://www.googleapis.com/auth/genomics", | 508 "https://www.googleapis.com/auth/genomics", |
597 "https://www.googleapis.com/auth/genomics.readonly" | 509 "https://www.googleapis.com/auth/genomics.readonly" |
598 ] | 510 ] |
599 }, | 511 } |
600 "setIamPolicy": { | 512 } |
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.", | 513 }, |
602 "httpMethod": "POST", | 514 "callsets": { |
603 "id": "genomics.datasets.setIamPolicy", | 515 "methods": { |
| 516 "patch": { |
| 517 "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.", |
| 518 "httpMethod": "PATCH", |
| 519 "id": "genomics.callsets.patch", |
604 "parameterOrder": [ | 520 "parameterOrder": [ |
605 "resource" | 521 "callSetId" |
606 ], | 522 ], |
607 "parameters": { | 523 "parameters": { |
608 "resource": { | 524 "callSetId": { |
609 "description": "REQUIRED: The resource for which pol
icy is being specified. Format is\n`datasets/<dataset ID>`.", | 525 "description": "The ID of the call set to be updated
.", |
610 "location": "path", | |
611 "pattern": "^datasets/[^/]+$", | |
612 "required": true, | |
613 "type": "string" | |
614 } | |
615 }, | |
616 "path": "v1/{+resource}:setIamPolicy", | |
617 "request": { | |
618 "$ref": "SetIamPolicyRequest" | |
619 }, | |
620 "response": { | |
621 "$ref": "Policy" | |
622 }, | |
623 "scopes": [ | |
624 "https://www.googleapis.com/auth/cloud-platform", | |
625 "https://www.googleapis.com/auth/genomics" | |
626 ] | |
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 }, | |
646 "getIamPolicy": { | |
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)", | |
648 "httpMethod": "POST", | |
649 "id": "genomics.datasets.getIamPolicy", | |
650 "parameterOrder": [ | |
651 "resource" | |
652 ], | |
653 "parameters": { | |
654 "resource": { | |
655 "description": "REQUIRED: The resource for which pol
icy is being specified. Format is\n`datasets/<dataset ID>`.", | |
656 "location": "path", | |
657 "pattern": "^datasets/[^/]+$", | |
658 "required": true, | |
659 "type": "string" | |
660 } | |
661 }, | |
662 "path": "v1/{+resource}:getIamPolicy", | |
663 "request": { | |
664 "$ref": "GetIamPolicyRequest" | |
665 }, | |
666 "response": { | |
667 "$ref": "Policy" | |
668 }, | |
669 "scopes": [ | |
670 "https://www.googleapis.com/auth/cloud-platform", | |
671 "https://www.googleapis.com/auth/genomics" | |
672 ] | |
673 }, | |
674 "patch": { | |
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.", | |
676 "httpMethod": "PATCH", | |
677 "id": "genomics.datasets.patch", | |
678 "parameterOrder": [ | |
679 "datasetId" | |
680 ], | |
681 "parameters": { | |
682 "datasetId": { | |
683 "description": "The ID of the dataset to be updated.
", | |
684 "location": "path", | 526 "location": "path", |
685 "required": true, | 527 "required": true, |
686 "type": "string" | 528 "type": "string" |
687 }, | 529 }, |
688 "updateMask": { | 530 "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.", | 531 "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", | 532 "format": "google-fieldmask", |
691 "location": "query", | 533 "location": "query", |
692 "type": "string" | 534 "type": "string" |
693 } | 535 } |
694 }, | 536 }, |
695 "path": "v1/datasets/{datasetId}", | 537 "path": "v1/callsets/{callSetId}", |
696 "request": { | 538 "request": { |
697 "$ref": "Dataset" | 539 "$ref": "CallSet" |
698 }, | 540 }, |
699 "response": { | 541 "response": { |
700 "$ref": "Dataset" | 542 "$ref": "CallSet" |
701 }, | 543 }, |
702 "scopes": [ | 544 "scopes": [ |
703 "https://www.googleapis.com/auth/cloud-platform", | 545 "https://www.googleapis.com/auth/cloud-platform", |
| 546 "https://www.googleapis.com/auth/genomics" |
| 547 ] |
| 548 }, |
| 549 "get": { |
| 550 "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)", |
| 551 "httpMethod": "GET", |
| 552 "id": "genomics.callsets.get", |
| 553 "parameterOrder": [ |
| 554 "callSetId" |
| 555 ], |
| 556 "parameters": { |
| 557 "callSetId": { |
| 558 "description": "The ID of the call set.", |
| 559 "location": "path", |
| 560 "required": true, |
| 561 "type": "string" |
| 562 } |
| 563 }, |
| 564 "path": "v1/callsets/{callSetId}", |
| 565 "response": { |
| 566 "$ref": "CallSet" |
| 567 }, |
| 568 "scopes": [ |
| 569 "https://www.googleapis.com/auth/cloud-platform", |
| 570 "https://www.googleapis.com/auth/genomics", |
| 571 "https://www.googleapis.com/auth/genomics.readonly" |
| 572 ] |
| 573 }, |
| 574 "create": { |
| 575 "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)", |
| 576 "httpMethod": "POST", |
| 577 "id": "genomics.callsets.create", |
| 578 "parameterOrder": [], |
| 579 "parameters": {}, |
| 580 "path": "v1/callsets", |
| 581 "request": { |
| 582 "$ref": "CallSet" |
| 583 }, |
| 584 "response": { |
| 585 "$ref": "CallSet" |
| 586 }, |
| 587 "scopes": [ |
| 588 "https://www.googleapis.com/auth/cloud-platform", |
| 589 "https://www.googleapis.com/auth/genomics" |
| 590 ] |
| 591 }, |
| 592 "delete": { |
| 593 "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)", |
| 594 "httpMethod": "DELETE", |
| 595 "id": "genomics.callsets.delete", |
| 596 "parameterOrder": [ |
| 597 "callSetId" |
| 598 ], |
| 599 "parameters": { |
| 600 "callSetId": { |
| 601 "description": "The ID of the call set to be deleted
.", |
| 602 "location": "path", |
| 603 "required": true, |
| 604 "type": "string" |
| 605 } |
| 606 }, |
| 607 "path": "v1/callsets/{callSetId}", |
| 608 "response": { |
| 609 "$ref": "Empty" |
| 610 }, |
| 611 "scopes": [ |
| 612 "https://www.googleapis.com/auth/cloud-platform", |
| 613 "https://www.googleapis.com/auth/genomics" |
| 614 ] |
| 615 }, |
| 616 "search": { |
| 617 "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
).", |
| 618 "httpMethod": "POST", |
| 619 "id": "genomics.callsets.search", |
| 620 "parameterOrder": [], |
| 621 "parameters": {}, |
| 622 "path": "v1/callsets/search", |
| 623 "request": { |
| 624 "$ref": "SearchCallSetsRequest" |
| 625 }, |
| 626 "response": { |
| 627 "$ref": "SearchCallSetsResponse" |
| 628 }, |
| 629 "scopes": [ |
| 630 "https://www.googleapis.com/auth/cloud-platform", |
| 631 "https://www.googleapis.com/auth/genomics", |
| 632 "https://www.googleapis.com/auth/genomics.readonly" |
| 633 ] |
| 634 } |
| 635 } |
| 636 }, |
| 637 "variants": { |
| 638 "methods": { |
| 639 "patch": { |
| 640 "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.", |
| 641 "httpMethod": "PATCH", |
| 642 "id": "genomics.variants.patch", |
| 643 "parameterOrder": [ |
| 644 "variantId" |
| 645 ], |
| 646 "parameters": { |
| 647 "variantId": { |
| 648 "description": "The ID of the variant to be updated.
", |
| 649 "location": "path", |
| 650 "required": true, |
| 651 "type": "string" |
| 652 }, |
| 653 "updateMask": { |
| 654 "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.", |
| 655 "format": "google-fieldmask", |
| 656 "location": "query", |
| 657 "type": "string" |
| 658 } |
| 659 }, |
| 660 "path": "v1/variants/{variantId}", |
| 661 "request": { |
| 662 "$ref": "Variant" |
| 663 }, |
| 664 "response": { |
| 665 "$ref": "Variant" |
| 666 }, |
| 667 "scopes": [ |
| 668 "https://www.googleapis.com/auth/cloud-platform", |
704 "https://www.googleapis.com/auth/genomics" | 669 "https://www.googleapis.com/auth/genomics" |
705 ] | 670 ] |
706 }, | 671 }, |
707 "get": { | 672 "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)", | 673 "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)", |
709 "httpMethod": "GET", | 674 "httpMethod": "GET", |
710 "id": "genomics.datasets.get", | 675 "id": "genomics.variants.get", |
711 "parameterOrder": [ | 676 "parameterOrder": [ |
712 "datasetId" | 677 "variantId" |
713 ], | 678 ], |
714 "parameters": { | 679 "parameters": { |
715 "datasetId": { | 680 "variantId": { |
716 "description": "The ID of the dataset.", | 681 "description": "The ID of the variant.", |
717 "location": "path", | 682 "location": "path", |
718 "required": true, | 683 "required": true, |
719 "type": "string" | 684 "type": "string" |
720 } | 685 } |
721 }, | 686 }, |
722 "path": "v1/datasets/{datasetId}", | 687 "path": "v1/variants/{variantId}", |
723 "response": { | 688 "response": { |
724 "$ref": "Dataset" | 689 "$ref": "Variant" |
725 }, | 690 }, |
726 "scopes": [ | 691 "scopes": [ |
727 "https://www.googleapis.com/auth/cloud-platform", | 692 "https://www.googleapis.com/auth/cloud-platform", |
728 "https://www.googleapis.com/auth/genomics", | 693 "https://www.googleapis.com/auth/genomics", |
729 "https://www.googleapis.com/auth/genomics.readonly" | 694 "https://www.googleapis.com/auth/genomics.readonly" |
730 ] | 695 ] |
731 }, | 696 }, |
732 "undelete": { | 697 "import": { |
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.", | 698 "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.", |
734 "httpMethod": "POST", | 699 "httpMethod": "POST", |
735 "id": "genomics.datasets.undelete", | 700 "id": "genomics.variants.import", |
736 "parameterOrder": [ | 701 "parameterOrder": [], |
737 "datasetId" | 702 "parameters": {}, |
738 ], | 703 "path": "v1/variants:import", |
739 "parameters": { | 704 "request": { |
740 "datasetId": { | 705 "$ref": "ImportVariantsRequest" |
741 "description": "The ID of the dataset to be undelete
d.", | 706 }, |
742 "location": "path", | 707 "response": { |
743 "required": true, | 708 "$ref": "Operation" |
744 "type": "string" | 709 }, |
745 } | 710 "scopes": [ |
746 }, | 711 "https://www.googleapis.com/auth/cloud-platform", |
747 "path": "v1/datasets/{datasetId}:undelete", | 712 "https://www.googleapis.com/auth/devstorage.read_write", |
748 "request": { | 713 "https://www.googleapis.com/auth/genomics" |
749 "$ref": "UndeleteDatasetRequest" | 714 ] |
750 }, | 715 }, |
751 "response": { | 716 "delete": { |
752 "$ref": "Dataset" | 717 "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)", |
753 }, | 718 "httpMethod": "DELETE", |
754 "scopes": [ | 719 "id": "genomics.variants.delete", |
755 "https://www.googleapis.com/auth/cloud-platform", | 720 "parameterOrder": [ |
756 "https://www.googleapis.com/auth/genomics" | 721 "variantId" |
| 722 ], |
| 723 "parameters": { |
| 724 "variantId": { |
| 725 "description": "The ID of the variant to be deleted.
", |
| 726 "location": "path", |
| 727 "required": true, |
| 728 "type": "string" |
| 729 } |
| 730 }, |
| 731 "path": "v1/variants/{variantId}", |
| 732 "response": { |
| 733 "$ref": "Empty" |
| 734 }, |
| 735 "scopes": [ |
| 736 "https://www.googleapis.com/auth/cloud-platform", |
| 737 "https://www.googleapis.com/auth/genomics" |
| 738 ] |
| 739 }, |
| 740 "merge": { |
| 741 "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.", |
| 742 "httpMethod": "POST", |
| 743 "id": "genomics.variants.merge", |
| 744 "parameterOrder": [], |
| 745 "parameters": {}, |
| 746 "path": "v1/variants:merge", |
| 747 "request": { |
| 748 "$ref": "MergeVariantsRequest" |
| 749 }, |
| 750 "response": { |
| 751 "$ref": "Empty" |
| 752 }, |
| 753 "scopes": [ |
| 754 "https://www.googleapis.com/auth/cloud-platform", |
| 755 "https://www.googleapis.com/auth/genomics" |
| 756 ] |
| 757 }, |
| 758 "create": { |
| 759 "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)", |
| 760 "httpMethod": "POST", |
| 761 "id": "genomics.variants.create", |
| 762 "parameterOrder": [], |
| 763 "parameters": {}, |
| 764 "path": "v1/variants", |
| 765 "request": { |
| 766 "$ref": "Variant" |
| 767 }, |
| 768 "response": { |
| 769 "$ref": "Variant" |
| 770 }, |
| 771 "scopes": [ |
| 772 "https://www.googleapis.com/auth/cloud-platform", |
| 773 "https://www.googleapis.com/auth/genomics" |
| 774 ] |
| 775 }, |
| 776 "search": { |
| 777 "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).
", |
| 778 "httpMethod": "POST", |
| 779 "id": "genomics.variants.search", |
| 780 "parameterOrder": [], |
| 781 "parameters": {}, |
| 782 "path": "v1/variants/search", |
| 783 "request": { |
| 784 "$ref": "SearchVariantsRequest" |
| 785 }, |
| 786 "response": { |
| 787 "$ref": "SearchVariantsResponse" |
| 788 }, |
| 789 "scopes": [ |
| 790 "https://www.googleapis.com/auth/cloud-platform", |
| 791 "https://www.googleapis.com/auth/genomics", |
| 792 "https://www.googleapis.com/auth/genomics.readonly" |
757 ] | 793 ] |
758 } | 794 } |
759 } | 795 } |
760 }, | 796 }, |
761 "annotations": { | 797 "annotationsets": { |
762 "methods": { | 798 "methods": { |
| 799 "delete": { |
| 800 "description": "Deletes an annotation set. Caller must have
WRITE permission\nfor the associated annotation set.", |
| 801 "httpMethod": "DELETE", |
| 802 "id": "genomics.annotationsets.delete", |
| 803 "parameterOrder": [ |
| 804 "annotationSetId" |
| 805 ], |
| 806 "parameters": { |
| 807 "annotationSetId": { |
| 808 "description": "The ID of the annotation set to be d
eleted.", |
| 809 "location": "path", |
| 810 "required": true, |
| 811 "type": "string" |
| 812 } |
| 813 }, |
| 814 "path": "v1/annotationsets/{annotationSetId}", |
| 815 "response": { |
| 816 "$ref": "Empty" |
| 817 }, |
| 818 "scopes": [ |
| 819 "https://www.googleapis.com/auth/cloud-platform", |
| 820 "https://www.googleapis.com/auth/genomics" |
| 821 ] |
| 822 }, |
763 "search": { | 823 "search": { |
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.", | 824 "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.", |
765 "httpMethod": "POST", | 825 "httpMethod": "POST", |
766 "id": "genomics.annotations.search", | 826 "id": "genomics.annotationsets.search", |
767 "parameterOrder": [], | 827 "parameterOrder": [], |
768 "parameters": {}, | 828 "parameters": {}, |
769 "path": "v1/annotations/search", | 829 "path": "v1/annotationsets/search", |
770 "request": { | 830 "request": { |
771 "$ref": "SearchAnnotationsRequest" | 831 "$ref": "SearchAnnotationSetsRequest" |
772 }, | 832 }, |
773 "response": { | 833 "response": { |
774 "$ref": "SearchAnnotationsResponse" | 834 "$ref": "SearchAnnotationSetsResponse" |
775 }, | 835 }, |
776 "scopes": [ | 836 "scopes": [ |
777 "https://www.googleapis.com/auth/cloud-platform", | 837 "https://www.googleapis.com/auth/cloud-platform", |
778 "https://www.googleapis.com/auth/genomics", | 838 "https://www.googleapis.com/auth/genomics", |
779 "https://www.googleapis.com/auth/genomics.readonly" | 839 "https://www.googleapis.com/auth/genomics.readonly" |
780 ] | 840 ] |
781 }, | 841 }, |
782 "get": { | 842 "get": { |
783 "description": "Gets an annotation. Caller must have READ pe
rmission\nfor the associated annotation set.", | 843 "description": "Gets an annotation set. Caller must have REA
D permission for\nthe associated dataset.", |
784 "httpMethod": "GET", | 844 "httpMethod": "GET", |
785 "id": "genomics.annotations.get", | 845 "id": "genomics.annotationsets.get", |
786 "parameterOrder": [ | 846 "parameterOrder": [ |
787 "annotationId" | 847 "annotationSetId" |
788 ], | 848 ], |
789 "parameters": { | 849 "parameters": { |
790 "annotationId": { | 850 "annotationSetId": { |
791 "description": "The ID of the annotation to be retri
eved.", | 851 "description": "The ID of the annotation set to be r
etrieved.", |
792 "location": "path", | 852 "location": "path", |
793 "required": true, | 853 "required": true, |
794 "type": "string" | 854 "type": "string" |
795 } | 855 } |
796 }, | 856 }, |
797 "path": "v1/annotations/{annotationId}", | 857 "path": "v1/annotationsets/{annotationSetId}", |
798 "response": { | 858 "response": { |
799 "$ref": "Annotation" | 859 "$ref": "AnnotationSet" |
800 }, | 860 }, |
801 "scopes": [ | 861 "scopes": [ |
802 "https://www.googleapis.com/auth/cloud-platform", | 862 "https://www.googleapis.com/auth/cloud-platform", |
803 "https://www.googleapis.com/auth/genomics", | 863 "https://www.googleapis.com/auth/genomics", |
804 "https://www.googleapis.com/auth/genomics.readonly" | 864 "https://www.googleapis.com/auth/genomics.readonly" |
805 ] | 865 ] |
806 }, | 866 }, |
807 "update": { | 867 "update": { |
808 "description": "Updates an annotation. Caller must have\nWRI
TE permission for the associated dataset.", | 868 "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
.", |
809 "httpMethod": "PUT", | 869 "httpMethod": "PUT", |
810 "id": "genomics.annotations.update", | 870 "id": "genomics.annotationsets.update", |
811 "parameterOrder": [ | 871 "parameterOrder": [ |
812 "annotationId" | 872 "annotationSetId" |
813 ], | 873 ], |
814 "parameters": { | 874 "parameters": { |
| 875 "annotationSetId": { |
| 876 "description": "The ID of the annotation set to be u
pdated.", |
| 877 "location": "path", |
| 878 "required": true, |
| 879 "type": "string" |
| 880 }, |
815 "updateMask": { | 881 "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.", | 882 "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.", |
817 "format": "google-fieldmask", | 883 "format": "google-fieldmask", |
818 "location": "query", | 884 "location": "query", |
819 "type": "string" | 885 "type": "string" |
820 }, | 886 } |
821 "annotationId": { | 887 }, |
822 "description": "The ID of the annotation to be updat
ed.", | 888 "path": "v1/annotationsets/{annotationSetId}", |
823 "location": "path", | 889 "request": { |
824 "required": true, | 890 "$ref": "AnnotationSet" |
825 "type": "string" | 891 }, |
826 } | 892 "response": { |
827 }, | 893 "$ref": "AnnotationSet" |
828 "path": "v1/annotations/{annotationId}", | |
829 "request": { | |
830 "$ref": "Annotation" | |
831 }, | |
832 "response": { | |
833 "$ref": "Annotation" | |
834 }, | |
835 "scopes": [ | |
836 "https://www.googleapis.com/auth/cloud-platform", | |
837 "https://www.googleapis.com/auth/genomics" | |
838 ] | |
839 }, | |
840 "delete": { | |
841 "description": "Deletes an annotation. Caller must have WRIT
E permission for\nthe associated annotation set.", | |
842 "httpMethod": "DELETE", | |
843 "id": "genomics.annotations.delete", | |
844 "parameterOrder": [ | |
845 "annotationId" | |
846 ], | |
847 "parameters": { | |
848 "annotationId": { | |
849 "description": "The ID of the annotation to be delet
ed.", | |
850 "location": "path", | |
851 "required": true, | |
852 "type": "string" | |
853 } | |
854 }, | |
855 "path": "v1/annotations/{annotationId}", | |
856 "response": { | |
857 "$ref": "Empty" | |
858 }, | 894 }, |
859 "scopes": [ | 895 "scopes": [ |
860 "https://www.googleapis.com/auth/cloud-platform", | 896 "https://www.googleapis.com/auth/cloud-platform", |
861 "https://www.googleapis.com/auth/genomics" | 897 "https://www.googleapis.com/auth/genomics" |
862 ] | 898 ] |
863 }, | 899 }, |
864 "create": { | 900 "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.", | 901 "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).", |
866 "httpMethod": "POST", | 902 "httpMethod": "POST", |
867 "id": "genomics.annotations.create", | 903 "id": "genomics.annotationsets.create", |
868 "parameterOrder": [], | 904 "parameterOrder": [], |
869 "parameters": {}, | 905 "parameters": {}, |
870 "path": "v1/annotations", | 906 "path": "v1/annotationsets", |
871 "request": { | 907 "request": { |
872 "$ref": "Annotation" | 908 "$ref": "AnnotationSet" |
873 }, | 909 }, |
874 "response": { | 910 "response": { |
875 "$ref": "Annotation" | 911 "$ref": "AnnotationSet" |
876 }, | 912 }, |
877 "scopes": [ | 913 "scopes": [ |
878 "https://www.googleapis.com/auth/cloud-platform", | 914 "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" | 915 "https://www.googleapis.com/auth/genomics" |
898 ] | 916 ] |
899 } | 917 } |
900 } | 918 } |
901 }, | 919 }, |
902 "variantsets": { | 920 "references": { |
903 "methods": { | 921 "methods": { |
904 "create": { | 922 "search": { |
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.", | 923 "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).", |
906 "httpMethod": "POST", | 924 "httpMethod": "POST", |
907 "id": "genomics.variantsets.create", | 925 "id": "genomics.references.search", |
908 "parameterOrder": [], | 926 "parameterOrder": [], |
909 "parameters": {}, | 927 "parameters": {}, |
910 "path": "v1/variantsets", | 928 "path": "v1/references/search", |
911 "request": { | 929 "request": { |
912 "$ref": "VariantSet" | 930 "$ref": "SearchReferencesRequest" |
913 }, | 931 }, |
914 "response": { | 932 "response": { |
915 "$ref": "VariantSet" | 933 "$ref": "SearchReferencesResponse" |
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" | |
940 }, | |
941 "response": { | |
942 "$ref": "Operation" | |
943 }, | |
944 "scopes": [ | |
945 "https://www.googleapis.com/auth/bigquery", | |
946 "https://www.googleapis.com/auth/cloud-platform", | |
947 "https://www.googleapis.com/auth/genomics" | |
948 ] | |
949 }, | |
950 "search": { | |
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).", | |
952 "httpMethod": "POST", | |
953 "id": "genomics.variantsets.search", | |
954 "parameterOrder": [], | |
955 "parameters": {}, | |
956 "path": "v1/variantsets/search", | |
957 "request": { | |
958 "$ref": "SearchVariantSetsRequest" | |
959 }, | |
960 "response": { | |
961 "$ref": "SearchVariantSetsResponse" | |
962 }, | 934 }, |
963 "scopes": [ | 935 "scopes": [ |
964 "https://www.googleapis.com/auth/cloud-platform", | 936 "https://www.googleapis.com/auth/cloud-platform", |
965 "https://www.googleapis.com/auth/genomics", | 937 "https://www.googleapis.com/auth/genomics", |
966 "https://www.googleapis.com/auth/genomics.readonly" | 938 "https://www.googleapis.com/auth/genomics.readonly" |
967 ] | 939 ] |
968 }, | 940 }, |
969 "get": { | 941 "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)", | 942 "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).", |
971 "httpMethod": "GET", | 943 "httpMethod": "GET", |
972 "id": "genomics.variantsets.get", | 944 "id": "genomics.references.get", |
973 "parameterOrder": [ | 945 "parameterOrder": [ |
974 "variantSetId" | 946 "referenceId" |
975 ], | 947 ], |
976 "parameters": { | 948 "parameters": { |
977 "variantSetId": { | 949 "referenceId": { |
978 "description": "Required. The ID of the variant set.
", | 950 "description": "The ID of the reference.", |
979 "location": "path", | 951 "location": "path", |
980 "required": true, | 952 "required": true, |
981 "type": "string" | 953 "type": "string" |
982 } | 954 } |
983 }, | 955 }, |
984 "path": "v1/variantsets/{variantSetId}", | 956 "path": "v1/references/{referenceId}", |
985 "response": { | 957 "response": { |
986 "$ref": "VariantSet" | 958 "$ref": "Reference" |
987 }, | 959 }, |
988 "scopes": [ | 960 "scopes": [ |
989 "https://www.googleapis.com/auth/cloud-platform", | 961 "https://www.googleapis.com/auth/cloud-platform", |
| 962 "https://www.googleapis.com/auth/genomics", |
| 963 "https://www.googleapis.com/auth/genomics.readonly" |
| 964 ] |
| 965 } |
| 966 }, |
| 967 "resources": { |
| 968 "bases": { |
| 969 "methods": { |
| 970 "list": { |
| 971 "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).", |
| 972 "httpMethod": "GET", |
| 973 "id": "genomics.references.bases.list", |
| 974 "parameterOrder": [ |
| 975 "referenceId" |
| 976 ], |
| 977 "parameters": { |
| 978 "pageToken": { |
| 979 "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.", |
| 980 "location": "query", |
| 981 "type": "string" |
| 982 }, |
| 983 "pageSize": { |
| 984 "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).", |
| 985 "format": "int32", |
| 986 "location": "query", |
| 987 "type": "integer" |
| 988 }, |
| 989 "start": { |
| 990 "description": "The start position (0-based)
of this query. Defaults to 0.", |
| 991 "format": "int64", |
| 992 "location": "query", |
| 993 "type": "string" |
| 994 }, |
| 995 "referenceId": { |
| 996 "description": "The ID of the reference.", |
| 997 "location": "path", |
| 998 "required": true, |
| 999 "type": "string" |
| 1000 }, |
| 1001 "end": { |
| 1002 "description": "The end position (0-based, e
xclusive) of this query. Defaults to the length\nof this reference.", |
| 1003 "format": "int64", |
| 1004 "location": "query", |
| 1005 "type": "string" |
| 1006 } |
| 1007 }, |
| 1008 "path": "v1/references/{referenceId}/bases", |
| 1009 "response": { |
| 1010 "$ref": "ListBasesResponse" |
| 1011 }, |
| 1012 "scopes": [ |
| 1013 "https://www.googleapis.com/auth/cloud-platform"
, |
| 1014 "https://www.googleapis.com/auth/genomics", |
| 1015 "https://www.googleapis.com/auth/genomics.readon
ly" |
| 1016 ] |
| 1017 } |
| 1018 } |
| 1019 } |
| 1020 } |
| 1021 }, |
| 1022 "datasets": { |
| 1023 "methods": { |
| 1024 "getIamPolicy": { |
| 1025 "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)", |
| 1026 "httpMethod": "POST", |
| 1027 "id": "genomics.datasets.getIamPolicy", |
| 1028 "parameterOrder": [ |
| 1029 "resource" |
| 1030 ], |
| 1031 "parameters": { |
| 1032 "resource": { |
| 1033 "description": "REQUIRED: The resource for which pol
icy is being specified. Format is\n`datasets/<dataset ID>`.", |
| 1034 "location": "path", |
| 1035 "pattern": "^datasets/[^/]+$", |
| 1036 "required": true, |
| 1037 "type": "string" |
| 1038 } |
| 1039 }, |
| 1040 "path": "v1/{+resource}:getIamPolicy", |
| 1041 "request": { |
| 1042 "$ref": "GetIamPolicyRequest" |
| 1043 }, |
| 1044 "response": { |
| 1045 "$ref": "Policy" |
| 1046 }, |
| 1047 "scopes": [ |
| 1048 "https://www.googleapis.com/auth/cloud-platform", |
| 1049 "https://www.googleapis.com/auth/genomics" |
| 1050 ] |
| 1051 }, |
| 1052 "patch": { |
| 1053 "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.", |
| 1054 "httpMethod": "PATCH", |
| 1055 "id": "genomics.datasets.patch", |
| 1056 "parameterOrder": [ |
| 1057 "datasetId" |
| 1058 ], |
| 1059 "parameters": { |
| 1060 "datasetId": { |
| 1061 "description": "The ID of the dataset to be updated.
", |
| 1062 "location": "path", |
| 1063 "required": true, |
| 1064 "type": "string" |
| 1065 }, |
| 1066 "updateMask": { |
| 1067 "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.", |
| 1068 "format": "google-fieldmask", |
| 1069 "location": "query", |
| 1070 "type": "string" |
| 1071 } |
| 1072 }, |
| 1073 "path": "v1/datasets/{datasetId}", |
| 1074 "request": { |
| 1075 "$ref": "Dataset" |
| 1076 }, |
| 1077 "response": { |
| 1078 "$ref": "Dataset" |
| 1079 }, |
| 1080 "scopes": [ |
| 1081 "https://www.googleapis.com/auth/cloud-platform", |
| 1082 "https://www.googleapis.com/auth/genomics" |
| 1083 ] |
| 1084 }, |
| 1085 "get": { |
| 1086 "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)", |
| 1087 "httpMethod": "GET", |
| 1088 "id": "genomics.datasets.get", |
| 1089 "parameterOrder": [ |
| 1090 "datasetId" |
| 1091 ], |
| 1092 "parameters": { |
| 1093 "datasetId": { |
| 1094 "description": "The ID of the dataset.", |
| 1095 "location": "path", |
| 1096 "required": true, |
| 1097 "type": "string" |
| 1098 } |
| 1099 }, |
| 1100 "path": "v1/datasets/{datasetId}", |
| 1101 "response": { |
| 1102 "$ref": "Dataset" |
| 1103 }, |
| 1104 "scopes": [ |
| 1105 "https://www.googleapis.com/auth/cloud-platform", |
990 "https://www.googleapis.com/auth/genomics", | 1106 "https://www.googleapis.com/auth/genomics", |
991 "https://www.googleapis.com/auth/genomics.readonly" | 1107 "https://www.googleapis.com/auth/genomics.readonly" |
992 ] | 1108 ] |
993 }, | 1109 }, |
994 "patch": { | 1110 "undelete": { |
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)", | 1111 "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.", |
996 "httpMethod": "PATCH", | 1112 "httpMethod": "POST", |
997 "id": "genomics.variantsets.patch", | 1113 "id": "genomics.datasets.undelete", |
998 "parameterOrder": [ | 1114 "parameterOrder": [ |
999 "variantSetId" | 1115 "datasetId" |
1000 ], | 1116 ], |
1001 "parameters": { | 1117 "parameters": { |
1002 "updateMask": { | 1118 "datasetId": { |
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.", | 1119 "description": "The ID of the dataset to be undelete
d.", |
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).", | |
1010 "location": "path", | 1120 "location": "path", |
1011 "required": true, | 1121 "required": true, |
1012 "type": "string" | 1122 "type": "string" |
1013 } | 1123 } |
1014 }, | 1124 }, |
1015 "path": "v1/variantsets/{variantSetId}", | 1125 "path": "v1/datasets/{datasetId}:undelete", |
1016 "request": { | 1126 "request": { |
1017 "$ref": "VariantSet" | 1127 "$ref": "UndeleteDatasetRequest" |
1018 }, | 1128 }, |
1019 "response": { | 1129 "response": { |
1020 "$ref": "VariantSet" | 1130 "$ref": "Dataset" |
| 1131 }, |
| 1132 "scopes": [ |
| 1133 "https://www.googleapis.com/auth/cloud-platform", |
| 1134 "https://www.googleapis.com/auth/genomics" |
| 1135 ] |
| 1136 }, |
| 1137 "testIamPermissions": { |
| 1138 "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)", |
| 1139 "httpMethod": "POST", |
| 1140 "id": "genomics.datasets.testIamPermissions", |
| 1141 "parameterOrder": [ |
| 1142 "resource" |
| 1143 ], |
| 1144 "parameters": { |
| 1145 "resource": { |
| 1146 "description": "REQUIRED: The resource for which pol
icy is being specified. Format is\n`datasets/<dataset ID>`.", |
| 1147 "location": "path", |
| 1148 "pattern": "^datasets/[^/]+$", |
| 1149 "required": true, |
| 1150 "type": "string" |
| 1151 } |
| 1152 }, |
| 1153 "path": "v1/{+resource}:testIamPermissions", |
| 1154 "request": { |
| 1155 "$ref": "TestIamPermissionsRequest" |
| 1156 }, |
| 1157 "response": { |
| 1158 "$ref": "TestIamPermissionsResponse" |
1021 }, | 1159 }, |
1022 "scopes": [ | 1160 "scopes": [ |
1023 "https://www.googleapis.com/auth/cloud-platform", | 1161 "https://www.googleapis.com/auth/cloud-platform", |
1024 "https://www.googleapis.com/auth/genomics" | 1162 "https://www.googleapis.com/auth/genomics" |
1025 ] | 1163 ] |
1026 }, | 1164 }, |
1027 "delete": { | 1165 "delete": { |
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)", | 1166 "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)", |
1029 "httpMethod": "DELETE", | 1167 "httpMethod": "DELETE", |
1030 "id": "genomics.variantsets.delete", | 1168 "id": "genomics.datasets.delete", |
1031 "parameterOrder": [ | 1169 "parameterOrder": [ |
1032 "variantSetId" | 1170 "datasetId" |
1033 ], | 1171 ], |
1034 "parameters": { | 1172 "parameters": { |
1035 "variantSetId": { | 1173 "datasetId": { |
1036 "description": "The ID of the variant set to be dele
ted.", | 1174 "description": "The ID of the dataset to be deleted.
", |
1037 "location": "path", | 1175 "location": "path", |
1038 "required": true, | 1176 "required": true, |
1039 "type": "string" | 1177 "type": "string" |
1040 } | 1178 } |
1041 }, | 1179 }, |
1042 "path": "v1/variantsets/{variantSetId}", | 1180 "path": "v1/datasets/{datasetId}", |
1043 "response": { | 1181 "response": { |
1044 "$ref": "Empty" | 1182 "$ref": "Empty" |
1045 }, | 1183 }, |
1046 "scopes": [ | |
1047 "https://www.googleapis.com/auth/cloud-platform", | |
1048 "https://www.googleapis.com/auth/genomics" | |
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": [ | 1184 "scopes": [ |
1079 "https://www.googleapis.com/auth/cloud-platform", | 1185 "https://www.googleapis.com/auth/cloud-platform", |
1080 "https://www.googleapis.com/auth/genomics" | 1186 "https://www.googleapis.com/auth/genomics" |
1081 ] | 1187 ] |
1082 }, | 1188 }, |
1083 "list": { | 1189 "list": { |
1084 "description": "Lists operations that match the specified fi
lter in the request.", | 1190 "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)
", |
1085 "httpMethod": "GET", | 1191 "httpMethod": "GET", |
1086 "id": "genomics.operations.list", | 1192 "id": "genomics.datasets.list", |
1087 "parameterOrder": [ | 1193 "parameterOrder": [], |
1088 "name" | |
1089 ], | |
1090 "parameters": { | 1194 "parameters": { |
| 1195 "pageToken": { |
| 1196 "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.", |
| 1197 "location": "query", |
| 1198 "type": "string" |
| 1199 }, |
1091 "pageSize": { | 1200 "pageSize": { |
1092 "description": "The maximum number of results to ret
urn. If unspecified, defaults to\n256. The maximum value is 2048.", | 1201 "description": "The maximum number of results to ret
urn in a single page. If unspecified,\ndefaults to 50. The maximum value is 1024
.", |
1093 "format": "int32", | 1202 "format": "int32", |
1094 "location": "query", | 1203 "location": "query", |
1095 "type": "integer" | 1204 "type": "integer" |
1096 }, | 1205 }, |
1097 "filter": { | 1206 "projectId": { |
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`", | 1207 "description": "Required. The Google Cloud project I
D to list datasets for.", |
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", | 1208 "location": "query", |
1112 "type": "string" | 1209 "type": "string" |
1113 } | 1210 } |
1114 }, | 1211 }, |
1115 "path": "v1/{+name}", | 1212 "path": "v1/datasets", |
1116 "response": { | 1213 "response": { |
1117 "$ref": "ListOperationsResponse" | 1214 "$ref": "ListDatasetsResponse" |
| 1215 }, |
| 1216 "scopes": [ |
| 1217 "https://www.googleapis.com/auth/cloud-platform", |
| 1218 "https://www.googleapis.com/auth/genomics", |
| 1219 "https://www.googleapis.com/auth/genomics.readonly" |
| 1220 ] |
| 1221 }, |
| 1222 "setIamPolicy": { |
| 1223 "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.", |
| 1224 "httpMethod": "POST", |
| 1225 "id": "genomics.datasets.setIamPolicy", |
| 1226 "parameterOrder": [ |
| 1227 "resource" |
| 1228 ], |
| 1229 "parameters": { |
| 1230 "resource": { |
| 1231 "description": "REQUIRED: The resource for which pol
icy is being specified. Format is\n`datasets/<dataset ID>`.", |
| 1232 "location": "path", |
| 1233 "pattern": "^datasets/[^/]+$", |
| 1234 "required": true, |
| 1235 "type": "string" |
| 1236 } |
| 1237 }, |
| 1238 "path": "v1/{+resource}:setIamPolicy", |
| 1239 "request": { |
| 1240 "$ref": "SetIamPolicyRequest" |
| 1241 }, |
| 1242 "response": { |
| 1243 "$ref": "Policy" |
1118 }, | 1244 }, |
1119 "scopes": [ | 1245 "scopes": [ |
1120 "https://www.googleapis.com/auth/cloud-platform", | 1246 "https://www.googleapis.com/auth/cloud-platform", |
1121 "https://www.googleapis.com/auth/genomics" | 1247 "https://www.googleapis.com/auth/genomics" |
1122 ] | 1248 ] |
1123 }, | 1249 }, |
1124 "get": { | 1250 "create": { |
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.", | 1251 "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)", |
1126 "httpMethod": "GET", | 1252 "httpMethod": "POST", |
1127 "id": "genomics.operations.get", | 1253 "id": "genomics.datasets.create", |
1128 "parameterOrder": [ | 1254 "parameterOrder": [], |
1129 "name" | 1255 "parameters": {}, |
1130 ], | 1256 "path": "v1/datasets", |
1131 "parameters": { | 1257 "request": { |
1132 "name": { | 1258 "$ref": "Dataset" |
1133 "description": "The name of the operation resource."
, | |
1134 "location": "path", | |
1135 "pattern": "^operations/.+$", | |
1136 "required": true, | |
1137 "type": "string" | |
1138 } | |
1139 }, | 1259 }, |
1140 "path": "v1/{+name}", | |
1141 "response": { | 1260 "response": { |
1142 "$ref": "Operation" | 1261 "$ref": "Dataset" |
1143 }, | 1262 }, |
1144 "scopes": [ | 1263 "scopes": [ |
1145 "https://www.googleapis.com/auth/cloud-platform", | 1264 "https://www.googleapis.com/auth/cloud-platform", |
1146 "https://www.googleapis.com/auth/genomics" | 1265 "https://www.googleapis.com/auth/genomics" |
1147 ] | 1266 ] |
1148 } | 1267 } |
1149 } | 1268 } |
1150 }, | 1269 }, |
1151 "referencesets": { | 1270 "variantsets": { |
1152 "methods": { | 1271 "methods": { |
1153 "search": { | 1272 "create": { |
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)", | 1273 "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.", |
1155 "httpMethod": "POST", | 1274 "httpMethod": "POST", |
1156 "id": "genomics.referencesets.search", | 1275 "id": "genomics.variantsets.create", |
1157 "parameterOrder": [], | 1276 "parameterOrder": [], |
1158 "parameters": {}, | 1277 "parameters": {}, |
1159 "path": "v1/referencesets/search", | 1278 "path": "v1/variantsets", |
1160 "request": { | 1279 "request": { |
1161 "$ref": "SearchReferenceSetsRequest" | 1280 "$ref": "VariantSet" |
1162 }, | 1281 }, |
1163 "response": { | 1282 "response": { |
1164 "$ref": "SearchReferenceSetsResponse" | 1283 "$ref": "VariantSet" |
1165 }, | 1284 }, |
1166 "scopes": [ | 1285 "scopes": [ |
1167 "https://www.googleapis.com/auth/cloud-platform", | 1286 "https://www.googleapis.com/auth/cloud-platform", |
1168 "https://www.googleapis.com/auth/genomics", | 1287 "https://www.googleapis.com/auth/genomics" |
1169 "https://www.googleapis.com/auth/genomics.readonly" | |
1170 ] | 1288 ] |
1171 }, | 1289 }, |
1172 "get": { | 1290 "export": { |
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).", | 1291 "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)", |
1174 "httpMethod": "GET", | 1292 "httpMethod": "POST", |
1175 "id": "genomics.referencesets.get", | 1293 "id": "genomics.variantsets.export", |
1176 "parameterOrder": [ | 1294 "parameterOrder": [ |
1177 "referenceSetId" | 1295 "variantSetId" |
1178 ], | 1296 ], |
1179 "parameters": { | 1297 "parameters": { |
1180 "referenceSetId": { | 1298 "variantSetId": { |
1181 "description": "The ID of the reference set.", | 1299 "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.", |
1182 "location": "path", | 1300 "location": "path", |
1183 "required": true, | 1301 "required": true, |
1184 "type": "string" | 1302 "type": "string" |
1185 } | 1303 } |
1186 }, | 1304 }, |
1187 "path": "v1/referencesets/{referenceSetId}", | 1305 "path": "v1/variantsets/{variantSetId}:export", |
1188 "response": { | |
1189 "$ref": "ReferenceSet" | |
1190 }, | |
1191 "scopes": [ | |
1192 "https://www.googleapis.com/auth/cloud-platform", | |
1193 "https://www.googleapis.com/auth/genomics", | |
1194 "https://www.googleapis.com/auth/genomics.readonly" | |
1195 ] | |
1196 } | |
1197 } | |
1198 }, | |
1199 "readgroupsets": { | |
1200 "methods": { | |
1201 "export": { | |
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.", | |
1203 "httpMethod": "POST", | |
1204 "id": "genomics.readgroupsets.export", | |
1205 "parameterOrder": [ | |
1206 "readGroupSetId" | |
1207 ], | |
1208 "parameters": { | |
1209 "readGroupSetId": { | |
1210 "description": "Required. The ID of the read group s
et to export. The caller must have\nREAD access to this read group set.", | |
1211 "location": "path", | |
1212 "required": true, | |
1213 "type": "string" | |
1214 } | |
1215 }, | |
1216 "path": "v1/readgroupsets/{readGroupSetId}:export", | |
1217 "request": { | 1306 "request": { |
1218 "$ref": "ExportReadGroupSetRequest" | 1307 "$ref": "ExportVariantSetRequest" |
1219 }, | 1308 }, |
1220 "response": { | 1309 "response": { |
1221 "$ref": "Operation" | 1310 "$ref": "Operation" |
1222 }, | 1311 }, |
1223 "scopes": [ | 1312 "scopes": [ |
| 1313 "https://www.googleapis.com/auth/bigquery", |
1224 "https://www.googleapis.com/auth/cloud-platform", | 1314 "https://www.googleapis.com/auth/cloud-platform", |
1225 "https://www.googleapis.com/auth/devstorage.read_write", | |
1226 "https://www.googleapis.com/auth/genomics" | 1315 "https://www.googleapis.com/auth/genomics" |
1227 ] | 1316 ] |
1228 }, | 1317 }, |
1229 "search": { | 1318 "search": { |
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).", | 1319 "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).", |
1231 "httpMethod": "POST", | 1320 "httpMethod": "POST", |
1232 "id": "genomics.readgroupsets.search", | 1321 "id": "genomics.variantsets.search", |
1233 "parameterOrder": [], | 1322 "parameterOrder": [], |
1234 "parameters": {}, | 1323 "parameters": {}, |
1235 "path": "v1/readgroupsets/search", | 1324 "path": "v1/variantsets/search", |
1236 "request": { | 1325 "request": { |
1237 "$ref": "SearchReadGroupSetsRequest" | 1326 "$ref": "SearchVariantSetsRequest" |
1238 }, | 1327 }, |
1239 "response": { | 1328 "response": { |
1240 "$ref": "SearchReadGroupSetsResponse" | 1329 "$ref": "SearchVariantSetsResponse" |
1241 }, | 1330 }, |
1242 "scopes": [ | 1331 "scopes": [ |
1243 "https://www.googleapis.com/auth/cloud-platform", | 1332 "https://www.googleapis.com/auth/cloud-platform", |
1244 "https://www.googleapis.com/auth/genomics", | 1333 "https://www.googleapis.com/auth/genomics", |
1245 "https://www.googleapis.com/auth/genomics.readonly" | 1334 "https://www.googleapis.com/auth/genomics.readonly" |
1246 ] | 1335 ] |
1247 }, | 1336 }, |
1248 "patch": { | 1337 "patch": { |
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.", | 1338 "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)", |
1250 "httpMethod": "PATCH", | 1339 "httpMethod": "PATCH", |
1251 "id": "genomics.readgroupsets.patch", | 1340 "id": "genomics.variantsets.patch", |
1252 "parameterOrder": [ | 1341 "parameterOrder": [ |
1253 "readGroupSetId" | 1342 "variantSetId" |
1254 ], | 1343 ], |
1255 "parameters": { | 1344 "parameters": { |
| 1345 "variantSetId": { |
| 1346 "description": "The ID of the variant to be updated
(must already exist).", |
| 1347 "location": "path", |
| 1348 "required": true, |
| 1349 "type": "string" |
| 1350 }, |
1256 "updateMask": { | 1351 "updateMask": { |
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.", | 1352 "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.", |
1258 "format": "google-fieldmask", | 1353 "format": "google-fieldmask", |
1259 "location": "query", | 1354 "location": "query", |
1260 "type": "string" | 1355 "type": "string" |
1261 }, | |
1262 "readGroupSetId": { | |
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.", | |
1264 "location": "path", | |
1265 "required": true, | |
1266 "type": "string" | |
1267 } | 1356 } |
1268 }, | 1357 }, |
1269 "path": "v1/readgroupsets/{readGroupSetId}", | 1358 "path": "v1/variantsets/{variantSetId}", |
1270 "request": { | 1359 "request": { |
1271 "$ref": "ReadGroupSet" | 1360 "$ref": "VariantSet" |
1272 }, | 1361 }, |
1273 "response": { | 1362 "response": { |
1274 "$ref": "ReadGroupSet" | 1363 "$ref": "VariantSet" |
1275 }, | 1364 }, |
1276 "scopes": [ | 1365 "scopes": [ |
1277 "https://www.googleapis.com/auth/cloud-platform", | 1366 "https://www.googleapis.com/auth/cloud-platform", |
1278 "https://www.googleapis.com/auth/genomics" | 1367 "https://www.googleapis.com/auth/genomics" |
1279 ] | 1368 ] |
1280 }, | 1369 }, |
1281 "get": { | 1370 "get": { |
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)", | 1371 "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)", |
1283 "httpMethod": "GET", | 1372 "httpMethod": "GET", |
1284 "id": "genomics.readgroupsets.get", | 1373 "id": "genomics.variantsets.get", |
1285 "parameterOrder": [ | 1374 "parameterOrder": [ |
1286 "readGroupSetId" | 1375 "variantSetId" |
1287 ], | 1376 ], |
1288 "parameters": { | 1377 "parameters": { |
1289 "readGroupSetId": { | 1378 "variantSetId": { |
1290 "description": "The ID of the read group set.", | 1379 "description": "Required. The ID of the variant set.
", |
1291 "location": "path", | 1380 "location": "path", |
1292 "required": true, | 1381 "required": true, |
1293 "type": "string" | 1382 "type": "string" |
1294 } | 1383 } |
1295 }, | 1384 }, |
1296 "path": "v1/readgroupsets/{readGroupSetId}", | 1385 "path": "v1/variantsets/{variantSetId}", |
1297 "response": { | 1386 "response": { |
1298 "$ref": "ReadGroupSet" | 1387 "$ref": "VariantSet" |
1299 }, | 1388 }, |
1300 "scopes": [ | 1389 "scopes": [ |
1301 "https://www.googleapis.com/auth/cloud-platform", | 1390 "https://www.googleapis.com/auth/cloud-platform", |
1302 "https://www.googleapis.com/auth/genomics", | 1391 "https://www.googleapis.com/auth/genomics", |
1303 "https://www.googleapis.com/auth/genomics.readonly" | 1392 "https://www.googleapis.com/auth/genomics.readonly" |
1304 ] | 1393 ] |
1305 }, | 1394 }, |
1306 "import": { | |
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)", | |
1308 "httpMethod": "POST", | |
1309 "id": "genomics.readgroupsets.import", | |
1310 "parameterOrder": [], | |
1311 "parameters": {}, | |
1312 "path": "v1/readgroupsets:import", | |
1313 "request": { | |
1314 "$ref": "ImportReadGroupSetsRequest" | |
1315 }, | |
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": { | 1395 "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)
", | 1396 "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)", |
1327 "httpMethod": "DELETE", | 1397 "httpMethod": "DELETE", |
1328 "id": "genomics.readgroupsets.delete", | 1398 "id": "genomics.variantsets.delete", |
1329 "parameterOrder": [ | 1399 "parameterOrder": [ |
1330 "readGroupSetId" | 1400 "variantSetId" |
1331 ], | 1401 ], |
1332 "parameters": { | 1402 "parameters": { |
1333 "readGroupSetId": { | 1403 "variantSetId": { |
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.", | 1404 "description": "The ID of the variant set to be dele
ted.", |
1335 "location": "path", | 1405 "location": "path", |
1336 "required": true, | 1406 "required": true, |
1337 "type": "string" | 1407 "type": "string" |
1338 } | 1408 } |
1339 }, | 1409 }, |
1340 "path": "v1/readgroupsets/{readGroupSetId}", | 1410 "path": "v1/variantsets/{variantSetId}", |
1341 "response": { | 1411 "response": { |
1342 "$ref": "Empty" | 1412 "$ref": "Empty" |
1343 }, | 1413 }, |
| 1414 "scopes": [ |
| 1415 "https://www.googleapis.com/auth/cloud-platform", |
| 1416 "https://www.googleapis.com/auth/genomics" |
| 1417 ] |
| 1418 } |
| 1419 } |
| 1420 }, |
| 1421 "annotations": { |
| 1422 "methods": { |
| 1423 "delete": { |
| 1424 "description": "Deletes an annotation. Caller must have WRIT
E permission for\nthe associated annotation set.", |
| 1425 "httpMethod": "DELETE", |
| 1426 "id": "genomics.annotations.delete", |
| 1427 "parameterOrder": [ |
| 1428 "annotationId" |
| 1429 ], |
| 1430 "parameters": { |
| 1431 "annotationId": { |
| 1432 "description": "The ID of the annotation to be delet
ed.", |
| 1433 "location": "path", |
| 1434 "required": true, |
| 1435 "type": "string" |
| 1436 } |
| 1437 }, |
| 1438 "path": "v1/annotations/{annotationId}", |
| 1439 "response": { |
| 1440 "$ref": "Empty" |
| 1441 }, |
1344 "scopes": [ | 1442 "scopes": [ |
1345 "https://www.googleapis.com/auth/cloud-platform", | 1443 "https://www.googleapis.com/auth/cloud-platform", |
1346 "https://www.googleapis.com/auth/genomics" | 1444 "https://www.googleapis.com/auth/genomics" |
1347 ] | 1445 ] |
1348 } | 1446 }, |
1349 }, | 1447 "create": { |
1350 "resources": { | 1448 "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.", |
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 } | |
1414 } | |
1415 }, | |
1416 "reads": { | |
1417 "methods": { | |
1418 "search": { | |
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).", | |
1420 "httpMethod": "POST", | 1449 "httpMethod": "POST", |
1421 "id": "genomics.reads.search", | 1450 "id": "genomics.annotations.create", |
1422 "parameterOrder": [], | 1451 "parameterOrder": [], |
1423 "parameters": {}, | 1452 "parameters": {}, |
1424 "path": "v1/reads/search", | 1453 "path": "v1/annotations", |
1425 "request": { | 1454 "request": { |
1426 "$ref": "SearchReadsRequest" | 1455 "$ref": "Annotation" |
1427 }, | 1456 }, |
1428 "response": { | 1457 "response": { |
1429 "$ref": "SearchReadsResponse" | 1458 "$ref": "Annotation" |
1430 }, | 1459 }, |
1431 "scopes": [ | 1460 "scopes": [ |
1432 "https://www.googleapis.com/auth/cloud-platform", | 1461 "https://www.googleapis.com/auth/cloud-platform", |
1433 "https://www.googleapis.com/auth/genomics", | 1462 "https://www.googleapis.com/auth/genomics" |
1434 "https://www.googleapis.com/auth/genomics.readonly" | |
1435 ] | 1463 ] |
1436 } | 1464 }, |
1437 } | 1465 "batchCreate": { |
1438 }, | 1466 "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.", |
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", | 1467 "httpMethod": "POST", |
1444 "id": "genomics.callsets.search", | 1468 "id": "genomics.annotations.batchCreate", |
1445 "parameterOrder": [], | 1469 "parameterOrder": [], |
1446 "parameters": {}, | 1470 "parameters": {}, |
1447 "path": "v1/callsets/search", | 1471 "path": "v1/annotations:batchCreate", |
1448 "request": { | 1472 "request": { |
1449 "$ref": "SearchCallSetsRequest" | 1473 "$ref": "BatchCreateAnnotationsRequest" |
1450 }, | 1474 }, |
1451 "response": { | 1475 "response": { |
1452 "$ref": "SearchCallSetsResponse" | 1476 "$ref": "BatchCreateAnnotationsResponse" |
| 1477 }, |
| 1478 "scopes": [ |
| 1479 "https://www.googleapis.com/auth/cloud-platform", |
| 1480 "https://www.googleapis.com/auth/genomics" |
| 1481 ] |
| 1482 }, |
| 1483 "search": { |
| 1484 "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.", |
| 1485 "httpMethod": "POST", |
| 1486 "id": "genomics.annotations.search", |
| 1487 "parameterOrder": [], |
| 1488 "parameters": {}, |
| 1489 "path": "v1/annotations/search", |
| 1490 "request": { |
| 1491 "$ref": "SearchAnnotationsRequest" |
| 1492 }, |
| 1493 "response": { |
| 1494 "$ref": "SearchAnnotationsResponse" |
1453 }, | 1495 }, |
1454 "scopes": [ | 1496 "scopes": [ |
1455 "https://www.googleapis.com/auth/cloud-platform", | 1497 "https://www.googleapis.com/auth/cloud-platform", |
1456 "https://www.googleapis.com/auth/genomics", | 1498 "https://www.googleapis.com/auth/genomics", |
1457 "https://www.googleapis.com/auth/genomics.readonly" | 1499 "https://www.googleapis.com/auth/genomics.readonly" |
1458 ] | 1500 ] |
1459 }, | 1501 }, |
1460 "patch": { | 1502 "get": { |
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.", | 1503 "description": "Gets an annotation. Caller must have READ pe
rmission\nfor the associated annotation set.", |
1462 "httpMethod": "PATCH", | 1504 "httpMethod": "GET", |
1463 "id": "genomics.callsets.patch", | 1505 "id": "genomics.annotations.get", |
1464 "parameterOrder": [ | 1506 "parameterOrder": [ |
1465 "callSetId" | 1507 "annotationId" |
1466 ], | 1508 ], |
1467 "parameters": { | 1509 "parameters": { |
1468 "updateMask": { | 1510 "annotationId": { |
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.", | 1511 "description": "The ID of the annotation to be retri
eved.", |
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", | 1512 "location": "path", |
1477 "required": true, | 1513 "required": true, |
1478 "type": "string" | 1514 "type": "string" |
1479 } | 1515 } |
1480 }, | 1516 }, |
1481 "path": "v1/callsets/{callSetId}", | 1517 "path": "v1/annotations/{annotationId}", |
1482 "request": { | |
1483 "$ref": "CallSet" | |
1484 }, | |
1485 "response": { | 1518 "response": { |
1486 "$ref": "CallSet" | 1519 "$ref": "Annotation" |
1487 }, | 1520 }, |
1488 "scopes": [ | 1521 "scopes": [ |
1489 "https://www.googleapis.com/auth/cloud-platform", | 1522 "https://www.googleapis.com/auth/cloud-platform", |
1490 "https://www.googleapis.com/auth/genomics" | |
1491 ] | |
1492 }, | |
1493 "get": { | |
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)", | |
1495 "httpMethod": "GET", | |
1496 "id": "genomics.callsets.get", | |
1497 "parameterOrder": [ | |
1498 "callSetId" | |
1499 ], | |
1500 "parameters": { | |
1501 "callSetId": { | |
1502 "description": "The ID of the call set.", | |
1503 "location": "path", | |
1504 "required": true, | |
1505 "type": "string" | |
1506 } | |
1507 }, | |
1508 "path": "v1/callsets/{callSetId}", | |
1509 "response": { | |
1510 "$ref": "CallSet" | |
1511 }, | |
1512 "scopes": [ | |
1513 "https://www.googleapis.com/auth/cloud-platform", | |
1514 "https://www.googleapis.com/auth/genomics", | 1523 "https://www.googleapis.com/auth/genomics", |
1515 "https://www.googleapis.com/auth/genomics.readonly" | 1524 "https://www.googleapis.com/auth/genomics.readonly" |
1516 ] | 1525 ] |
1517 }, | 1526 }, |
1518 "create": { | 1527 "update": { |
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)", | 1528 "description": "Updates an annotation. Caller must have\nWRI
TE permission for the associated dataset.", |
1520 "httpMethod": "POST", | 1529 "httpMethod": "PUT", |
1521 "id": "genomics.callsets.create", | 1530 "id": "genomics.annotations.update", |
1522 "parameterOrder": [], | |
1523 "parameters": {}, | |
1524 "path": "v1/callsets", | |
1525 "request": { | |
1526 "$ref": "CallSet" | |
1527 }, | |
1528 "response": { | |
1529 "$ref": "CallSet" | |
1530 }, | |
1531 "scopes": [ | |
1532 "https://www.googleapis.com/auth/cloud-platform", | |
1533 "https://www.googleapis.com/auth/genomics" | |
1534 ] | |
1535 }, | |
1536 "delete": { | |
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)", | |
1538 "httpMethod": "DELETE", | |
1539 "id": "genomics.callsets.delete", | |
1540 "parameterOrder": [ | 1531 "parameterOrder": [ |
1541 "callSetId" | 1532 "annotationId" |
1542 ], | 1533 ], |
1543 "parameters": { | 1534 "parameters": { |
1544 "callSetId": { | 1535 "updateMask": { |
1545 "description": "The ID of the call set to be deleted
.", | 1536 "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.", |
| 1537 "format": "google-fieldmask", |
| 1538 "location": "query", |
| 1539 "type": "string" |
| 1540 }, |
| 1541 "annotationId": { |
| 1542 "description": "The ID of the annotation to be updat
ed.", |
1546 "location": "path", | 1543 "location": "path", |
1547 "required": true, | 1544 "required": true, |
1548 "type": "string" | 1545 "type": "string" |
1549 } | 1546 } |
1550 }, | 1547 }, |
1551 "path": "v1/callsets/{callSetId}", | 1548 "path": "v1/annotations/{annotationId}", |
| 1549 "request": { |
| 1550 "$ref": "Annotation" |
| 1551 }, |
1552 "response": { | 1552 "response": { |
1553 "$ref": "Empty" | 1553 "$ref": "Annotation" |
1554 }, | 1554 }, |
1555 "scopes": [ | 1555 "scopes": [ |
1556 "https://www.googleapis.com/auth/cloud-platform", | 1556 "https://www.googleapis.com/auth/cloud-platform", |
1557 "https://www.googleapis.com/auth/genomics" | 1557 "https://www.googleapis.com/auth/genomics" |
1558 ] | 1558 ] |
1559 } | 1559 } |
1560 } | 1560 } |
1561 } | 1561 } |
1562 }, | 1562 }, |
1563 "revision": "20170209", | 1563 "revision": "20170302", |
1564 "rootUrl": "https://genomics.googleapis.com/", | 1564 "rootUrl": "https://genomics.googleapis.com/", |
1565 "schemas": { | 1565 "schemas": { |
1566 "Policy": { | |
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).", | |
1568 "id": "Policy", | |
1569 "properties": { | |
1570 "etag": { | |
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", | |
1573 "type": "string" | |
1574 }, | |
1575 "version": { | |
1576 "description": "Version of the `Policy`. The default version
is 0.", | |
1577 "format": "int32", | |
1578 "type": "integer" | |
1579 }, | |
1580 "bindings": { | |
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.", | |
1582 "items": { | |
1583 "$ref": "Binding" | |
1584 }, | |
1585 "type": "array" | |
1586 } | |
1587 }, | |
1588 "type": "object" | |
1589 }, | |
1590 "CancelOperationRequest": { | |
1591 "description": "The request message for Operations.CancelOperation."
, | |
1592 "id": "CancelOperationRequest", | |
1593 "properties": {}, | |
1594 "type": "object" | |
1595 }, | |
1596 "SearchReadsRequest": { | |
1597 "description": "The read search request.", | |
1598 "id": "SearchReadsRequest", | |
1599 "properties": { | |
1600 "readGroupIds": { | |
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": { | |
1603 "type": "string" | |
1604 }, | |
1605 "type": "array" | |
1606 }, | |
1607 "end": { | |
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", | |
1610 "type": "string" | |
1611 }, | |
1612 "pageToken": { | |
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.", | |
1614 "type": "string" | |
1615 }, | |
1616 "pageSize": { | |
1617 "description": "The maximum number of results to return in a
single page. If unspecified,\ndefaults to 256. The maximum value is 2048.", | |
1618 "format": "int32", | |
1619 "type": "integer" | |
1620 }, | |
1621 "start": { | |
1622 "description": "The start position of the range on the refer
ence, 0-based inclusive. If\nspecified, `referenceName` must also be specified."
, | |
1623 "format": "int64", | |
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`.", | |
1632 "items": { | |
1633 "type": "string" | |
1634 }, | |
1635 "type": "array" | |
1636 } | |
1637 }, | |
1638 "type": "object" | |
1639 }, | |
1640 "Annotation": { | 1566 "Annotation": { |
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`.", | 1567 "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`.", |
1642 "id": "Annotation", | 1568 "id": "Annotation", |
1643 "properties": { | 1569 "properties": { |
1644 "variant": { | 1570 "id": { |
1645 "$ref": "VariantAnnotation", | 1571 "description": "The server-generated annotation ID, unique a
cross all annotations.", |
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`." | 1572 "type": "string" |
1647 }, | 1573 }, |
1648 "referenceId": { | 1574 "referenceId": { |
1649 "description": "The ID of the Google Genomics reference asso
ciated with this range.", | 1575 "description": "The ID of the Google Genomics reference asso
ciated with this range.", |
1650 "type": "string" | 1576 "type": "string" |
1651 }, | 1577 }, |
1652 "id": { | |
1653 "description": "The server-generated annotation ID, unique a
cross all annotations.", | |
1654 "type": "string" | |
1655 }, | |
1656 "reverseStrand": { | 1578 "reverseStrand": { |
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.", | 1579 "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.", |
1658 "type": "boolean" | 1580 "type": "boolean" |
1659 }, | 1581 }, |
1660 "referenceName": { | 1582 "referenceName": { |
1661 "description": "The display name corresponding to the refere
nce specified by\n`referenceId`, for example `chr1`, `1`, or `chrX`.", | 1583 "description": "The display name corresponding to the refere
nce specified by\n`referenceId`, for example `chr1`, `1`, or `chrX`.", |
1662 "type": "string" | 1584 "type": "string" |
1663 }, | 1585 }, |
| 1586 "info": { |
| 1587 "additionalProperties": { |
| 1588 "items": { |
| 1589 "type": "any" |
| 1590 }, |
| 1591 "type": "array" |
| 1592 }, |
| 1593 "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).", |
| 1594 "type": "object" |
| 1595 }, |
1664 "type": { | 1596 "type": { |
1665 "description": "The data type for this annotation. Must matc
h the containing annotation\nset's type.", | 1597 "description": "The data type for this annotation. Must matc
h the containing annotation\nset's type.", |
1666 "enum": [ | 1598 "enum": [ |
1667 "ANNOTATION_TYPE_UNSPECIFIED", | 1599 "ANNOTATION_TYPE_UNSPECIFIED", |
1668 "GENERIC", | 1600 "GENERIC", |
1669 "VARIANT", | 1601 "VARIANT", |
1670 "GENE", | 1602 "GENE", |
1671 "TRANSCRIPT" | 1603 "TRANSCRIPT" |
1672 ], | 1604 ], |
1673 "enumDescriptions": [ | 1605 "enumDescriptions": [ |
1674 "", | 1606 "", |
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.", | 1607 "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.", | 1608 "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.", | 1609 "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." | 1610 "A `TRANSCRIPT` annotation type represents the assertion
that a\nparticular region of the reference genome may be transcribed as RNA." |
1679 ], | 1611 ], |
1680 "type": "string" | 1612 "type": "string" |
1681 }, | 1613 }, |
1682 "info": { | |
1683 "additionalProperties": { | |
1684 "items": { | |
1685 "type": "any" | |
1686 }, | |
1687 "type": "array" | |
1688 }, | |
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": { | 1614 "end": { |
1693 "description": "The end position of the range on the referen
ce, 0-based exclusive.", | 1615 "description": "The end position of the range on the referen
ce, 0-based exclusive.", |
1694 "format": "int64", | 1616 "format": "int64", |
1695 "type": "string" | 1617 "type": "string" |
1696 }, | 1618 }, |
1697 "transcript": { | 1619 "transcript": { |
1698 "$ref": "Transcript", | 1620 "$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`." | 1621 "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 }, | 1622 }, |
1701 "start": { | 1623 "start": { |
1702 "description": "The start position of the range on the refer
ence, 0-based inclusive.", | 1624 "description": "The start position of the range on the refer
ence, 0-based inclusive.", |
1703 "format": "int64", | 1625 "format": "int64", |
1704 "type": "string" | 1626 "type": "string" |
1705 }, | 1627 }, |
1706 "annotationSetId": { | 1628 "annotationSetId": { |
1707 "description": "The annotation set to which this annotation
belongs.", | 1629 "description": "The annotation set to which this annotation
belongs.", |
1708 "type": "string" | 1630 "type": "string" |
1709 }, | 1631 }, |
1710 "name": { | 1632 "name": { |
1711 "description": "The display name of this annotation.", | 1633 "description": "The display name of this annotation.", |
1712 "type": "string" | 1634 "type": "string" |
| 1635 }, |
| 1636 "variant": { |
| 1637 "$ref": "VariantAnnotation", |
| 1638 "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`." |
1713 } | 1639 } |
1714 }, | 1640 }, |
1715 "type": "object" | 1641 "type": "object" |
| 1642 }, |
| 1643 "CancelOperationRequest": { |
| 1644 "description": "The request message for Operations.CancelOperation."
, |
| 1645 "id": "CancelOperationRequest", |
| 1646 "properties": {}, |
| 1647 "type": "object" |
| 1648 }, |
| 1649 "SearchReadsRequest": { |
| 1650 "description": "The read search request.", |
| 1651 "id": "SearchReadsRequest", |
| 1652 "properties": { |
| 1653 "readGroupIds": { |
| 1654 "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`.", |
| 1655 "items": { |
| 1656 "type": "string" |
| 1657 }, |
| 1658 "type": "array" |
| 1659 }, |
| 1660 "end": { |
| 1661 "description": "The end position of the range on the referen
ce, 0-based exclusive. If\nspecified, `referenceName` must also be specified.", |
| 1662 "format": "int64", |
| 1663 "type": "string" |
| 1664 }, |
| 1665 "pageToken": { |
| 1666 "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.", |
| 1667 "type": "string" |
| 1668 }, |
| 1669 "pageSize": { |
| 1670 "description": "The maximum number of results to return in a
single page. If unspecified,\ndefaults to 256. The maximum value is 2048.", |
| 1671 "format": "int32", |
| 1672 "type": "integer" |
| 1673 }, |
| 1674 "start": { |
| 1675 "description": "The start position of the range on the refer
ence, 0-based inclusive. If\nspecified, `referenceName` must also be specified."
, |
| 1676 "format": "int64", |
| 1677 "type": "string" |
| 1678 }, |
| 1679 "referenceName": { |
| 1680 "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.", |
| 1681 "type": "string" |
| 1682 }, |
| 1683 "readGroupSetIds": { |
| 1684 "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`.", |
| 1685 "items": { |
| 1686 "type": "string" |
| 1687 }, |
| 1688 "type": "array" |
| 1689 } |
| 1690 }, |
| 1691 "type": "object" |
| 1692 }, |
| 1693 "RuntimeMetadata": { |
| 1694 "description": "Runtime metadata that will be populated in the\nrunt
imeMetadata\nfield of the Operation associated with a RunPipeline execution.", |
| 1695 "id": "RuntimeMetadata", |
| 1696 "properties": { |
| 1697 "computeEngine": { |
| 1698 "$ref": "ComputeEngine", |
| 1699 "description": "Execution information specific to Google Com
pute Engine." |
| 1700 } |
| 1701 }, |
| 1702 "type": "object" |
1716 }, | 1703 }, |
1717 "Operation": { | 1704 "Operation": { |
1718 "description": "This resource represents a long-running operation th
at is the result of a\nnetwork API call.", | 1705 "description": "This resource represents a long-running operation th
at is the result of a\nnetwork API call.", |
1719 "id": "Operation", | 1706 "id": "Operation", |
1720 "properties": { | 1707 "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": { | 1708 "response": { |
1726 "additionalProperties": { | 1709 "additionalProperties": { |
1727 "description": "Properties of the object. Contains field
@type with type URL.", | 1710 "description": "Properties of the object. Contains field
@type with type URL.", |
1728 "type": "any" | 1711 "type": "any" |
1729 }, | 1712 }, |
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.", | 1713 "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" | 1714 "type": "object" |
1732 }, | 1715 }, |
1733 "name": { | 1716 "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`", | 1717 "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" | 1718 "type": "string" |
1736 }, | 1719 }, |
1737 "error": { | 1720 "error": { |
1738 "$ref": "Status", | 1721 "$ref": "Status", |
1739 "description": "The error result of the operation in case of
failure or cancellation." | 1722 "description": "The error result of the operation in case of
failure or cancellation." |
1740 }, | 1723 }, |
1741 "metadata": { | 1724 "metadata": { |
1742 "additionalProperties": { | 1725 "additionalProperties": { |
1743 "description": "Properties of the object. Contains field
@type with type URL.", | 1726 "description": "Properties of the object. Contains field
@type with type URL.", |
1744 "type": "any" | 1727 "type": "any" |
1745 }, | 1728 }, |
1746 "description": "An OperationMetadata object. This will alway
s be returned with the Operation.", | 1729 "description": "An OperationMetadata object. This will alway
s be returned with the Operation.", |
1747 "type": "object" | 1730 "type": "object" |
| 1731 }, |
| 1732 "done": { |
| 1733 "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.", |
| 1734 "type": "boolean" |
1748 } | 1735 } |
1749 }, | 1736 }, |
1750 "type": "object" | 1737 "type": "object" |
1751 }, | |
1752 "RuntimeMetadata": { | |
1753 "description": "Runtime metadata that will be populated in the\nrunt
imeMetadata\nfield of the Operation associated with a RunPipeline execution.", | |
1754 "id": "RuntimeMetadata", | |
1755 "properties": { | |
1756 "computeEngine": { | |
1757 "$ref": "ComputeEngine", | |
1758 "description": "Execution information specific to Google Com
pute Engine." | |
1759 } | |
1760 }, | |
1761 "type": "object" | |
1762 }, | 1738 }, |
1763 "ImportReadGroupSetsResponse": { | 1739 "ImportReadGroupSetsResponse": { |
1764 "description": "The read group set import response.", | 1740 "description": "The read group set import response.", |
1765 "id": "ImportReadGroupSetsResponse", | 1741 "id": "ImportReadGroupSetsResponse", |
1766 "properties": { | 1742 "properties": { |
1767 "readGroupSetIds": { | 1743 "readGroupSetIds": { |
1768 "description": "IDs of the read group sets that were created
.", | 1744 "description": "IDs of the read group sets that were created
.", |
1769 "items": { | 1745 "items": { |
1770 "type": "string" | 1746 "type": "string" |
1771 }, | 1747 }, |
1772 "type": "array" | 1748 "type": "array" |
1773 } | 1749 } |
1774 }, | 1750 }, |
1775 "type": "object" | 1751 "type": "object" |
1776 }, | 1752 }, |
1777 "VariantCall": { | 1753 "VariantCall": { |
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.", | 1754 "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", | 1755 "id": "VariantCall", |
1780 "properties": { | 1756 "properties": { |
1781 "phaseset": { | |
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 `*`.", | |
1783 "type": "string" | |
1784 }, | |
1785 "info": { | |
1786 "additionalProperties": { | |
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": { | 1757 "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`.", | 1758 "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": { | 1759 "items": { |
1802 "format": "double", | 1760 "format": "double", |
1803 "type": "number" | 1761 "type": "number" |
1804 }, | 1762 }, |
1805 "type": "array" | 1763 "type": "array" |
1806 }, | 1764 }, |
1807 "callSetId": { | 1765 "callSetId": { |
1808 "description": "The ID of the call set this variant call bel
ongs to.", | 1766 "description": "The ID of the call set this variant call bel
ongs to.", |
1809 "type": "string" | 1767 "type": "string" |
1810 }, | 1768 }, |
1811 "genotype": { | 1769 "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.", | 1770 "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": { | 1771 "items": { |
1814 "format": "int32", | 1772 "format": "int32", |
1815 "type": "integer" | 1773 "type": "integer" |
1816 }, | 1774 }, |
1817 "type": "array" | 1775 "type": "array" |
| 1776 }, |
| 1777 "phaseset": { |
| 1778 "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 `*`.", |
| 1779 "type": "string" |
| 1780 }, |
| 1781 "info": { |
| 1782 "additionalProperties": { |
| 1783 "items": { |
| 1784 "type": "any" |
| 1785 }, |
| 1786 "type": "array" |
| 1787 }, |
| 1788 "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).", |
| 1789 "type": "object" |
| 1790 }, |
| 1791 "callSetName": { |
| 1792 "description": "The name of the call set this variant call b
elongs to.", |
| 1793 "type": "string" |
1818 } | 1794 } |
1819 }, | 1795 }, |
1820 "type": "object" | 1796 "type": "object" |
1821 }, | 1797 }, |
1822 "SearchVariantsResponse": { | 1798 "SearchVariantsResponse": { |
1823 "description": "The variant search response.", | 1799 "description": "The variant search response.", |
1824 "id": "SearchVariantsResponse", | 1800 "id": "SearchVariantsResponse", |
1825 "properties": { | 1801 "properties": { |
1826 "nextPageToken": { | 1802 "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.", | 1803 "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.", |
(...skipping 48 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1876 "description": "Properties of the object. Contains f
ield @type with type URL.", | 1852 "description": "Properties of the object. Contains f
ield @type with type URL.", |
1877 "type": "any" | 1853 "type": "any" |
1878 }, | 1854 }, |
1879 "type": "object" | 1855 "type": "object" |
1880 }, | 1856 }, |
1881 "type": "array" | 1857 "type": "array" |
1882 } | 1858 } |
1883 }, | 1859 }, |
1884 "type": "object" | 1860 "type": "object" |
1885 }, | 1861 }, |
| 1862 "Binding": { |
| 1863 "description": "Associates `members` with a `role`.", |
| 1864 "id": "Binding", |
| 1865 "properties": { |
| 1866 "role": { |
| 1867 "description": "Role that is assigned to `members`.\nFor exa
mple, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired", |
| 1868 "type": "string" |
| 1869 }, |
| 1870 "members": { |
| 1871 "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", |
| 1872 "items": { |
| 1873 "type": "string" |
| 1874 }, |
| 1875 "type": "array" |
| 1876 } |
| 1877 }, |
| 1878 "type": "object" |
| 1879 }, |
1886 "UndeleteDatasetRequest": { | 1880 "UndeleteDatasetRequest": { |
1887 "id": "UndeleteDatasetRequest", | 1881 "id": "UndeleteDatasetRequest", |
1888 "properties": {}, | 1882 "properties": {}, |
1889 "type": "object" | 1883 "type": "object" |
1890 }, | 1884 }, |
1891 "Binding": { | |
1892 "description": "Associates `members` with a `role`.", | |
1893 "id": "Binding", | |
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 }, | |
1902 "role": { | |
1903 "description": "Role that is assigned to `members`.\nFor exa
mple, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired", | |
1904 "type": "string" | |
1905 } | |
1906 }, | |
1907 "type": "object" | |
1908 }, | |
1909 "Range": { | 1885 "Range": { |
1910 "description": "A 0-based half-open genomic coordinate range for sea
rch requests.", | 1886 "description": "A 0-based half-open genomic coordinate range for sea
rch requests.", |
1911 "id": "Range", | 1887 "id": "Range", |
1912 "properties": { | 1888 "properties": { |
| 1889 "referenceName": { |
| 1890 "description": "The reference sequence name, for example `ch
r1`,\n`1`, or `chrX`.", |
| 1891 "type": "string" |
| 1892 }, |
1913 "start": { | 1893 "start": { |
1914 "description": "The start position of the range on the refer
ence, 0-based inclusive.", | 1894 "description": "The start position of the range on the refer
ence, 0-based inclusive.", |
1915 "format": "int64", | 1895 "format": "int64", |
1916 "type": "string" | 1896 "type": "string" |
1917 }, | 1897 }, |
1918 "end": { | 1898 "end": { |
1919 "description": "The end position of the range on the referen
ce, 0-based exclusive.", | 1899 "description": "The end position of the range on the referen
ce, 0-based exclusive.", |
1920 "format": "int64", | 1900 "format": "int64", |
1921 "type": "string" | 1901 "type": "string" |
1922 }, | |
1923 "referenceName": { | |
1924 "description": "The reference sequence name, for example `ch
r1`,\n`1`, or `chrX`.", | |
1925 "type": "string" | |
1926 } | 1902 } |
1927 }, | 1903 }, |
1928 "type": "object" | 1904 "type": "object" |
1929 }, | 1905 }, |
1930 "VariantSet": { | 1906 "VariantSet": { |
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)
", | 1907 "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)
", |
1932 "id": "VariantSet", | 1908 "id": "VariantSet", |
1933 "properties": { | 1909 "properties": { |
1934 "description": { | |
1935 "description": "A textual description of this variant set.", | |
1936 "type": "string" | |
1937 }, | |
1938 "datasetId": { | 1910 "datasetId": { |
1939 "description": "The dataset to which this variant set belong
s.", | 1911 "description": "The dataset to which this variant set belong
s.", |
1940 "type": "string" | 1912 "type": "string" |
1941 }, | 1913 }, |
1942 "name": { | 1914 "name": { |
1943 "description": "User-specified, mutable name.", | 1915 "description": "User-specified, mutable name.", |
1944 "type": "string" | 1916 "type": "string" |
1945 }, | 1917 }, |
1946 "referenceSetId": { | 1918 "referenceSetId": { |
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.", | 1919 "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" | 1920 "type": "string" |
1949 }, | 1921 }, |
1950 "metadata": { | 1922 "metadata": { |
1951 "description": "The metadata associated with this variant se
t.", | 1923 "description": "The metadata associated with this variant se
t.", |
1952 "items": { | 1924 "items": { |
1953 "$ref": "VariantSetMetadata" | 1925 "$ref": "VariantSetMetadata" |
1954 }, | 1926 }, |
1955 "type": "array" | 1927 "type": "array" |
1956 }, | 1928 }, |
1957 "referenceBounds": { | 1929 "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.", | 1930 "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": { | 1931 "items": { |
1960 "$ref": "ReferenceBound" | 1932 "$ref": "ReferenceBound" |
1961 }, | 1933 }, |
1962 "type": "array" | 1934 "type": "array" |
1963 }, | 1935 }, |
1964 "id": { | 1936 "id": { |
1965 "description": "The server-generated variant set ID, unique
across all variant sets.", | 1937 "description": "The server-generated variant set ID, unique
across all variant sets.", |
1966 "type": "string" | 1938 "type": "string" |
| 1939 }, |
| 1940 "description": { |
| 1941 "description": "A textual description of this variant set.", |
| 1942 "type": "string" |
1967 } | 1943 } |
1968 }, | 1944 }, |
1969 "type": "object" | 1945 "type": "object" |
1970 }, | 1946 }, |
1971 "ReferenceBound": { | 1947 "ReferenceBound": { |
1972 "description": "ReferenceBound records an upper bound for the starti
ng coordinate of\nvariants in a particular reference.", | 1948 "description": "ReferenceBound records an upper bound for the starti
ng coordinate of\nvariants in a particular reference.", |
1973 "id": "ReferenceBound", | 1949 "id": "ReferenceBound", |
1974 "properties": { | 1950 "properties": { |
1975 "upperBound": { | 1951 "upperBound": { |
1976 "description": "An upper bound (inclusive) on the starting c
oordinate of any\nvariant in the reference sequence.", | 1952 "description": "An upper bound (inclusive) on the starting c
oordinate of any\nvariant in the reference sequence.", |
(...skipping 13 matching lines...) Expand all Loading... |
1990 "entries": { | 1966 "entries": { |
1991 "description": "The resulting per-annotation entries, ordere
d consistently with the\noriginal request.", | 1967 "description": "The resulting per-annotation entries, ordere
d consistently with the\noriginal request.", |
1992 "items": { | 1968 "items": { |
1993 "$ref": "Entry" | 1969 "$ref": "Entry" |
1994 }, | 1970 }, |
1995 "type": "array" | 1971 "type": "array" |
1996 } | 1972 } |
1997 }, | 1973 }, |
1998 "type": "object" | 1974 "type": "object" |
1999 }, | 1975 }, |
2000 "SearchCallSetsResponse": { | 1976 "ListOperationsResponse": { |
2001 "description": "The call set search response.", | 1977 "description": "The response message for Operations.ListOperations."
, |
2002 "id": "SearchCallSetsResponse", | 1978 "id": "ListOperationsResponse", |
2003 "properties": { | 1979 "properties": { |
2004 "callSets": { | 1980 "nextPageToken": { |
2005 "description": "The list of matching call sets.", | 1981 "description": "The standard List next-page token.", |
| 1982 "type": "string" |
| 1983 }, |
| 1984 "operations": { |
| 1985 "description": "A list of operations that matches the specif
ied filter in the request.", |
2006 "items": { | 1986 "items": { |
2007 "$ref": "CallSet" | 1987 "$ref": "Operation" |
2008 }, | 1988 }, |
2009 "type": "array" | 1989 "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 } | 1990 } |
2015 }, | 1991 }, |
2016 "type": "object" | 1992 "type": "object" |
2017 }, | 1993 }, |
2018 "Variant": { | 1994 "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.", | 1995 "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", | 1996 "id": "Variant", |
2021 "properties": { | 1997 "properties": { |
| 1998 "start": { |
| 1999 "description": "The position at which this variant occurs (0
-based).\nThis corresponds to the first base of the string of reference bases.", |
| 2000 "format": "int64", |
| 2001 "type": "string" |
| 2002 }, |
| 2003 "quality": { |
| 2004 "description": "A measure of how likely this variant is to b
e real.\nA higher value is better.", |
| 2005 "format": "double", |
| 2006 "type": "number" |
| 2007 }, |
| 2008 "id": { |
| 2009 "description": "The server-generated variant ID, unique acro
ss all variants.", |
| 2010 "type": "string" |
| 2011 }, |
2022 "variantSetId": { | 2012 "variantSetId": { |
2023 "description": "The ID of the variant set this variant belon
gs to.", | 2013 "description": "The ID of the variant set this variant belon
gs to.", |
2024 "type": "string" | 2014 "type": "string" |
2025 }, | 2015 }, |
2026 "referenceName": { | 2016 "referenceName": { |
2027 "description": "The reference on which this variant occurs.\
n(such as `chr20` or `X`)", | 2017 "description": "The reference on which this variant occurs.\
n(such as `chr20` or `X`)", |
2028 "type": "string" | 2018 "type": "string" |
2029 }, | 2019 }, |
2030 "info": { | 2020 "info": { |
2031 "additionalProperties": { | 2021 "additionalProperties": { |
2032 "items": { | 2022 "items": { |
2033 "type": "any" | 2023 "type": "any" |
2034 }, | 2024 }, |
2035 "type": "array" | 2025 "type": "array" |
2036 }, | 2026 }, |
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).", | 2027 "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" | 2028 "type": "object" |
2039 }, | 2029 }, |
2040 "referenceBases": { | 2030 "referenceBases": { |
2041 "description": "The reference bases for this variant. They s
tart at the given\nposition.", | 2031 "description": "The reference bases for this variant. They s
tart at the given\nposition.", |
2042 "type": "string" | 2032 "type": "string" |
2043 }, | 2033 }, |
| 2034 "alternateBases": { |
| 2035 "description": "The bases that appear instead of the referen
ce bases.", |
| 2036 "items": { |
| 2037 "type": "string" |
| 2038 }, |
| 2039 "type": "array" |
| 2040 }, |
2044 "names": { | 2041 "names": { |
2045 "description": "Names for the variant, for example a RefSNP
ID.", | 2042 "description": "Names for the variant, for example a RefSNP
ID.", |
2046 "items": { | 2043 "items": { |
2047 "type": "string" | 2044 "type": "string" |
2048 }, | 2045 }, |
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" | 2046 "type": "array" |
2057 }, | 2047 }, |
2058 "end": { | 2048 "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.
", | 2049 "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", | 2050 "format": "int64", |
2061 "type": "string" | 2051 "type": "string" |
2062 }, | 2052 }, |
2063 "filter": { | 2053 "filter": { |
2064 "description": "A list of filters (normally quality filters)
this variant has failed.\n`PASS` indicates this variant has passed all filters.
", | 2054 "description": "A list of filters (normally quality filters)
this variant has failed.\n`PASS` indicates this variant has passed all filters.
", |
2065 "items": { | 2055 "items": { |
2066 "type": "string" | 2056 "type": "string" |
2067 }, | 2057 }, |
2068 "type": "array" | 2058 "type": "array" |
2069 }, | 2059 }, |
2070 "calls": { | 2060 "calls": { |
2071 "description": "The variant calls for this particular varian
t. Each one represents the\ndetermination of genotype with respect to this varia
nt.", | 2061 "description": "The variant calls for this particular varian
t. Each one represents the\ndetermination of genotype with respect to this varia
nt.", |
2072 "items": { | 2062 "items": { |
2073 "$ref": "VariantCall" | 2063 "$ref": "VariantCall" |
2074 }, | 2064 }, |
2075 "type": "array" | 2065 "type": "array" |
2076 }, | 2066 }, |
2077 "created": { | 2067 "created": { |
2078 "description": "The date this variant was created, in millis
econds from the epoch.", | 2068 "description": "The date this variant was created, in millis
econds from the epoch.", |
2079 "format": "int64", | 2069 "format": "int64", |
2080 "type": "string" | 2070 "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 } | 2071 } |
2096 }, | 2072 }, |
2097 "type": "object" | 2073 "type": "object" |
2098 }, | 2074 }, |
2099 "ListOperationsResponse": { | 2075 "SearchCallSetsResponse": { |
2100 "description": "The response message for Operations.ListOperations."
, | 2076 "description": "The call set search response.", |
2101 "id": "ListOperationsResponse", | 2077 "id": "SearchCallSetsResponse", |
2102 "properties": { | 2078 "properties": { |
2103 "nextPageToken": { | 2079 "nextPageToken": { |
2104 "description": "The standard List next-page token.", | 2080 "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.", |
2105 "type": "string" | 2081 "type": "string" |
2106 }, | 2082 }, |
2107 "operations": { | 2083 "callSets": { |
2108 "description": "A list of operations that matches the specif
ied filter in the request.", | 2084 "description": "The list of matching call sets.", |
2109 "items": { | 2085 "items": { |
2110 "$ref": "Operation" | 2086 "$ref": "CallSet" |
2111 }, | 2087 }, |
2112 "type": "array" | 2088 "type": "array" |
2113 } | 2089 } |
2114 }, | 2090 }, |
2115 "type": "object" | 2091 "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" | |
2124 }, | |
2125 "clientId": { | |
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", | |
2172 "type": "string" | |
2173 } | |
2174 }, | |
2175 "type": "object" | |
2176 }, | 2092 }, |
2177 "SearchVariantsRequest": { | 2093 "SearchVariantsRequest": { |
2178 "description": "The variant search request.", | 2094 "description": "The variant search request.", |
2179 "id": "SearchVariantsRequest", | 2095 "id": "SearchVariantsRequest", |
2180 "properties": { | 2096 "properties": { |
2181 "referenceName": { | 2097 "referenceName": { |
2182 "description": "Required. Only return variants in this refer
ence sequence.", | 2098 "description": "Required. Only return variants in this refer
ence sequence.", |
2183 "type": "string" | 2099 "type": "string" |
2184 }, | 2100 }, |
2185 "variantSetIds": { | 2101 "variantSetIds": { |
(...skipping 34 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2220 "format": "int64", | 2136 "format": "int64", |
2221 "type": "string" | 2137 "type": "string" |
2222 }, | 2138 }, |
2223 "variantName": { | 2139 "variantName": { |
2224 "description": "Only return variants which have exactly this
name.", | 2140 "description": "Only return variants which have exactly this
name.", |
2225 "type": "string" | 2141 "type": "string" |
2226 } | 2142 } |
2227 }, | 2143 }, |
2228 "type": "object" | 2144 "type": "object" |
2229 }, | 2145 }, |
| 2146 "OperationMetadata": { |
| 2147 "description": "Metadata describing an Operation.", |
| 2148 "id": "OperationMetadata", |
| 2149 "properties": { |
| 2150 "projectId": { |
| 2151 "description": "The Google Cloud Project in which the job is
scoped.", |
| 2152 "type": "string" |
| 2153 }, |
| 2154 "clientId": { |
| 2155 "description": "This field is deprecated. Use `labels` inste
ad. Optionally provided by the\ncaller when submitting the request that creates
the operation.", |
| 2156 "type": "string" |
| 2157 }, |
| 2158 "events": { |
| 2159 "description": "Optional event messages that were generated
during the job's execution.\nThis also contains any warnings that were generated
during import\nor export.", |
| 2160 "items": { |
| 2161 "$ref": "OperationEvent" |
| 2162 }, |
| 2163 "type": "array" |
| 2164 }, |
| 2165 "endTime": { |
| 2166 "description": "The time at which the job stopped running.", |
| 2167 "format": "google-datetime", |
| 2168 "type": "string" |
| 2169 }, |
| 2170 "startTime": { |
| 2171 "description": "The time at which the job began to run.", |
| 2172 "format": "google-datetime", |
| 2173 "type": "string" |
| 2174 }, |
| 2175 "request": { |
| 2176 "additionalProperties": { |
| 2177 "description": "Properties of the object. Contains field
@type with type URL.", |
| 2178 "type": "any" |
| 2179 }, |
| 2180 "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.", |
| 2181 "type": "object" |
| 2182 }, |
| 2183 "runtimeMetadata": { |
| 2184 "additionalProperties": { |
| 2185 "description": "Properties of the object. Contains field
@type with type URL.", |
| 2186 "type": "any" |
| 2187 }, |
| 2188 "description": "Runtime metadata on this Operation.", |
| 2189 "type": "object" |
| 2190 }, |
| 2191 "createTime": { |
| 2192 "description": "The time at which the job was submitted to t
he Genomics service.", |
| 2193 "format": "google-datetime", |
| 2194 "type": "string" |
| 2195 }, |
| 2196 "labels": { |
| 2197 "additionalProperties": { |
| 2198 "type": "string" |
| 2199 }, |
| 2200 "description": "Optionally provided by the caller when submi
tting the request that creates\nthe operation.", |
| 2201 "type": "object" |
| 2202 } |
| 2203 }, |
| 2204 "type": "object" |
| 2205 }, |
2230 "SearchReadGroupSetsRequest": { | 2206 "SearchReadGroupSetsRequest": { |
2231 "description": "The read group set search request.", | 2207 "description": "The read group set search request.", |
2232 "id": "SearchReadGroupSetsRequest", | 2208 "id": "SearchReadGroupSetsRequest", |
2233 "properties": { | 2209 "properties": { |
| 2210 "datasetIds": { |
| 2211 "description": "Restricts this query to read group sets with
in the given datasets. At least\none ID must be provided.", |
| 2212 "items": { |
| 2213 "type": "string" |
| 2214 }, |
| 2215 "type": "array" |
| 2216 }, |
2234 "name": { | 2217 "name": { |
2235 "description": "Only return read group sets for which a subs
tring of the name matches this\nstring.", | 2218 "description": "Only return read group sets for which a subs
tring of the name matches this\nstring.", |
2236 "type": "string" | 2219 "type": "string" |
2237 }, | 2220 }, |
2238 "pageToken": { | 2221 "pageToken": { |
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.", | 2222 "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.", |
2240 "type": "string" | 2223 "type": "string" |
2241 }, | 2224 }, |
2242 "pageSize": { | 2225 "pageSize": { |
2243 "description": "The maximum number of results to return in a
single page. If unspecified,\ndefaults to 256. The maximum value is 1024.", | 2226 "description": "The maximum number of results to return in a
single page. If unspecified,\ndefaults to 256. The maximum value is 1024.", |
2244 "format": "int32", | 2227 "format": "int32", |
2245 "type": "integer" | 2228 "type": "integer" |
2246 }, | |
2247 "datasetIds": { | |
2248 "description": "Restricts this query to read group sets with
in the given datasets. At least\none ID must be provided.", | |
2249 "items": { | |
2250 "type": "string" | |
2251 }, | |
2252 "type": "array" | |
2253 } | 2229 } |
2254 }, | 2230 }, |
2255 "type": "object" | 2231 "type": "object" |
2256 }, | 2232 }, |
2257 "SearchAnnotationsResponse": { | 2233 "SearchAnnotationsResponse": { |
2258 "id": "SearchAnnotationsResponse", | 2234 "id": "SearchAnnotationsResponse", |
2259 "properties": { | 2235 "properties": { |
| 2236 "nextPageToken": { |
| 2237 "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.", |
| 2238 "type": "string" |
| 2239 }, |
2260 "annotations": { | 2240 "annotations": { |
2261 "description": "The matching annotations.", | 2241 "description": "The matching annotations.", |
2262 "items": { | 2242 "items": { |
2263 "$ref": "Annotation" | 2243 "$ref": "Annotation" |
2264 }, | 2244 }, |
2265 "type": "array" | 2245 "type": "array" |
2266 }, | |
2267 "nextPageToken": { | |
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.", | |
2269 "type": "string" | |
2270 } | 2246 } |
2271 }, | 2247 }, |
2272 "type": "object" | 2248 "type": "object" |
2273 }, | 2249 }, |
2274 "ClinicalCondition": { | 2250 "ClinicalCondition": { |
2275 "id": "ClinicalCondition", | 2251 "id": "ClinicalCondition", |
2276 "properties": { | 2252 "properties": { |
| 2253 "omimId": { |
| 2254 "description": "The OMIM id for this condition.\nSearch for
these IDs at http://omim.org/", |
| 2255 "type": "string" |
| 2256 }, |
| 2257 "externalIds": { |
| 2258 "description": "The set of external IDs for this condition."
, |
| 2259 "items": { |
| 2260 "$ref": "ExternalId" |
| 2261 }, |
| 2262 "type": "array" |
| 2263 }, |
2277 "conceptId": { | 2264 "conceptId": { |
2278 "description": "The MedGen concept id associated with this g
ene.\nSearch for these IDs at http://www.ncbi.nlm.nih.gov/medgen/", | 2265 "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" | 2266 "type": "string" |
2280 }, | 2267 }, |
2281 "names": { | 2268 "names": { |
2282 "description": "A set of names for the condition.", | 2269 "description": "A set of names for the condition.", |
2283 "items": { | 2270 "items": { |
2284 "type": "string" | 2271 "type": "string" |
2285 }, | 2272 }, |
2286 "type": "array" | 2273 "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 } | 2274 } |
2299 }, | 2275 }, |
2300 "type": "object" | 2276 "type": "object" |
2301 }, | 2277 }, |
2302 "SearchReadsResponse": { | 2278 "SearchReadsResponse": { |
2303 "description": "The read search response.", | 2279 "description": "The read search response.", |
2304 "id": "SearchReadsResponse", | 2280 "id": "SearchReadsResponse", |
2305 "properties": { | 2281 "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": { | 2282 "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.", | 2283 "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": { | 2284 "items": { |
2313 "$ref": "Read" | 2285 "$ref": "Read" |
2314 }, | 2286 }, |
2315 "type": "array" | 2287 "type": "array" |
| 2288 }, |
| 2289 "nextPageToken": { |
| 2290 "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.", |
| 2291 "type": "string" |
2316 } | 2292 } |
2317 }, | 2293 }, |
2318 "type": "object" | 2294 "type": "object" |
2319 }, | 2295 }, |
2320 "Program": { | 2296 "Program": { |
2321 "id": "Program", | 2297 "id": "Program", |
2322 "properties": { | 2298 "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": { | 2299 "commandLine": { |
2328 "description": "The command line used to run this program.", | 2300 "description": "The command line used to run this program.", |
2329 "type": "string" | 2301 "type": "string" |
2330 }, | 2302 }, |
2331 "prevProgramId": { | 2303 "prevProgramId": { |
2332 "description": "The ID of the program run before this one.", | 2304 "description": "The ID of the program run before this one.", |
2333 "type": "string" | 2305 "type": "string" |
2334 }, | 2306 }, |
2335 "id": { | 2307 "id": { |
2336 "description": "The user specified locally unique ID of the
program. Used along with\n`prevProgramId` to define an ordering between programs
.", | 2308 "description": "The user specified locally unique ID of the
program. Used along with\n`prevProgramId` to define an ordering between programs
.", |
2337 "type": "string" | 2309 "type": "string" |
2338 }, | 2310 }, |
2339 "version": { | 2311 "version": { |
2340 "description": "The version of the program run.", | 2312 "description": "The version of the program run.", |
2341 "type": "string" | 2313 "type": "string" |
| 2314 }, |
| 2315 "name": { |
| 2316 "description": "The display name of the program. This is typ
ically the colloquial name of\nthe tool used, for example 'bwa' or 'picard'.", |
| 2317 "type": "string" |
2342 } | 2318 } |
2343 }, | 2319 }, |
2344 "type": "object" | 2320 "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 }, | 2321 }, |
2362 "ComputeEngine": { | 2322 "ComputeEngine": { |
2363 "description": "Describes a Compute Engine resource that is being ma
naged by a running\npipeline.", | 2323 "description": "Describes a Compute Engine resource that is being ma
naged by a running\npipeline.", |
2364 "id": "ComputeEngine", | 2324 "id": "ComputeEngine", |
2365 "properties": { | 2325 "properties": { |
2366 "instanceName": { | |
2367 "description": "The instance on which the operation is runni
ng.", | |
2368 "type": "string" | |
2369 }, | |
2370 "zone": { | 2326 "zone": { |
2371 "description": "The availability zone in which the instance
resides.", | 2327 "description": "The availability zone in which the instance
resides.", |
2372 "type": "string" | 2328 "type": "string" |
2373 }, | 2329 }, |
2374 "machineType": { | 2330 "machineType": { |
2375 "description": "The machine type of the instance.", | 2331 "description": "The machine type of the instance.", |
2376 "type": "string" | 2332 "type": "string" |
2377 }, | 2333 }, |
2378 "diskNames": { | 2334 "diskNames": { |
2379 "description": "The names of the disks that were created for
this pipeline.", | 2335 "description": "The names of the disks that were created for
this pipeline.", |
2380 "items": { | 2336 "items": { |
2381 "type": "string" | 2337 "type": "string" |
2382 }, | 2338 }, |
2383 "type": "array" | 2339 "type": "array" |
| 2340 }, |
| 2341 "instanceName": { |
| 2342 "description": "The instance on which the operation is runni
ng.", |
| 2343 "type": "string" |
2384 } | 2344 } |
2385 }, | 2345 }, |
2386 "type": "object" | 2346 "type": "object" |
| 2347 }, |
| 2348 "CoverageBucket": { |
| 2349 "description": "A bucket over which read coverage has been precomput
ed. A bucket corresponds\nto a specific range of the reference sequence.", |
| 2350 "id": "CoverageBucket", |
| 2351 "properties": { |
| 2352 "meanCoverage": { |
| 2353 "description": "The average number of reads which are aligne
d to each individual\nreference base in this bucket.", |
| 2354 "format": "float", |
| 2355 "type": "number" |
| 2356 }, |
| 2357 "range": { |
| 2358 "$ref": "Range", |
| 2359 "description": "The genomic coordinate range spanned by this
bucket." |
| 2360 } |
| 2361 }, |
| 2362 "type": "object" |
2387 }, | 2363 }, |
2388 "ExternalId": { | 2364 "ExternalId": { |
2389 "id": "ExternalId", | 2365 "id": "ExternalId", |
2390 "properties": { | 2366 "properties": { |
2391 "sourceName": { | 2367 "sourceName": { |
2392 "description": "The name of the source of this data.", | 2368 "description": "The name of the source of this data.", |
2393 "type": "string" | 2369 "type": "string" |
2394 }, | 2370 }, |
2395 "id": { | 2371 "id": { |
2396 "description": "The id used by the source of this data.", | 2372 "description": "The id used by the source of this data.", |
2397 "type": "string" | 2373 "type": "string" |
2398 } | 2374 } |
2399 }, | 2375 }, |
2400 "type": "object" | 2376 "type": "object" |
2401 }, | 2377 }, |
2402 "Reference": { | 2378 "SearchVariantSetsRequest": { |
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)", | 2379 "description": "The search variant sets request.", |
2404 "id": "Reference", | 2380 "id": "SearchVariantSetsRequest", |
2405 "properties": { | 2381 "properties": { |
2406 "md5checksum": { | 2382 "datasetIds": { |
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.", | 2383 "description": "Exactly one dataset ID must be provided here
. Only variant sets which\nbelong to this dataset will be returned.", |
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": { | 2384 "items": { |
2422 "type": "string" | 2385 "type": "string" |
2423 }, | 2386 }, |
2424 "type": "array" | 2387 "type": "array" |
2425 }, | 2388 }, |
2426 "ncbiTaxonId": { | 2389 "pageToken": { |
2427 "description": "ID from http://www.ncbi.nlm.nih.gov/taxonomy
. For example, 9606 for human.", | 2390 "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.", |
| 2391 "type": "string" |
| 2392 }, |
| 2393 "pageSize": { |
| 2394 "description": "The maximum number of results to return in a
single page. If unspecified,\ndefaults to 1024.", |
2428 "format": "int32", | 2395 "format": "int32", |
2429 "type": "integer" | 2396 "type": "integer" |
2430 }, | |
2431 "sourceUri": { | |
2432 "description": "The URI from which the sequence was obtained
. Typically specifies a FASTA\nformat file.", | |
2433 "type": "string" | |
2434 }, | |
2435 "name": { | |
2436 "description": "The name of this reference, for example `22`
.", | |
2437 "type": "string" | |
2438 } | 2397 } |
2439 }, | 2398 }, |
2440 "type": "object" | 2399 "type": "object" |
2441 }, | 2400 }, |
2442 "VariantSetMetadata": { | 2401 "VariantSetMetadata": { |
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.", | 2402 "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.", |
2444 "id": "VariantSetMetadata", | 2403 "id": "VariantSetMetadata", |
2445 "properties": { | 2404 "properties": { |
2446 "description": { | |
2447 "description": "A textual description of this metadata.", | |
2448 "type": "string" | |
2449 }, | |
2450 "info": { | 2405 "info": { |
2451 "additionalProperties": { | 2406 "additionalProperties": { |
2452 "items": { | 2407 "items": { |
2453 "type": "any" | 2408 "type": "any" |
2454 }, | 2409 }, |
2455 "type": "array" | 2410 "type": "array" |
2456 }, | 2411 }, |
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).", | 2412 "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).", |
2458 "type": "object" | 2413 "type": "object" |
2459 }, | 2414 }, |
(...skipping 10 matching lines...) Expand all Loading... |
2470 "enumDescriptions": [ | 2425 "enumDescriptions": [ |
2471 "", | 2426 "", |
2472 "", | 2427 "", |
2473 "", | 2428 "", |
2474 "", | 2429 "", |
2475 "", | 2430 "", |
2476 "" | 2431 "" |
2477 ], | 2432 ], |
2478 "type": "string" | 2433 "type": "string" |
2479 }, | 2434 }, |
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": { | 2435 "value": { |
2485 "description": "The value field for simple metadata", | 2436 "description": "The value field for simple metadata", |
2486 "type": "string" | 2437 "type": "string" |
2487 }, | 2438 }, |
2488 "id": { | 2439 "id": { |
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.", | 2440 "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.", |
2490 "type": "string" | 2441 "type": "string" |
2491 }, | 2442 }, |
| 2443 "number": { |
| 2444 "description": "The number of values that can be included in
a field described by this\nmetadata.", |
| 2445 "type": "string" |
| 2446 }, |
2492 "key": { | 2447 "key": { |
2493 "description": "The top-level key.", | 2448 "description": "The top-level key.", |
2494 "type": "string" | 2449 "type": "string" |
| 2450 }, |
| 2451 "description": { |
| 2452 "description": "A textual description of this metadata.", |
| 2453 "type": "string" |
2495 } | 2454 } |
2496 }, | 2455 }, |
2497 "type": "object" | 2456 "type": "object" |
2498 }, | 2457 }, |
2499 "SearchVariantSetsRequest": { | 2458 "Reference": { |
2500 "description": "The search variant sets request.", | 2459 "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)", |
2501 "id": "SearchVariantSetsRequest", | 2460 "id": "Reference", |
2502 "properties": { | 2461 "properties": { |
2503 "pageToken": { | 2462 "ncbiTaxonId": { |
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.", | 2463 "description": "ID from http://www.ncbi.nlm.nih.gov/taxonomy
. For example, 9606 for human.", |
2505 "type": "string" | |
2506 }, | |
2507 "pageSize": { | |
2508 "description": "The maximum number of results to return in a
single page. If unspecified,\ndefaults to 1024.", | |
2509 "format": "int32", | 2464 "format": "int32", |
2510 "type": "integer" | 2465 "type": "integer" |
2511 }, | 2466 }, |
2512 "datasetIds": { | 2467 "sourceUri": { |
2513 "description": "Exactly one dataset ID must be provided here
. Only variant sets which\nbelong to this dataset will be returned.", | 2468 "description": "The URI from which the sequence was obtained
. Typically specifies a FASTA\nformat file.", |
| 2469 "type": "string" |
| 2470 }, |
| 2471 "name": { |
| 2472 "description": "The name of this reference, for example `22`
.", |
| 2473 "type": "string" |
| 2474 }, |
| 2475 "md5checksum": { |
| 2476 "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.", |
| 2477 "type": "string" |
| 2478 }, |
| 2479 "id": { |
| 2480 "description": "The server-generated reference ID, unique ac
ross all references.", |
| 2481 "type": "string" |
| 2482 }, |
| 2483 "length": { |
| 2484 "description": "The length of this reference's sequence.", |
| 2485 "format": "int64", |
| 2486 "type": "string" |
| 2487 }, |
| 2488 "sourceAccessions": { |
| 2489 "description": "All known corresponding accession IDs in INS
DC (GenBank/ENA/DDBJ) ideally\nwith a version number, for example `GCF_000001405
.26`.", |
2514 "items": { | 2490 "items": { |
2515 "type": "string" | 2491 "type": "string" |
2516 }, | 2492 }, |
2517 "type": "array" | 2493 "type": "array" |
2518 } | 2494 } |
2519 }, | 2495 }, |
2520 "type": "object" | 2496 "type": "object" |
2521 }, | 2497 }, |
2522 "SearchReferenceSetsRequest": { | 2498 "SearchReferenceSetsRequest": { |
2523 "id": "SearchReferenceSetsRequest", | 2499 "id": "SearchReferenceSetsRequest", |
2524 "properties": { | 2500 "properties": { |
| 2501 "accessions": { |
| 2502 "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`.", |
| 2503 "items": { |
| 2504 "type": "string" |
| 2505 }, |
| 2506 "type": "array" |
| 2507 }, |
| 2508 "pageToken": { |
| 2509 "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.", |
| 2510 "type": "string" |
| 2511 }, |
2525 "pageSize": { | 2512 "pageSize": { |
2526 "description": "The maximum number of results to return in a
single page. If unspecified,\ndefaults to 1024. The maximum value is 4096.", | 2513 "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", | 2514 "format": "int32", |
2528 "type": "integer" | 2515 "type": "integer" |
2529 }, | 2516 }, |
2530 "assemblyId": { | 2517 "assemblyId": { |
2531 "description": "If present, return reference sets for which
a substring of their\n`assemblyId` matches this string (case insensitive).", | 2518 "description": "If present, return reference sets for which
a substring of their\n`assemblyId` matches this string (case insensitive).", |
2532 "type": "string" | 2519 "type": "string" |
2533 }, | 2520 }, |
2534 "md5checksums": { | 2521 "md5checksums": { |
2535 "description": "If present, return reference sets for which
the\nmd5checksum matches exactly.", | 2522 "description": "If present, return reference sets for which
the\nmd5checksum matches exactly.", |
2536 "items": { | 2523 "items": { |
2537 "type": "string" | 2524 "type": "string" |
2538 }, | 2525 }, |
2539 "type": "array" | 2526 "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 } | 2527 } |
2552 }, | 2528 }, |
2553 "type": "object" | 2529 "type": "object" |
2554 }, | 2530 }, |
2555 "SetIamPolicyRequest": { | 2531 "SetIamPolicyRequest": { |
2556 "description": "Request message for `SetIamPolicy` method.", | 2532 "description": "Request message for `SetIamPolicy` method.", |
2557 "id": "SetIamPolicyRequest", | 2533 "id": "SetIamPolicyRequest", |
2558 "properties": { | 2534 "properties": { |
2559 "policy": { | 2535 "policy": { |
2560 "$ref": "Policy", | 2536 "$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." | 2537 "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 } | 2538 } |
2563 }, | 2539 }, |
2564 "type": "object" | 2540 "type": "object" |
2565 }, | 2541 }, |
2566 "MergeVariantsRequest": { | 2542 "MergeVariantsRequest": { |
2567 "id": "MergeVariantsRequest", | 2543 "id": "MergeVariantsRequest", |
2568 "properties": { | 2544 "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": { | 2545 "variantSetId": { |
2582 "description": "The destination variant set.", | 2546 "description": "The destination variant set.", |
2583 "type": "string" | 2547 "type": "string" |
2584 }, | 2548 }, |
2585 "variants": { | 2549 "variants": { |
2586 "description": "The variants to be merged with existing vari
ants.", | 2550 "description": "The variants to be merged with existing vari
ants.", |
2587 "items": { | 2551 "items": { |
2588 "$ref": "Variant" | 2552 "$ref": "Variant" |
2589 }, | 2553 }, |
2590 "type": "array" | 2554 "type": "array" |
| 2555 }, |
| 2556 "infoMergeConfig": { |
| 2557 "additionalProperties": { |
| 2558 "enum": [ |
| 2559 "INFO_MERGE_OPERATION_UNSPECIFIED", |
| 2560 "IGNORE_NEW", |
| 2561 "MOVE_TO_CALLS" |
| 2562 ], |
| 2563 "type": "string" |
| 2564 }, |
| 2565 "description": "A mapping between info field keys and the In
foMergeOperations to\nbe performed on them.", |
| 2566 "type": "object" |
2591 } | 2567 } |
2592 }, | 2568 }, |
2593 "type": "object" | 2569 "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 }, | 2570 }, |
2612 "Read": { | 2571 "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", | 2572 "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", | 2573 "id": "Read", |
2615 "properties": { | 2574 "properties": { |
| 2575 "duplicateFragment": { |
| 2576 "description": "The fragment is a PCR or optical duplicate (
SAM flag 0x400).", |
| 2577 "type": "boolean" |
| 2578 }, |
| 2579 "readNumber": { |
| 2580 "description": "The read number in sequencing. 0-based and l
ess than numberReads. This\nfield replaces SAM flag 0x40 and 0x80.", |
| 2581 "format": "int32", |
| 2582 "type": "integer" |
| 2583 }, |
| 2584 "alignedSequence": { |
| 2585 "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.", |
| 2586 "type": "string" |
| 2587 }, |
| 2588 "readGroupId": { |
| 2589 "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).", |
| 2590 "type": "string" |
| 2591 }, |
2616 "nextMatePosition": { | 2592 "nextMatePosition": { |
2617 "$ref": "Position", | 2593 "$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." | 2594 "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." |
2619 }, | 2595 }, |
2620 "info": { | 2596 "info": { |
2621 "additionalProperties": { | 2597 "additionalProperties": { |
2622 "items": { | 2598 "items": { |
2623 "type": "any" | 2599 "type": "any" |
2624 }, | 2600 }, |
2625 "type": "array" | 2601 "type": "array" |
(...skipping 23 matching lines...) Expand all Loading... |
2649 "items": { | 2625 "items": { |
2650 "format": "int32", | 2626 "format": "int32", |
2651 "type": "integer" | 2627 "type": "integer" |
2652 }, | 2628 }, |
2653 "type": "array" | 2629 "type": "array" |
2654 }, | 2630 }, |
2655 "alignment": { | 2631 "alignment": { |
2656 "$ref": "LinearAlignment", | 2632 "$ref": "LinearAlignment", |
2657 "description": "The linear alignment for this alignment reco
rd. This field is null for\nunmapped reads." | 2633 "description": "The linear alignment for this alignment reco
rd. This field is null for\nunmapped reads." |
2658 }, | 2634 }, |
2659 "id": { | |
2660 "description": "The server-generated read ID, unique across
all reads. This is different\nfrom the `fragmentName`.", | |
2661 "type": "string" | |
2662 }, | |
2663 "numberReads": { | 2635 "numberReads": { |
2664 "description": "The number of reads in the fragment (extensi
on to SAM flag 0x1).", | 2636 "description": "The number of reads in the fragment (extensi
on to SAM flag 0x1).", |
2665 "format": "int32", | 2637 "format": "int32", |
2666 "type": "integer" | 2638 "type": "integer" |
2667 }, | 2639 }, |
| 2640 "id": { |
| 2641 "description": "The server-generated read ID, unique across
all reads. This is different\nfrom the `fragmentName`.", |
| 2642 "type": "string" |
| 2643 }, |
2668 "secondaryAlignment": { | 2644 "secondaryAlignment": { |
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.", | 2645 "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.", |
2670 "type": "boolean" | 2646 "type": "boolean" |
2671 }, | 2647 }, |
2672 "fragmentName": { | 2648 "fragmentName": { |
2673 "description": "The fragment name. Equivalent to QNAME (quer
y template name) in SAM.", | 2649 "description": "The fragment name. Equivalent to QNAME (quer
y template name) in SAM.", |
2674 "type": "string" | 2650 "type": "string" |
2675 }, | 2651 }, |
2676 "readGroupSetId": { | 2652 "readGroupSetId": { |
2677 "description": "The ID of the read group set this read belon
gs to. A read belongs to\nexactly one read group set.", | 2653 "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" | 2654 "type": "string" |
2679 }, | |
2680 "duplicateFragment": { | |
2681 "description": "The fragment is a PCR or optical duplicate (
SAM flag 0x400).", | |
2682 "type": "boolean" | |
2683 }, | |
2684 "readNumber": { | |
2685 "description": "The read number in sequencing. 0-based and l
ess than numberReads. This\nfield replaces SAM flag 0x40 and 0x80.", | |
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" | |
2692 }, | |
2693 "alignedSequence": { | |
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.", | |
2695 "type": "string" | |
2696 } | 2655 } |
2697 }, | 2656 }, |
2698 "type": "object" | 2657 "type": "object" |
2699 }, | 2658 }, |
2700 "ReferenceSet": { | 2659 "BatchCreateAnnotationsRequest": { |
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)", | 2660 "id": "BatchCreateAnnotationsRequest", |
2702 "id": "ReferenceSet", | |
2703 "properties": { | 2661 "properties": { |
2704 "referenceIds": { | 2662 "requestId": { |
2705 "description": "The IDs of the reference objects that are pa
rt of this set.\n`Reference.md5checksum` must be unique within this set.", | 2663 "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.", |
| 2664 "type": "string" |
| 2665 }, |
| 2666 "annotations": { |
| 2667 "description": "The annotations to be created. At most 4096
can be specified in a single\nrequest.", |
2706 "items": { | 2668 "items": { |
2707 "type": "string" | 2669 "$ref": "Annotation" |
2708 }, | 2670 }, |
2709 "type": "array" | 2671 "type": "array" |
2710 }, | |
2711 "assemblyId": { | |
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.", | |
2736 "format": "int32", | |
2737 "type": "integer" | |
2738 }, | |
2739 "sourceUri": { | |
2740 "description": "The URI from which the references were obtai
ned.", | |
2741 "type": "string" | |
2742 } | 2672 } |
2743 }, | 2673 }, |
2744 "type": "object" | 2674 "type": "object" |
2745 }, | 2675 }, |
2746 "CigarUnit": { | 2676 "CigarUnit": { |
2747 "description": "A single CIGAR operation.", | 2677 "description": "A single CIGAR operation.", |
2748 "id": "CigarUnit", | 2678 "id": "CigarUnit", |
2749 "properties": { | 2679 "properties": { |
2750 "referenceSequence": { | 2680 "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.", | 2681 "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.", |
(...skipping 27 matching lines...) Expand all Loading... |
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`.", | 2709 "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`.", |
2780 "The pad operator indicates that there is padding in an
alignment. This\noperator is equivalent to SAM's `P`.", | 2710 "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
`=`.", | 2711 "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`
." | 2712 "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 ], | 2713 ], |
2784 "type": "string" | 2714 "type": "string" |
2785 } | 2715 } |
2786 }, | 2716 }, |
2787 "type": "object" | 2717 "type": "object" |
2788 }, | 2718 }, |
| 2719 "ReferenceSet": { |
| 2720 "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)", |
| 2721 "id": "ReferenceSet", |
| 2722 "properties": { |
| 2723 "md5checksum": { |
| 2724 "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.", |
| 2725 "type": "string" |
| 2726 }, |
| 2727 "assemblyId": { |
| 2728 "description": "Public id of this reference set, such as `GR
Ch37`.", |
| 2729 "type": "string" |
| 2730 }, |
| 2731 "id": { |
| 2732 "description": "The server-generated reference set ID, uniqu
e across all reference sets.", |
| 2733 "type": "string" |
| 2734 }, |
| 2735 "description": { |
| 2736 "description": "Free text description of this reference set.
", |
| 2737 "type": "string" |
| 2738 }, |
| 2739 "sourceAccessions": { |
| 2740 "description": "All known corresponding accession IDs in INS
DC (GenBank/ENA/DDBJ) ideally\nwith a version number, for example `NC_000001.11`
.", |
| 2741 "items": { |
| 2742 "type": "string" |
| 2743 }, |
| 2744 "type": "array" |
| 2745 }, |
| 2746 "sourceUri": { |
| 2747 "description": "The URI from which the references were obtai
ned.", |
| 2748 "type": "string" |
| 2749 }, |
| 2750 "ncbiTaxonId": { |
| 2751 "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.", |
| 2752 "format": "int32", |
| 2753 "type": "integer" |
| 2754 }, |
| 2755 "referenceIds": { |
| 2756 "description": "The IDs of the reference objects that are pa
rt of this set.\n`Reference.md5checksum` must be unique within this set.", |
| 2757 "items": { |
| 2758 "type": "string" |
| 2759 }, |
| 2760 "type": "array" |
| 2761 } |
| 2762 }, |
| 2763 "type": "object" |
| 2764 }, |
2789 "Transcript": { | 2765 "Transcript": { |
2790 "description": "A transcript represents the assertion that a particu
lar region of the\nreference genome may be transcribed as RNA.", | 2766 "description": "A transcript represents the assertion that a particu
lar region of the\nreference genome may be transcribed as RNA.", |
2791 "id": "Transcript", | 2767 "id": "Transcript", |
2792 "properties": { | 2768 "properties": { |
| 2769 "geneId": { |
| 2770 "description": "The annotation ID of the gene from which thi
s transcript is transcribed.", |
| 2771 "type": "string" |
| 2772 }, |
2793 "exons": { | 2773 "exons": { |
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.", | 2774 "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": { | 2775 "items": { |
2796 "$ref": "Exon" | 2776 "$ref": "Exon" |
2797 }, | 2777 }, |
2798 "type": "array" | 2778 "type": "array" |
2799 }, | 2779 }, |
2800 "codingSequence": { | 2780 "codingSequence": { |
2801 "$ref": "CodingSequence", | 2781 "$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." | 2782 "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.", | |
2806 "type": "string" | |
2807 } | 2783 } |
2808 }, | 2784 }, |
2809 "type": "object" | 2785 "type": "object" |
2810 }, | 2786 }, |
2811 "AnnotationSet": { | 2787 "AnnotationSet": { |
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'.", | 2788 "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", | 2789 "id": "AnnotationSet", |
2814 "properties": { | 2790 "properties": { |
| 2791 "sourceUri": { |
| 2792 "description": "The source URI describing the file from whic
h this annotation set was\ngenerated, if any.", |
| 2793 "type": "string" |
| 2794 }, |
2815 "datasetId": { | 2795 "datasetId": { |
2816 "description": "The dataset to which this annotation set bel
ongs.", | 2796 "description": "The dataset to which this annotation set bel
ongs.", |
2817 "type": "string" | 2797 "type": "string" |
2818 }, | 2798 }, |
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": { | 2799 "name": { |
2824 "description": "The display name for this annotation set.", | 2800 "description": "The display name for this annotation set.", |
2825 "type": "string" | 2801 "type": "string" |
2826 }, | 2802 }, |
2827 "referenceSetId": { | 2803 "referenceSetId": { |
2828 "description": "The ID of the reference set that defines the
coordinate space for this\nset's annotations.", | 2804 "description": "The ID of the reference set that defines the
coordinate space for this\nset's annotations.", |
2829 "type": "string" | 2805 "type": "string" |
2830 }, | 2806 }, |
| 2807 "info": { |
| 2808 "additionalProperties": { |
| 2809 "items": { |
| 2810 "type": "any" |
| 2811 }, |
| 2812 "type": "array" |
| 2813 }, |
| 2814 "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).", |
| 2815 "type": "object" |
| 2816 }, |
2831 "type": { | 2817 "type": { |
2832 "description": "The type of annotations contained within thi
s set.", | 2818 "description": "The type of annotations contained within thi
s set.", |
2833 "enum": [ | 2819 "enum": [ |
2834 "ANNOTATION_TYPE_UNSPECIFIED", | 2820 "ANNOTATION_TYPE_UNSPECIFIED", |
2835 "GENERIC", | 2821 "GENERIC", |
2836 "VARIANT", | 2822 "VARIANT", |
2837 "GENE", | 2823 "GENE", |
2838 "TRANSCRIPT" | 2824 "TRANSCRIPT" |
2839 ], | 2825 ], |
2840 "enumDescriptions": [ | 2826 "enumDescriptions": [ |
2841 "", | 2827 "", |
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.", | 2828 "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.", | 2829 "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.", | 2830 "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." | 2831 "A `TRANSCRIPT` annotation type represents the assertion
that a\nparticular region of the reference genome may be transcribed as RNA." |
2846 ], | 2832 ], |
2847 "type": "string" | 2833 "type": "string" |
2848 }, | 2834 }, |
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": { | 2835 "id": { |
2860 "description": "The server-generated annotation set ID, uniq
ue across all annotation sets.", | 2836 "description": "The server-generated annotation set ID, uniq
ue across all annotation sets.", |
2861 "type": "string" | 2837 "type": "string" |
2862 } | 2838 } |
2863 }, | 2839 }, |
2864 "type": "object" | 2840 "type": "object" |
2865 }, | 2841 }, |
2866 "Experiment": { | 2842 "Experiment": { |
2867 "id": "Experiment", | 2843 "id": "Experiment", |
2868 "properties": { | 2844 "properties": { |
(...skipping 41 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2910 "permissions": { | 2886 "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`", | 2887 "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": { | 2888 "items": { |
2913 "type": "string" | 2889 "type": "string" |
2914 }, | 2890 }, |
2915 "type": "array" | 2891 "type": "array" |
2916 } | 2892 } |
2917 }, | 2893 }, |
2918 "type": "object" | 2894 "type": "object" |
2919 }, | 2895 }, |
2920 "ExportReadGroupSetRequest": { | |
2921 "description": "The read group set export request.", | |
2922 "id": "ExportReadGroupSetRequest", | |
2923 "properties": { | |
2924 "projectId": { | |
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.", | |
2934 "items": { | |
2935 "type": "string" | |
2936 }, | |
2937 "type": "array" | |
2938 } | |
2939 }, | |
2940 "type": "object" | |
2941 }, | |
2942 "Exon": { | 2896 "Exon": { |
2943 "id": "Exon", | 2897 "id": "Exon", |
2944 "properties": { | 2898 "properties": { |
2945 "start": { | 2899 "start": { |
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.", | 2900 "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.", |
2947 "format": "int64", | 2901 "format": "int64", |
2948 "type": "string" | 2902 "type": "string" |
2949 }, | 2903 }, |
2950 "end": { | 2904 "end": { |
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.", | 2905 "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", | 2906 "format": "int64", |
2953 "type": "string" | 2907 "type": "string" |
2954 }, | 2908 }, |
2955 "frame": { | 2909 "frame": { |
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.", | 2910 "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.", |
2957 "format": "int32", | 2911 "format": "int32", |
2958 "type": "integer" | 2912 "type": "integer" |
2959 } | 2913 } |
2960 }, | 2914 }, |
2961 "type": "object" | 2915 "type": "object" |
2962 }, | 2916 }, |
| 2917 "ExportReadGroupSetRequest": { |
| 2918 "description": "The read group set export request.", |
| 2919 "id": "ExportReadGroupSetRequest", |
| 2920 "properties": { |
| 2921 "exportUri": { |
| 2922 "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.", |
| 2923 "type": "string" |
| 2924 }, |
| 2925 "referenceNames": { |
| 2926 "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.", |
| 2927 "items": { |
| 2928 "type": "string" |
| 2929 }, |
| 2930 "type": "array" |
| 2931 }, |
| 2932 "projectId": { |
| 2933 "description": "Required. The Google Cloud project ID that o
wns this\nexport. The caller must have WRITE access to this project.", |
| 2934 "type": "string" |
| 2935 } |
| 2936 }, |
| 2937 "type": "object" |
| 2938 }, |
2963 "CallSet": { | 2939 "CallSet": { |
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)", | 2940 "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", | 2941 "id": "CallSet", |
2966 "properties": { | 2942 "properties": { |
| 2943 "name": { |
| 2944 "description": "The call set name.", |
| 2945 "type": "string" |
| 2946 }, |
2967 "info": { | 2947 "info": { |
2968 "additionalProperties": { | 2948 "additionalProperties": { |
2969 "items": { | 2949 "items": { |
2970 "type": "any" | 2950 "type": "any" |
2971 }, | 2951 }, |
2972 "type": "array" | 2952 "type": "array" |
2973 }, | 2953 }, |
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).", | 2954 "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" | 2955 "type": "object" |
2976 }, | 2956 }, |
2977 "variantSetIds": { | 2957 "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).", | 2958 "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).", |
2979 "items": { | 2959 "items": { |
2980 "type": "string" | 2960 "type": "string" |
2981 }, | 2961 }, |
2982 "type": "array" | 2962 "type": "array" |
2983 }, | 2963 }, |
2984 "id": { | 2964 "id": { |
2985 "description": "The server-generated call set ID, unique acr
oss all call sets.", | 2965 "description": "The server-generated call set ID, unique acr
oss all call sets.", |
2986 "type": "string" | 2966 "type": "string" |
2987 }, | 2967 }, |
2988 "created": { | 2968 "created": { |
2989 "description": "The date this call set was created in millis
econds from the epoch.", | 2969 "description": "The date this call set was created in millis
econds from the epoch.", |
2990 "format": "int64", | 2970 "format": "int64", |
2991 "type": "string" | 2971 "type": "string" |
2992 }, | 2972 }, |
2993 "sampleId": { | 2973 "sampleId": { |
2994 "description": "The sample ID this call set corresponds to."
, | 2974 "description": "The sample ID this call set corresponds to."
, |
2995 "type": "string" | 2975 "type": "string" |
2996 }, | |
2997 "name": { | |
2998 "description": "The call set name.", | |
2999 "type": "string" | |
3000 } | 2976 } |
3001 }, | 2977 }, |
3002 "type": "object" | 2978 "type": "object" |
3003 }, | 2979 }, |
3004 "SearchAnnotationSetsResponse": { | 2980 "SearchAnnotationSetsResponse": { |
3005 "id": "SearchAnnotationSetsResponse", | 2981 "id": "SearchAnnotationSetsResponse", |
3006 "properties": { | 2982 "properties": { |
3007 "nextPageToken": { | 2983 "nextPageToken": { |
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.", | 2984 "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.", |
3009 "type": "string" | 2985 "type": "string" |
(...skipping 49 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
3059 "enumDescriptions": [ | 3035 "enumDescriptions": [ |
3060 "", | 3036 "", |
3061 "VCF (Variant Call Format). The VCF files may be gzip co
mpressed. gVCF is\nalso supported.", | 3037 "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." | 3038 "Complete Genomics masterVarBeta format. The masterVarBe
ta files may\nbe bzip2 compressed." |
3063 ], | 3039 ], |
3064 "type": "string" | 3040 "type": "string" |
3065 } | 3041 } |
3066 }, | 3042 }, |
3067 "type": "object" | 3043 "type": "object" |
3068 }, | 3044 }, |
| 3045 "ListCoverageBucketsResponse": { |
| 3046 "id": "ListCoverageBucketsResponse", |
| 3047 "properties": { |
| 3048 "nextPageToken": { |
| 3049 "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.", |
| 3050 "type": "string" |
| 3051 }, |
| 3052 "bucketWidth": { |
| 3053 "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`).", |
| 3054 "format": "int64", |
| 3055 "type": "string" |
| 3056 }, |
| 3057 "coverageBuckets": { |
| 3058 "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.", |
| 3059 "items": { |
| 3060 "$ref": "CoverageBucket" |
| 3061 }, |
| 3062 "type": "array" |
| 3063 } |
| 3064 }, |
| 3065 "type": "object" |
| 3066 }, |
3069 "VariantAnnotation": { | 3067 "VariantAnnotation": { |
3070 "id": "VariantAnnotation", | 3068 "id": "VariantAnnotation", |
3071 "properties": { | 3069 "properties": { |
3072 "conditions": { | 3070 "conditions": { |
3073 "description": "The set of conditions associated with this v
ariant.\nA condition describes the way a variant influences human health.", | 3071 "description": "The set of conditions associated with this v
ariant.\nA condition describes the way a variant influences human health.", |
3074 "items": { | 3072 "items": { |
3075 "$ref": "ClinicalCondition" | 3073 "$ref": "ClinicalCondition" |
3076 }, | 3074 }, |
3077 "type": "array" | 3075 "type": "array" |
3078 }, | 3076 }, |
(...skipping 94 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
3173 "", | 3171 "", |
3174 "", | 3172 "", |
3175 "", | 3173 "", |
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." | 3174 "`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 ], | 3175 ], |
3178 "type": "string" | 3176 "type": "string" |
3179 } | 3177 } |
3180 }, | 3178 }, |
3181 "type": "object" | 3179 "type": "object" |
3182 }, | 3180 }, |
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`).", | |
3199 "format": "int64", | |
3200 "type": "string" | |
3201 } | |
3202 }, | |
3203 "type": "object" | |
3204 }, | |
3205 "ExportVariantSetRequest": { | 3181 "ExportVariantSetRequest": { |
3206 "description": "The variant data export request.", | 3182 "description": "The variant data export request.", |
3207 "id": "ExportVariantSetRequest", | 3183 "id": "ExportVariantSetRequest", |
3208 "properties": { | 3184 "properties": { |
3209 "format": { | 3185 "format": { |
3210 "description": "The format for the exported data.", | 3186 "description": "The format for the exported data.", |
3211 "enum": [ | 3187 "enum": [ |
3212 "FORMAT_UNSPECIFIED", | 3188 "FORMAT_UNSPECIFIED", |
3213 "FORMAT_BIGQUERY" | 3189 "FORMAT_BIGQUERY" |
3214 ], | 3190 ], |
(...skipping 21 matching lines...) Expand all Loading... |
3236 "projectId": { | 3212 "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.", | 3213 "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" | 3214 "type": "string" |
3239 } | 3215 } |
3240 }, | 3216 }, |
3241 "type": "object" | 3217 "type": "object" |
3242 }, | 3218 }, |
3243 "SearchAnnotationsRequest": { | 3219 "SearchAnnotationsRequest": { |
3244 "id": "SearchAnnotationsRequest", | 3220 "id": "SearchAnnotationsRequest", |
3245 "properties": { | 3221 "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": { | 3222 "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.", | 3223 "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" | 3224 "type": "string" |
3254 }, | 3225 }, |
3255 "pageSize": { | 3226 "pageSize": { |
3256 "description": "The maximum number of results to return in a
single page. If unspecified,\ndefaults to 256. The maximum value is 2048.", | 3227 "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", | 3228 "format": "int32", |
3258 "type": "integer" | 3229 "type": "integer" |
3259 }, | 3230 }, |
3260 "start": { | 3231 "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.", | 3232 "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", | 3233 "format": "int64", |
3263 "type": "string" | 3234 "type": "string" |
3264 }, | 3235 }, |
3265 "annotationSetIds": { | 3236 "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.", | 3237 "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": { | 3238 "items": { |
3268 "type": "string" | 3239 "type": "string" |
3269 }, | 3240 }, |
3270 "type": "array" | 3241 "type": "array" |
3271 }, | 3242 }, |
3272 "referenceName": { | 3243 "referenceName": { |
3273 "description": "The name of the reference to query, within t
he reference set associated\nwith this query.", | 3244 "description": "The name of the reference to query, within t
he reference set associated\nwith this query.", |
3274 "type": "string" | 3245 "type": "string" |
3275 }, | 3246 }, |
3276 "referenceId": { | 3247 "referenceId": { |
3277 "description": "The ID of the reference to query.", | 3248 "description": "The ID of the reference to query.", |
3278 "type": "string" | 3249 "type": "string" |
| 3250 }, |
| 3251 "end": { |
| 3252 "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.", |
| 3253 "format": "int64", |
| 3254 "type": "string" |
3279 } | 3255 } |
3280 }, | 3256 }, |
3281 "type": "object" | 3257 "type": "object" |
3282 }, | 3258 }, |
3283 "OperationEvent": { | 3259 "OperationEvent": { |
3284 "description": "An event that occurred during an Operation.", | 3260 "description": "An event that occurred during an Operation.", |
3285 "id": "OperationEvent", | 3261 "id": "OperationEvent", |
3286 "properties": { | 3262 "properties": { |
3287 "endTime": { | 3263 "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.", | 3264 "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", | 3265 "format": "google-datetime", |
3290 "type": "string" | 3266 "type": "string" |
3291 }, | 3267 }, |
3292 "startTime": { | 3268 "startTime": { |
3293 "description": "Optional time of when event started.", | 3269 "description": "Optional time of when event started.", |
3294 "format": "google-datetime", | 3270 "format": "google-datetime", |
3295 "type": "string" | 3271 "type": "string" |
3296 }, | 3272 }, |
3297 "description": { | 3273 "description": { |
3298 "description": "Required description of event.", | 3274 "description": "Required description of event.", |
3299 "type": "string" | 3275 "type": "string" |
3300 } | 3276 } |
3301 }, | 3277 }, |
3302 "type": "object" | 3278 "type": "object" |
3303 }, | 3279 }, |
3304 "CodingSequence": { | 3280 "CodingSequence": { |
3305 "id": "CodingSequence", | 3281 "id": "CodingSequence", |
3306 "properties": { | 3282 "properties": { |
3307 "end": { | 3283 "start": { |
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.", | 3284 "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.", |
3309 "format": "int64", | 3285 "format": "int64", |
3310 "type": "string" | 3286 "type": "string" |
3311 }, | 3287 }, |
3312 "start": { | 3288 "end": { |
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.", | 3289 "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.", |
3314 "format": "int64", | 3290 "format": "int64", |
3315 "type": "string" | 3291 "type": "string" |
3316 } | 3292 } |
3317 }, | 3293 }, |
3318 "type": "object" | 3294 "type": "object" |
3319 }, | 3295 }, |
3320 "SearchReferencesResponse": { | 3296 "TestIamPermissionsResponse": { |
3321 "id": "SearchReferencesResponse", | 3297 "description": "Response message for `TestIamPermissions` method.", |
| 3298 "id": "TestIamPermissionsResponse", |
3322 "properties": { | 3299 "properties": { |
3323 "references": { | 3300 "permissions": { |
3324 "description": "The matching references.", | 3301 "description": "A subset of `TestPermissionsRequest.permissi
ons` that the caller is\nallowed.", |
3325 "items": { | 3302 "items": { |
3326 "$ref": "Reference" | 3303 "type": "string" |
3327 }, | 3304 }, |
3328 "type": "array" | 3305 "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 } | 3306 } |
3334 }, | 3307 }, |
3335 "type": "object" | 3308 "type": "object" |
3336 }, | 3309 }, |
3337 "GetIamPolicyRequest": { | 3310 "GetIamPolicyRequest": { |
3338 "description": "Request message for `GetIamPolicy` method.", | 3311 "description": "Request message for `GetIamPolicy` method.", |
3339 "id": "GetIamPolicyRequest", | 3312 "id": "GetIamPolicyRequest", |
3340 "properties": {}, | 3313 "properties": {}, |
3341 "type": "object" | 3314 "type": "object" |
3342 }, | 3315 }, |
3343 "TestIamPermissionsResponse": { | 3316 "SearchReferencesResponse": { |
3344 "description": "Response message for `TestIamPermissions` method.", | 3317 "id": "SearchReferencesResponse", |
3345 "id": "TestIamPermissionsResponse", | |
3346 "properties": { | 3318 "properties": { |
3347 "permissions": { | 3319 "references": { |
3348 "description": "A subset of `TestPermissionsRequest.permissi
ons` that the caller is\nallowed.", | 3320 "description": "The matching references.", |
3349 "items": { | 3321 "items": { |
3350 "type": "string" | 3322 "$ref": "Reference" |
3351 }, | 3323 }, |
3352 "type": "array" | 3324 "type": "array" |
| 3325 }, |
| 3326 "nextPageToken": { |
| 3327 "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.", |
| 3328 "type": "string" |
3353 } | 3329 } |
3354 }, | 3330 }, |
3355 "type": "object" | 3331 "type": "object" |
3356 }, | 3332 }, |
3357 "SearchAnnotationSetsRequest": { | 3333 "SearchAnnotationSetsRequest": { |
3358 "id": "SearchAnnotationSetsRequest", | 3334 "id": "SearchAnnotationSetsRequest", |
3359 "properties": { | 3335 "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 }, | |
3369 "datasetIds": { | 3336 "datasetIds": { |
3370 "description": "Required. The dataset IDs to search within.
Caller must have `READ` access\nto these datasets.", | 3337 "description": "Required. The dataset IDs to search within.
Caller must have `READ` access\nto these datasets.", |
3371 "items": { | 3338 "items": { |
3372 "type": "string" | 3339 "type": "string" |
3373 }, | 3340 }, |
3374 "type": "array" | 3341 "type": "array" |
3375 }, | 3342 }, |
3376 "types": { | 3343 "types": { |
3377 "description": "If specified, only annotation sets that have
any of these types are\nreturned.", | 3344 "description": "If specified, only annotation sets that have
any of these types are\nreturned.", |
3378 "enumDescriptions": [ | 3345 "enumDescriptions": [ |
(...skipping 15 matching lines...) Expand all Loading... |
3394 }, | 3361 }, |
3395 "type": "array" | 3362 "type": "array" |
3396 }, | 3363 }, |
3397 "name": { | 3364 "name": { |
3398 "description": "Only return annotations sets for which a sub
string of the name matches this\nstring (case insensitive).", | 3365 "description": "Only return annotations sets for which a sub
string of the name matches this\nstring (case insensitive).", |
3399 "type": "string" | 3366 "type": "string" |
3400 }, | 3367 }, |
3401 "referenceSetId": { | 3368 "referenceSetId": { |
3402 "description": "If specified, only annotation sets associate
d with the given reference set\nare returned.", | 3369 "description": "If specified, only annotation sets associate
d with the given reference set\nare returned.", |
3403 "type": "string" | 3370 "type": "string" |
| 3371 }, |
| 3372 "pageToken": { |
| 3373 "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.", |
| 3374 "type": "string" |
| 3375 }, |
| 3376 "pageSize": { |
| 3377 "description": "The maximum number of results to return in a
single page. If unspecified,\ndefaults to 128. The maximum value is 1024.", |
| 3378 "format": "int32", |
| 3379 "type": "integer" |
3404 } | 3380 } |
3405 }, | 3381 }, |
3406 "type": "object" | 3382 "type": "object" |
3407 }, | 3383 }, |
3408 "SearchReadGroupSetsResponse": { | 3384 "SearchReadGroupSetsResponse": { |
3409 "description": "The read group set search response.", | 3385 "description": "The read group set search response.", |
3410 "id": "SearchReadGroupSetsResponse", | 3386 "id": "SearchReadGroupSetsResponse", |
3411 "properties": { | 3387 "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": { | 3388 "readGroupSets": { |
3417 "description": "The list of matching read group sets.", | 3389 "description": "The list of matching read group sets.", |
3418 "items": { | 3390 "items": { |
3419 "$ref": "ReadGroupSet" | 3391 "$ref": "ReadGroupSet" |
3420 }, | 3392 }, |
3421 "type": "array" | 3393 "type": "array" |
| 3394 }, |
| 3395 "nextPageToken": { |
| 3396 "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.", |
| 3397 "type": "string" |
3422 } | 3398 } |
3423 }, | 3399 }, |
3424 "type": "object" | 3400 "type": "object" |
3425 }, | 3401 }, |
3426 "LinearAlignment": { | 3402 "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.", | 3403 "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", | 3404 "id": "LinearAlignment", |
3429 "properties": { | 3405 "properties": { |
3430 "mappingQuality": { | 3406 "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.", | 3407 "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.", |
(...skipping 44 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
3476 "format": "int32", | 3452 "format": "int32", |
3477 "type": "integer" | 3453 "type": "integer" |
3478 } | 3454 } |
3479 }, | 3455 }, |
3480 "type": "object" | 3456 "type": "object" |
3481 }, | 3457 }, |
3482 "Dataset": { | 3458 "Dataset": { |
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)", | 3459 "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)", |
3484 "id": "Dataset", | 3460 "id": "Dataset", |
3485 "properties": { | 3461 "properties": { |
| 3462 "name": { |
| 3463 "description": "The dataset name.", |
| 3464 "type": "string" |
| 3465 }, |
3486 "projectId": { | 3466 "projectId": { |
3487 "description": "The Google Cloud project ID that this datase
t belongs to.", | 3467 "description": "The Google Cloud project ID that this datase
t belongs to.", |
3488 "type": "string" | 3468 "type": "string" |
3489 }, | 3469 }, |
3490 "id": { | 3470 "id": { |
3491 "description": "The server-generated dataset ID, unique acro
ss all datasets.", | 3471 "description": "The server-generated dataset ID, unique acro
ss all datasets.", |
3492 "type": "string" | 3472 "type": "string" |
3493 }, | 3473 }, |
3494 "createTime": { | 3474 "createTime": { |
3495 "description": "The time this dataset was created, in second
s from the epoch.", | 3475 "description": "The time this dataset was created, in second
s from the epoch.", |
3496 "format": "google-datetime", | 3476 "format": "google-datetime", |
3497 "type": "string" | 3477 "type": "string" |
3498 }, | |
3499 "name": { | |
3500 "description": "The dataset name.", | |
3501 "type": "string" | |
3502 } | 3478 } |
3503 }, | 3479 }, |
3504 "type": "object" | 3480 "type": "object" |
3505 }, | 3481 }, |
3506 "ImportVariantsResponse": { | 3482 "ImportVariantsResponse": { |
3507 "description": "The variant data import response.", | 3483 "description": "The variant data import response.", |
3508 "id": "ImportVariantsResponse", | 3484 "id": "ImportVariantsResponse", |
3509 "properties": { | 3485 "properties": { |
3510 "callSetIds": { | 3486 "callSetIds": { |
3511 "description": "IDs of the call sets created during the impo
rt.", | 3487 "description": "IDs of the call sets created during the impo
rt.", |
(...skipping 59 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
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.", | 3547 "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.", |
3572 "type": "string" | 3548 "type": "string" |
3573 } | 3549 } |
3574 }, | 3550 }, |
3575 "type": "object" | 3551 "type": "object" |
3576 }, | 3552 }, |
3577 "ReadGroupSet": { | 3553 "ReadGroupSet": { |
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)", | 3554 "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", | 3555 "id": "ReadGroupSet", |
3580 "properties": { | 3556 "properties": { |
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": { | 3557 "readGroups": { |
3590 "description": "The read groups in this set. There are typic
ally 1-10 read groups in a read\ngroup set.", | 3558 "description": "The read groups in this set. There are typic
ally 1-10 read groups in a read\ngroup set.", |
3591 "items": { | 3559 "items": { |
3592 "$ref": "ReadGroup" | 3560 "$ref": "ReadGroup" |
3593 }, | 3561 }, |
3594 "type": "array" | 3562 "type": "array" |
3595 }, | 3563 }, |
| 3564 "filename": { |
| 3565 "description": "The filename of the original source file for
this read group set, if any.", |
| 3566 "type": "string" |
| 3567 }, |
3596 "name": { | 3568 "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
.", | 3569 "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" | 3570 "type": "string" |
3599 }, | 3571 }, |
3600 "referenceSetId": { | 3572 "referenceSetId": { |
3601 "description": "The reference set to which the reads in this
read group set are aligned.", | 3573 "description": "The reference set to which the reads in this
read group set are aligned.", |
3602 "type": "string" | 3574 "type": "string" |
3603 }, | 3575 }, |
3604 "info": { | 3576 "info": { |
3605 "additionalProperties": { | 3577 "additionalProperties": { |
3606 "items": { | 3578 "items": { |
3607 "type": "any" | 3579 "type": "any" |
3608 }, | 3580 }, |
3609 "type": "array" | 3581 "type": "array" |
3610 }, | 3582 }, |
3611 "description": "A map of additional read group set informati
on.", | 3583 "description": "A map of additional read group set informati
on.", |
3612 "type": "object" | 3584 "type": "object" |
3613 }, | 3585 }, |
3614 "id": { | 3586 "id": { |
3615 "description": "The server-generated read group set ID, uniq
ue for all read group sets.", | 3587 "description": "The server-generated read group set ID, uniq
ue for all read group sets.", |
3616 "type": "string" | 3588 "type": "string" |
| 3589 }, |
| 3590 "datasetId": { |
| 3591 "description": "The dataset to which this read group set bel
ongs.", |
| 3592 "type": "string" |
3617 } | 3593 } |
3618 }, | 3594 }, |
3619 "type": "object" | 3595 "type": "object" |
3620 }, | 3596 }, |
3621 "SearchVariantSetsResponse": { | 3597 "SearchVariantSetsResponse": { |
3622 "description": "The search variant sets response.", | 3598 "description": "The search variant sets response.", |
3623 "id": "SearchVariantSetsResponse", | 3599 "id": "SearchVariantSetsResponse", |
3624 "properties": { | 3600 "properties": { |
| 3601 "nextPageToken": { |
| 3602 "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.", |
| 3603 "type": "string" |
| 3604 }, |
3625 "variantSets": { | 3605 "variantSets": { |
3626 "description": "The variant sets belonging to the requested
dataset.", | 3606 "description": "The variant sets belonging to the requested
dataset.", |
3627 "items": { | 3607 "items": { |
3628 "$ref": "VariantSet" | 3608 "$ref": "VariantSet" |
3629 }, | 3609 }, |
3630 "type": "array" | 3610 "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 } | 3611 } |
3636 }, | 3612 }, |
3637 "type": "object" | 3613 "type": "object" |
3638 }, | 3614 }, |
3639 "Empty": { | 3615 "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 `{}`.", | 3616 "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", | 3617 "id": "Empty", |
3642 "properties": {}, | 3618 "properties": {}, |
3643 "type": "object" | 3619 "type": "object" |
3644 }, | 3620 }, |
(...skipping 27 matching lines...) Expand all Loading... |
3672 "reverseStrand": { | 3648 "reverseStrand": { |
3673 "description": "Whether this position is on the reverse stra
nd, as opposed to the forward\nstrand.", | 3649 "description": "Whether this position is on the reverse stra
nd, as opposed to the forward\nstrand.", |
3674 "type": "boolean" | 3650 "type": "boolean" |
3675 } | 3651 } |
3676 }, | 3652 }, |
3677 "type": "object" | 3653 "type": "object" |
3678 }, | 3654 }, |
3679 "SearchReferenceSetsResponse": { | 3655 "SearchReferenceSetsResponse": { |
3680 "id": "SearchReferenceSetsResponse", | 3656 "id": "SearchReferenceSetsResponse", |
3681 "properties": { | 3657 "properties": { |
| 3658 "nextPageToken": { |
| 3659 "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.", |
| 3660 "type": "string" |
| 3661 }, |
3682 "referenceSets": { | 3662 "referenceSets": { |
3683 "description": "The matching references sets.", | 3663 "description": "The matching references sets.", |
3684 "items": { | 3664 "items": { |
3685 "$ref": "ReferenceSet" | 3665 "$ref": "ReferenceSet" |
3686 }, | 3666 }, |
3687 "type": "array" | 3667 "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 } | 3668 } |
3693 }, | 3669 }, |
3694 "type": "object" | 3670 "type": "object" |
3695 }, | 3671 }, |
3696 "SearchCallSetsRequest": { | 3672 "SearchCallSetsRequest": { |
3697 "description": "The call set search request.", | 3673 "description": "The call set search request.", |
3698 "id": "SearchCallSetsRequest", | 3674 "id": "SearchCallSetsRequest", |
3699 "properties": { | 3675 "properties": { |
3700 "name": { | 3676 "name": { |
3701 "description": "Only return call sets for which a substring
of the name matches this\nstring.", | 3677 "description": "Only return call sets for which a substring
of the name matches this\nstring.", |
(...skipping 15 matching lines...) Expand all Loading... |
3717 }, | 3693 }, |
3718 "type": "array" | 3694 "type": "array" |
3719 } | 3695 } |
3720 }, | 3696 }, |
3721 "type": "object" | 3697 "type": "object" |
3722 }, | 3698 }, |
3723 "ImportReadGroupSetsRequest": { | 3699 "ImportReadGroupSetsRequest": { |
3724 "description": "The read group set import request.", | 3700 "description": "The read group set import request.", |
3725 "id": "ImportReadGroupSetsRequest", | 3701 "id": "ImportReadGroupSetsRequest", |
3726 "properties": { | 3702 "properties": { |
| 3703 "sourceUris": { |
| 3704 "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.", |
| 3705 "items": { |
| 3706 "type": "string" |
| 3707 }, |
| 3708 "type": "array" |
| 3709 }, |
3727 "referenceSetId": { | 3710 "referenceSetId": { |
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.", | 3711 "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" | 3712 "type": "string" |
3730 }, | 3713 }, |
3731 "partitionStrategy": { | 3714 "partitionStrategy": { |
3732 "description": "The partition strategy describes how read gr
oups are partitioned into read\ngroup sets.", | 3715 "description": "The partition strategy describes how read gr
oups are partitioned into read\ngroup sets.", |
3733 "enum": [ | 3716 "enum": [ |
3734 "PARTITION_STRATEGY_UNSPECIFIED", | 3717 "PARTITION_STRATEGY_UNSPECIFIED", |
3735 "PER_FILE_PER_SAMPLE", | 3718 "PER_FILE_PER_SAMPLE", |
3736 "MERGE_ALL" | 3719 "MERGE_ALL" |
3737 ], | 3720 ], |
3738 "enumDescriptions": [ | 3721 "enumDescriptions": [ |
3739 "", | 3722 "", |
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.", | 3723 "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." | 3724 "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 ], | 3725 ], |
3743 "type": "string" | 3726 "type": "string" |
3744 }, | 3727 }, |
3745 "datasetId": { | 3728 "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.", | 3729 "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" | 3730 "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.", | |
3751 "items": { | |
3752 "type": "string" | |
3753 }, | |
3754 "type": "array" | |
3755 } | 3731 } |
3756 }, | 3732 }, |
3757 "type": "object" | 3733 "type": "object" |
| 3734 }, |
| 3735 "Policy": { |
| 3736 "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).", |
| 3737 "id": "Policy", |
| 3738 "properties": { |
| 3739 "bindings": { |
| 3740 "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.", |
| 3741 "items": { |
| 3742 "$ref": "Binding" |
| 3743 }, |
| 3744 "type": "array" |
| 3745 }, |
| 3746 "etag": { |
| 3747 "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.", |
| 3748 "format": "byte", |
| 3749 "type": "string" |
| 3750 }, |
| 3751 "version": { |
| 3752 "description": "Version of the `Policy`. The default version
is 0.", |
| 3753 "format": "int32", |
| 3754 "type": "integer" |
| 3755 } |
| 3756 }, |
| 3757 "type": "object" |
3758 } | 3758 } |
3759 }, | 3759 }, |
3760 "servicePath": "", | 3760 "servicePath": "", |
3761 "title": "Genomics API", | 3761 "title": "Genomics API", |
3762 "version": "v1" | 3762 "version": "v1" |
3763 } | 3763 } |
OLD | NEW |