| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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.annotationsets.html">annotationsets</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> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 79 | <p class="firstline">Creates a new annotation set. Caller must have WRITE permission for the</p> |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 80 | <p class="toc_element"> |
| 81 | <code><a href="#delete">delete(annotationSetId, x__xgafv=None)</a></code></p> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 82 | <p class="firstline">Deletes an annotation set. Caller must have WRITE permission</p> |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 83 | <p class="toc_element"> |
| 84 | <code><a href="#get">get(annotationSetId, x__xgafv=None)</a></code></p> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 85 | <p class="firstline">Gets an annotation set. Caller must have READ permission for</p> |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 86 | <p class="toc_element"> |
| 87 | <code><a href="#search">search(body, x__xgafv=None)</a></code></p> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 88 | <p class="firstline">Searches for annotation sets that match the given criteria. Annotation sets</p> |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 89 | <p class="toc_element"> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 90 | <code><a href="#search_next">search_next(previous_request, previous_response)</a></code></p> |
| 91 | <p class="firstline">Retrieves the next page of results.</p> |
| 92 | <p class="toc_element"> |
| Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame^] | 93 | <code><a href="#update">update(annotationSetId, body, updateMask=None, x__xgafv=None)</a></code></p> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 94 | <p class="firstline">Updates an annotation set. The update must respect all mutability</p> |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 95 | <h3>Method Details</h3> |
| 96 | <div class="method"> |
| 97 | <code class="details" id="create">create(body, x__xgafv=None)</code> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 98 | <pre>Creates a new annotation set. Caller must have WRITE permission for the |
| 99 | associated dataset. |
| 100 | |
| 101 | The following fields are required: |
| 102 | |
| 103 | * datasetId |
| 104 | * referenceSetId |
| 105 | |
| 106 | All other fields may be optionally specified, unless documented as being |
| 107 | server-generated (for example, the `id` field). |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 108 | |
| 109 | Args: |
| 110 | body: object, The request body. (required) |
| 111 | The object takes the form of: |
| 112 | |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 113 | { # An annotation set is a logical grouping of annotations that share consistent |
| 114 | # type information and provenance. Examples of annotation sets include 'all |
| 115 | # genes from refseq', and 'all variant annotations from ClinVar'. |
| 116 | "info": { # A map of additional read alignment information. This must be of the form |
| 117 | # map<string, string[]> (string key mapping to a list of string values). |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 118 | "a_key": [ |
| 119 | "", |
| 120 | ], |
| 121 | }, |
| 122 | "name": "A String", # The display name for this annotation set. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 123 | "sourceUri": "A String", # The source URI describing the file from which this annotation set was |
| 124 | # generated, if any. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 125 | "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this |
| 126 | # set's annotations. |
| Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame] | 127 | "type": "A String", # The type of annotations contained within this set. |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 128 | "id": "A String", # The server-generated annotation set ID, unique across all annotation sets. |
| 129 | "datasetId": "A String", # The dataset to which this annotation set belongs. |
| Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame^] | 130 | } |
| 131 | |
| 132 | x__xgafv: string, V1 error format. |
| 133 | Allowed values |
| 134 | 1 - v1 error format |
| 135 | 2 - v2 error format |
| 136 | |
| 137 | Returns: |
| 138 | An object of the form: |
| 139 | |
| 140 | { # An annotation set is a logical grouping of annotations that share consistent |
| 141 | # type information and provenance. Examples of annotation sets include 'all |
| 142 | # genes from refseq', and 'all variant annotations from ClinVar'. |
| 143 | "info": { # A map of additional read alignment information. This must be of the form |
| 144 | # map<string, string[]> (string key mapping to a list of string values). |
| 145 | "a_key": [ |
| 146 | "", |
| 147 | ], |
| 148 | }, |
| 149 | "name": "A String", # The display name for this annotation set. |
| 150 | "sourceUri": "A String", # The source URI describing the file from which this annotation set was |
| 151 | # generated, if any. |
| 152 | "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this |
| 153 | # set's annotations. |
| 154 | "type": "A String", # The type of annotations contained within this set. |
| 155 | "id": "A String", # The server-generated annotation set ID, unique across all annotation sets. |
| 156 | "datasetId": "A String", # The dataset to which this annotation set belongs. |
| 157 | }</pre> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 158 | </div> |
| 159 | |
| 160 | <div class="method"> |
| 161 | <code class="details" id="delete">delete(annotationSetId, x__xgafv=None)</code> |
| 162 | <pre>Deletes an annotation set. Caller must have WRITE permission |
| 163 | for the associated annotation set. |
| 164 | |
| 165 | Args: |
| 166 | annotationSetId: string, The ID of the annotation set to be deleted. (required) |
| 167 | x__xgafv: string, V1 error format. |
| 168 | Allowed values |
| 169 | 1 - v1 error format |
| 170 | 2 - v2 error format |
| 171 | |
| 172 | Returns: |
| 173 | An object of the form: |
| 174 | |
| 175 | { # A generic empty message that you can re-use to avoid defining duplicated |
| 176 | # empty messages in your APIs. A typical example is to use it as the request |
| 177 | # or the response type of an API method. For instance: |
| 178 | # |
| 179 | # service Foo { |
| 180 | # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| 181 | # } |
| 182 | # |
| 183 | # The JSON representation for `Empty` is empty JSON object `{}`. |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 184 | }</pre> |
| 185 | </div> |
| 186 | |
| 187 | <div class="method"> |
| 188 | <code class="details" id="get">get(annotationSetId, x__xgafv=None)</code> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 189 | <pre>Gets an annotation set. Caller must have READ permission for |
| 190 | the associated dataset. |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 191 | |
| 192 | Args: |
| 193 | annotationSetId: string, The ID of the annotation set to be retrieved. (required) |
| 194 | x__xgafv: string, V1 error format. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 195 | Allowed values |
| 196 | 1 - v1 error format |
| 197 | 2 - v2 error format |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 198 | |
| 199 | Returns: |
| 200 | An object of the form: |
| 201 | |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 202 | { # An annotation set is a logical grouping of annotations that share consistent |
| Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame^] | 203 | # type information and provenance. Examples of annotation sets include 'all |
| 204 | # genes from refseq', and 'all variant annotations from ClinVar'. |
| 205 | "info": { # A map of additional read alignment information. This must be of the form |
| 206 | # map<string, string[]> (string key mapping to a list of string values). |
| 207 | "a_key": [ |
| 208 | "", |
| 209 | ], |
| 210 | }, |
| 211 | "name": "A String", # The display name for this annotation set. |
| 212 | "sourceUri": "A String", # The source URI describing the file from which this annotation set was |
| 213 | # generated, if any. |
| 214 | "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this |
| 215 | # set's annotations. |
| 216 | "type": "A String", # The type of annotations contained within this set. |
| 217 | "id": "A String", # The server-generated annotation set ID, unique across all annotation sets. |
| 218 | "datasetId": "A String", # The dataset to which this annotation set belongs. |
| 219 | }</pre> |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 220 | </div> |
| 221 | |
| 222 | <div class="method"> |
| 223 | <code class="details" id="search">search(body, x__xgafv=None)</code> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 224 | <pre>Searches for annotation sets that match the given criteria. Annotation sets |
| 225 | are returned in an unspecified order. This order is consistent, such that |
| 226 | two queries for the same content (regardless of page size) yield annotation |
| 227 | sets in the same order across their respective streams of paginated |
| 228 | responses. Caller must have READ permission for the queried datasets. |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 229 | |
| 230 | Args: |
| 231 | body: object, The request body. (required) |
| 232 | The object takes the form of: |
| 233 | |
| 234 | { |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 235 | "name": "A String", # Only return annotations sets for which a substring of the name matches this |
| 236 | # string (case insensitive). |
| 237 | "pageSize": 42, # The maximum number of results to return in a single page. If unspecified, |
| 238 | # defaults to 128. The maximum value is 1024. |
| 239 | "datasetIds": [ # Required. The dataset IDs to search within. Caller must have `READ` access |
| 240 | # to these datasets. |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 241 | "A String", |
| 242 | ], |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 243 | "pageToken": "A String", # The continuation token, which is used to page through large result sets. |
| 244 | # To get the next page of results, set this parameter to the value of |
| 245 | # `nextPageToken` from the previous response. |
| 246 | "referenceSetId": "A String", # If specified, only annotation sets associated with the given reference set |
| 247 | # are returned. |
| 248 | "types": [ # If specified, only annotation sets that have any of these types are |
| 249 | # returned. |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 250 | "A String", |
| 251 | ], |
| 252 | } |
| 253 | |
| 254 | x__xgafv: string, V1 error format. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 255 | Allowed values |
| 256 | 1 - v1 error format |
| 257 | 2 - v2 error format |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 258 | |
| 259 | Returns: |
| 260 | An object of the form: |
| 261 | |
| 262 | { |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 263 | "nextPageToken": "A String", # The continuation token, which is used to page through large result sets. |
| 264 | # Provide this value in a subsequent request to return the next page of |
| 265 | # results. This field will be empty if there aren't any additional results. |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 266 | "annotationSets": [ # The matching annotation sets. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 267 | { # An annotation set is a logical grouping of annotations that share consistent |
| Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame^] | 268 | # type information and provenance. Examples of annotation sets include 'all |
| 269 | # genes from refseq', and 'all variant annotations from ClinVar'. |
| 270 | "info": { # A map of additional read alignment information. This must be of the form |
| 271 | # map<string, string[]> (string key mapping to a list of string values). |
| 272 | "a_key": [ |
| 273 | "", |
| 274 | ], |
| 275 | }, |
| 276 | "name": "A String", # The display name for this annotation set. |
| 277 | "sourceUri": "A String", # The source URI describing the file from which this annotation set was |
| 278 | # generated, if any. |
| 279 | "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this |
| 280 | # set's annotations. |
| 281 | "type": "A String", # The type of annotations contained within this set. |
| 282 | "id": "A String", # The server-generated annotation set ID, unique across all annotation sets. |
| 283 | "datasetId": "A String", # The dataset to which this annotation set belongs. |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 284 | }, |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 285 | ], |
| 286 | }</pre> |
| 287 | </div> |
| 288 | |
| 289 | <div class="method"> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 290 | <code class="details" id="search_next">search_next(previous_request, previous_response)</code> |
| 291 | <pre>Retrieves the next page of results. |
| 292 | |
| 293 | Args: |
| 294 | previous_request: The request for the previous page. (required) |
| 295 | previous_response: The response from the request for the previous page. (required) |
| 296 | |
| 297 | Returns: |
| 298 | A request object that you can call 'execute()' on to request the next |
| 299 | page. Returns None if there are no more items in the collection. |
| 300 | </pre> |
| 301 | </div> |
| 302 | |
| 303 | <div class="method"> |
| Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame^] | 304 | <code class="details" id="update">update(annotationSetId, body, updateMask=None, x__xgafv=None)</code> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 305 | <pre>Updates an annotation set. The update must respect all mutability |
| 306 | restrictions and other invariants described on the annotation set resource. |
| 307 | Caller must have WRITE permission for the associated dataset. |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 308 | |
| 309 | Args: |
| 310 | annotationSetId: string, The ID of the annotation set to be updated. (required) |
| 311 | body: object, The request body. (required) |
| 312 | The object takes the form of: |
| 313 | |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 314 | { # An annotation set is a logical grouping of annotations that share consistent |
| 315 | # type information and provenance. Examples of annotation sets include 'all |
| 316 | # genes from refseq', and 'all variant annotations from ClinVar'. |
| 317 | "info": { # A map of additional read alignment information. This must be of the form |
| 318 | # map<string, string[]> (string key mapping to a list of string values). |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 319 | "a_key": [ |
| 320 | "", |
| 321 | ], |
| 322 | }, |
| 323 | "name": "A String", # The display name for this annotation set. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 324 | "sourceUri": "A String", # The source URI describing the file from which this annotation set was |
| 325 | # generated, if any. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 326 | "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this |
| 327 | # set's annotations. |
| Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame] | 328 | "type": "A String", # The type of annotations contained within this set. |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 329 | "id": "A String", # The server-generated annotation set ID, unique across all annotation sets. |
| 330 | "datasetId": "A String", # The dataset to which this annotation set belongs. |
| Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame^] | 331 | } |
| 332 | |
| 333 | updateMask: string, An optional mask specifying which fields to update. Mutable fields are |
| 334 | name, |
| 335 | source_uri, and |
| 336 | info. If unspecified, all |
| 337 | mutable fields will be updated. |
| 338 | x__xgafv: string, V1 error format. |
| 339 | Allowed values |
| 340 | 1 - v1 error format |
| 341 | 2 - v2 error format |
| 342 | |
| 343 | Returns: |
| 344 | An object of the form: |
| 345 | |
| 346 | { # An annotation set is a logical grouping of annotations that share consistent |
| 347 | # type information and provenance. Examples of annotation sets include 'all |
| 348 | # genes from refseq', and 'all variant annotations from ClinVar'. |
| 349 | "info": { # A map of additional read alignment information. This must be of the form |
| 350 | # map<string, string[]> (string key mapping to a list of string values). |
| 351 | "a_key": [ |
| 352 | "", |
| 353 | ], |
| 354 | }, |
| 355 | "name": "A String", # The display name for this annotation set. |
| 356 | "sourceUri": "A String", # The source URI describing the file from which this annotation set was |
| 357 | # generated, if any. |
| 358 | "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this |
| 359 | # set's annotations. |
| 360 | "type": "A String", # The type of annotations contained within this set. |
| 361 | "id": "A String", # The server-generated annotation set ID, unique across all annotation sets. |
| 362 | "datasetId": "A String", # The dataset to which this annotation set belongs. |
| 363 | }</pre> |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 364 | </div> |
| 365 | |
| 366 | </body></html> |