1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="genomics_v1.html">Genomics API</a> . <a href="genomics_v1.callsets.html">callsets</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#create">create(body, x__xgafv=None)</a></code></p> 79<p class="firstline">Creates a new call set.</p> 80<p class="toc_element"> 81 <code><a href="#delete">delete(callSetId, x__xgafv=None)</a></code></p> 82<p class="firstline">Deletes a call set.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(callSetId, x__xgafv=None)</a></code></p> 85<p class="firstline">Gets a call set by ID.</p> 86<p class="toc_element"> 87 <code><a href="#patch">patch(callSetId, body, updateMask=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Updates a call set.</p> 89<p class="toc_element"> 90 <code><a href="#search">search(body, x__xgafv=None)</a></code></p> 91<p class="firstline">Gets a list of call sets matching the criteria.</p> 92<p class="toc_element"> 93 <code><a href="#search_next">search_next(previous_request, previous_response)</a></code></p> 94<p class="firstline">Retrieves the next page of results.</p> 95<h3>Method Details</h3> 96<div class="method"> 97 <code class="details" id="create">create(body, x__xgafv=None)</code> 98 <pre>Creates a new call set. 99 100For the definitions of call sets and other genomics resources, see 101[Fundamentals of Google 102Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) 103 104Args: 105 body: object, The request body. (required) 106 The object takes the form of: 107 108{ # A call set is a collection of variant calls, typically for one sample. It 109 # belongs to a variant set. 110 # 111 # For more genomics resource definitions, see [Fundamentals of Google 112 # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) 113 "info": { # A map of additional call set information. This must be of the form 114 # map<string, string[]> (string key mapping to a list of string values). 115 "a_key": [ 116 "", 117 ], 118 }, 119 "name": "A String", # The call set name. 120 "created": "A String", # The date this call set was created in milliseconds from the epoch. 121 "sampleId": "A String", # The sample ID this call set corresponds to. 122 "variantSetIds": [ # The IDs of the variant sets this call set belongs to. This field must 123 # have exactly length one, as a call set belongs to a single variant set. 124 # This field is repeated for compatibility with the 125 # [GA4GH 0.5.1 126 # API](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variants.avdl#L76). 127 "A String", 128 ], 129 "id": "A String", # The server-generated call set ID, unique across all call sets. 130 } 131 132 x__xgafv: string, V1 error format. 133 Allowed values 134 1 - v1 error format 135 2 - v2 error format 136 137Returns: 138 An object of the form: 139 140 { # A call set is a collection of variant calls, typically for one sample. It 141 # belongs to a variant set. 142 # 143 # For more genomics resource definitions, see [Fundamentals of Google 144 # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) 145 "info": { # A map of additional call set information. This must be of the form 146 # map<string, string[]> (string key mapping to a list of string values). 147 "a_key": [ 148 "", 149 ], 150 }, 151 "name": "A String", # The call set name. 152 "created": "A String", # The date this call set was created in milliseconds from the epoch. 153 "sampleId": "A String", # The sample ID this call set corresponds to. 154 "variantSetIds": [ # The IDs of the variant sets this call set belongs to. This field must 155 # have exactly length one, as a call set belongs to a single variant set. 156 # This field is repeated for compatibility with the 157 # [GA4GH 0.5.1 158 # API](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variants.avdl#L76). 159 "A String", 160 ], 161 "id": "A String", # The server-generated call set ID, unique across all call sets. 162 }</pre> 163</div> 164 165<div class="method"> 166 <code class="details" id="delete">delete(callSetId, x__xgafv=None)</code> 167 <pre>Deletes a call set. 168 169For the definitions of call sets and other genomics resources, see 170[Fundamentals of Google 171Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) 172 173Args: 174 callSetId: string, The ID of the call set to be deleted. (required) 175 x__xgafv: string, V1 error format. 176 Allowed values 177 1 - v1 error format 178 2 - v2 error format 179 180Returns: 181 An object of the form: 182 183 { # A generic empty message that you can re-use to avoid defining duplicated 184 # empty messages in your APIs. A typical example is to use it as the request 185 # or the response type of an API method. For instance: 186 # 187 # service Foo { 188 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); 189 # } 190 # 191 # The JSON representation for `Empty` is empty JSON object `{}`. 192 }</pre> 193</div> 194 195<div class="method"> 196 <code class="details" id="get">get(callSetId, x__xgafv=None)</code> 197 <pre>Gets a call set by ID. 198 199For the definitions of call sets and other genomics resources, see 200[Fundamentals of Google 201Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) 202 203Args: 204 callSetId: string, The ID of the call set. (required) 205 x__xgafv: string, V1 error format. 206 Allowed values 207 1 - v1 error format 208 2 - v2 error format 209 210Returns: 211 An object of the form: 212 213 { # A call set is a collection of variant calls, typically for one sample. It 214 # belongs to a variant set. 215 # 216 # For more genomics resource definitions, see [Fundamentals of Google 217 # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) 218 "info": { # A map of additional call set information. This must be of the form 219 # map<string, string[]> (string key mapping to a list of string values). 220 "a_key": [ 221 "", 222 ], 223 }, 224 "name": "A String", # The call set name. 225 "created": "A String", # The date this call set was created in milliseconds from the epoch. 226 "sampleId": "A String", # The sample ID this call set corresponds to. 227 "variantSetIds": [ # The IDs of the variant sets this call set belongs to. This field must 228 # have exactly length one, as a call set belongs to a single variant set. 229 # This field is repeated for compatibility with the 230 # [GA4GH 0.5.1 231 # API](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variants.avdl#L76). 232 "A String", 233 ], 234 "id": "A String", # The server-generated call set ID, unique across all call sets. 235 }</pre> 236</div> 237 238<div class="method"> 239 <code class="details" id="patch">patch(callSetId, body, updateMask=None, x__xgafv=None)</code> 240 <pre>Updates a call set. 241 242For the definitions of call sets and other genomics resources, see 243[Fundamentals of Google 244Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) 245 246This method supports patch semantics. 247 248Args: 249 callSetId: string, The ID of the call set to be updated. (required) 250 body: object, The request body. (required) 251 The object takes the form of: 252 253{ # A call set is a collection of variant calls, typically for one sample. It 254 # belongs to a variant set. 255 # 256 # For more genomics resource definitions, see [Fundamentals of Google 257 # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) 258 "info": { # A map of additional call set information. This must be of the form 259 # map<string, string[]> (string key mapping to a list of string values). 260 "a_key": [ 261 "", 262 ], 263 }, 264 "name": "A String", # The call set name. 265 "created": "A String", # The date this call set was created in milliseconds from the epoch. 266 "sampleId": "A String", # The sample ID this call set corresponds to. 267 "variantSetIds": [ # The IDs of the variant sets this call set belongs to. This field must 268 # have exactly length one, as a call set belongs to a single variant set. 269 # This field is repeated for compatibility with the 270 # [GA4GH 0.5.1 271 # API](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variants.avdl#L76). 272 "A String", 273 ], 274 "id": "A String", # The server-generated call set ID, unique across all call sets. 275 } 276 277 updateMask: string, An optional mask specifying which fields to update. At this time, the only 278mutable field is name. The only 279acceptable value is "name". If unspecified, all mutable fields will be 280updated. 281 x__xgafv: string, V1 error format. 282 Allowed values 283 1 - v1 error format 284 2 - v2 error format 285 286Returns: 287 An object of the form: 288 289 { # A call set is a collection of variant calls, typically for one sample. It 290 # belongs to a variant set. 291 # 292 # For more genomics resource definitions, see [Fundamentals of Google 293 # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) 294 "info": { # A map of additional call set information. This must be of the form 295 # map<string, string[]> (string key mapping to a list of string values). 296 "a_key": [ 297 "", 298 ], 299 }, 300 "name": "A String", # The call set name. 301 "created": "A String", # The date this call set was created in milliseconds from the epoch. 302 "sampleId": "A String", # The sample ID this call set corresponds to. 303 "variantSetIds": [ # The IDs of the variant sets this call set belongs to. This field must 304 # have exactly length one, as a call set belongs to a single variant set. 305 # This field is repeated for compatibility with the 306 # [GA4GH 0.5.1 307 # API](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variants.avdl#L76). 308 "A String", 309 ], 310 "id": "A String", # The server-generated call set ID, unique across all call sets. 311 }</pre> 312</div> 313 314<div class="method"> 315 <code class="details" id="search">search(body, x__xgafv=None)</code> 316 <pre>Gets a list of call sets matching the criteria. 317 318For the definitions of call sets and other genomics resources, see 319[Fundamentals of Google 320Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) 321 322Implements 323[GlobalAllianceApi.searchCallSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L178). 324 325Args: 326 body: object, The request body. (required) 327 The object takes the form of: 328 329{ # The call set search request. 330 "pageToken": "A String", # The continuation token, which is used to page through large result sets. 331 # To get the next page of results, set this parameter to the value of 332 # `nextPageToken` from the previous response. 333 "variantSetIds": [ # Restrict the query to call sets within the given variant sets. At least one 334 # ID must be provided. 335 "A String", 336 ], 337 "name": "A String", # Only return call sets for which a substring of the name matches this 338 # string. 339 "pageSize": 42, # The maximum number of results to return in a single page. If unspecified, 340 # defaults to 1024. 341 } 342 343 x__xgafv: string, V1 error format. 344 Allowed values 345 1 - v1 error format 346 2 - v2 error format 347 348Returns: 349 An object of the form: 350 351 { # The call set search response. 352 "nextPageToken": "A String", # The continuation token, which is used to page through large result sets. 353 # Provide this value in a subsequent request to return the next page of 354 # results. This field will be empty if there aren't any additional results. 355 "callSets": [ # The list of matching call sets. 356 { # A call set is a collection of variant calls, typically for one sample. It 357 # belongs to a variant set. 358 # 359 # For more genomics resource definitions, see [Fundamentals of Google 360 # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) 361 "info": { # A map of additional call set information. This must be of the form 362 # map<string, string[]> (string key mapping to a list of string values). 363 "a_key": [ 364 "", 365 ], 366 }, 367 "name": "A String", # The call set name. 368 "created": "A String", # The date this call set was created in milliseconds from the epoch. 369 "sampleId": "A String", # The sample ID this call set corresponds to. 370 "variantSetIds": [ # The IDs of the variant sets this call set belongs to. This field must 371 # have exactly length one, as a call set belongs to a single variant set. 372 # This field is repeated for compatibility with the 373 # [GA4GH 0.5.1 374 # API](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variants.avdl#L76). 375 "A String", 376 ], 377 "id": "A String", # The server-generated call set ID, unique across all call sets. 378 }, 379 ], 380 }</pre> 381</div> 382 383<div class="method"> 384 <code class="details" id="search_next">search_next(previous_request, previous_response)</code> 385 <pre>Retrieves the next page of results. 386 387Args: 388 previous_request: The request for the previous page. (required) 389 previous_response: The response from the request for the previous page. (required) 390 391Returns: 392 A request object that you can call 'execute()' on to request the next 393 page. Returns None if there are no more items in the collection. 394 </pre> 395</div> 396 397</body></html>