Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / df61397973d36909a46fc4c3bf0e006dbb69f79a / . / docs / dyn / genomics_v1beta2.annotationSets.html
blob: c6d4d5deed1ae431d597c3a5e5d7fd2c33178122 [file] [log] [blame]
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]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_v1beta2.html">Genomics API</a> . <a href="genomics_v1beta2.annotationSets.html">annotationSets</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#create">create(body)</a></code></p>
79<p class="firstline">Creates a new annotation set. Caller must have WRITE permission for the associated dataset.</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(annotationSetId)</a></code></p>
82<p class="firstline">Deletes an annotation set. Caller must have WRITE permission for the associated annotation set.</p>
83<p class="toc_element">
84 <code><a href="#get">get(annotationSetId)</a></code></p>
85<p class="firstline">Gets an annotation set. Caller must have READ permission for the associated dataset.</p>
86<p class="toc_element">
87 <code><a href="#patch">patch(annotationSetId, body)</a></code></p>
88<p class="firstline">Updates an annotation set. The update must respect all mutability restrictions and other invariants described on the annotation set resource. Caller must have WRITE permission for the associated dataset. This method supports patch semantics.</p>
89<p class="toc_element">
90 <code><a href="#search">search(body)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]91<p class="firstline">Searches for annotation sets that match the given criteria. Annotation sets are returned in an unspecified order. This order is consistent, such that two queries for the same content (regardless of page size) yield annotation sets in the same order across their respective streams of paginated responses. Caller must have READ permission for the queried datasets.</p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]92<p class="toc_element">
93 <code><a href="#update">update(annotationSetId, body)</a></code></p>
94<p class="firstline">Updates an annotation set. The update must respect all mutability restrictions and other invariants described on the annotation set resource. Caller must have WRITE permission for the associated dataset.</p>
95<h3>Method Details</h3>
96<div class="method">
97 <code class="details" id="create">create(body)</code>
98 <pre>Creates a new annotation set. Caller must have WRITE permission for the associated dataset.
99
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]100The following fields must be provided when creating an annotation set:
101- datasetId
102- referenceSetId
103All other fields may be optionally specified, unless documented as being server-generated (for example, the id field).
104
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]105Args:
106 body: object, The request body. (required)
107 The object takes the form of:
108
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]109{ # An annotation set is a logical grouping of annotations that share consistent type information and provenance. Examples of annotation sets include 'all genes from refseq', and 'all variant annotations from ClinVar'.
110 "info": { # A string which maps to an array of values.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]111 "a_key": [ # A string which maps to an array of values.
112 "A String",
113 ],
114 },
115 "name": "A String", # The display name for this annotation set.
116 "sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
117 "type": "A String", # The type of annotations contained within this set.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]118 "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]119 "id": "A String", # The server-generated annotation set ID, unique across all annotation sets.
120 "datasetId": "A String", # The dataset to which this annotation set belongs.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]121}
122
123
124Returns:
125 An object of the form:
126
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]127 { # An annotation set is a logical grouping of annotations that share consistent type information and provenance. Examples of annotation sets include 'all genes from refseq', and 'all variant annotations from ClinVar'.
128 "info": { # A string which maps to an array of values.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]129 "a_key": [ # A string which maps to an array of values.
130 "A String",
131 ],
132 },
133 "name": "A String", # The display name for this annotation set.
134 "sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
135 "type": "A String", # The type of annotations contained within this set.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]136 "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]137 "id": "A String", # The server-generated annotation set ID, unique across all annotation sets.
138 "datasetId": "A String", # The dataset to which this annotation set belongs.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]139 }</pre>
140</div>
141
142<div class="method">
143 <code class="details" id="delete">delete(annotationSetId)</code>
144 <pre>Deletes an annotation set. Caller must have WRITE permission for the associated annotation set.
145
146Args:
147 annotationSetId: string, The ID of the annotation set to be deleted. (required)
148</pre>
149</div>
150
151<div class="method">
152 <code class="details" id="get">get(annotationSetId)</code>
153 <pre>Gets an annotation set. Caller must have READ permission for the associated dataset.
154
155Args:
156 annotationSetId: string, The ID of the annotation set to be retrieved. (required)
157
158Returns:
159 An object of the form:
160
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]161 { # An annotation set is a logical grouping of annotations that share consistent type information and provenance. Examples of annotation sets include 'all genes from refseq', and 'all variant annotations from ClinVar'.
162 "info": { # A string which maps to an array of values.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]163 "a_key": [ # A string which maps to an array of values.
164 "A String",
165 ],
166 },
167 "name": "A String", # The display name for this annotation set.
168 "sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
169 "type": "A String", # The type of annotations contained within this set.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]170 "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]171 "id": "A String", # The server-generated annotation set ID, unique across all annotation sets.
172 "datasetId": "A String", # The dataset to which this annotation set belongs.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]173 }</pre>
174</div>
175
176<div class="method">
177 <code class="details" id="patch">patch(annotationSetId, body)</code>
178 <pre>Updates an annotation set. The update must respect all mutability restrictions and other invariants described on the annotation set resource. Caller must have WRITE permission for the associated dataset. This method supports patch semantics.
179
180Args:
181 annotationSetId: string, The ID of the annotation set to be updated. (required)
182 body: object, The request body. (required)
183 The object takes the form of:
184
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]185{ # An annotation set is a logical grouping of annotations that share consistent type information and provenance. Examples of annotation sets include 'all genes from refseq', and 'all variant annotations from ClinVar'.
186 "info": { # A string which maps to an array of values.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]187 "a_key": [ # A string which maps to an array of values.
188 "A String",
189 ],
190 },
191 "name": "A String", # The display name for this annotation set.
192 "sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
193 "type": "A String", # The type of annotations contained within this set.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]194 "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]195 "id": "A String", # The server-generated annotation set ID, unique across all annotation sets.
196 "datasetId": "A String", # The dataset to which this annotation set belongs.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]197}
198
199
200Returns:
201 An object of the form:
202
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]203 { # An annotation set is a logical grouping of annotations that share consistent type information and provenance. Examples of annotation sets include 'all genes from refseq', and 'all variant annotations from ClinVar'.
204 "info": { # A string which maps to an array of values.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]205 "a_key": [ # A string which maps to an array of values.
206 "A String",
207 ],
208 },
209 "name": "A String", # The display name for this annotation set.
210 "sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
211 "type": "A String", # The type of annotations contained within this set.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]212 "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]213 "id": "A String", # The server-generated annotation set ID, unique across all annotation sets.
214 "datasetId": "A String", # The dataset to which this annotation set belongs.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]215 }</pre>
216</div>
217
218<div class="method">
219 <code class="details" id="search">search(body)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]220 <pre>Searches for annotation sets that match the given criteria. Annotation sets are returned in an unspecified order. This order is consistent, such that two queries for the same content (regardless of page size) yield annotation sets in the same order across their respective streams of paginated responses. Caller must have READ permission for the queried datasets.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]221
222Args:
223 body: object, The request body. (required)
224 The object takes the form of:
225
226{
227 "name": "A String", # Only return annotations sets for which a substring of the name matches this string (case insensitive).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]228 "pageSize": 42, # The maximum number of results to return in a single page. If unspecified, defaults to 128. The maximum value is 1024.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]229 "datasetIds": [ # The dataset IDs to search within. Caller must have READ access to these datasets.
230 "A String",
231 ],
232 "pageToken": "A String", # The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.
233 "referenceSetId": "A String", # If specified, only annotation sets associated with the given reference set are returned.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]234 "types": [ # If specified, only annotation sets that have any of these types are returned.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]235 "A String",
236 ],
237 }
238
239
240Returns:
241 An object of the form:
242
243 {
244 "nextPageToken": "A String", # The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. This field will be empty if there aren't any additional results.
245 "annotationSets": [ # The matching annotation sets.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]246 { # An annotation set is a logical grouping of annotations that share consistent type information and provenance. Examples of annotation sets include 'all genes from refseq', and 'all variant annotations from ClinVar'.
247 "info": { # A string which maps to an array of values.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]248 "a_key": [ # A string which maps to an array of values.
249 "A String",
250 ],
251 },
252 "name": "A String", # The display name for this annotation set.
253 "sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
254 "type": "A String", # The type of annotations contained within this set.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]255 "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]256 "id": "A String", # The server-generated annotation set ID, unique across all annotation sets.
257 "datasetId": "A String", # The dataset to which this annotation set belongs.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]258 },
259 ],
260 }</pre>
261</div>
262
263<div class="method">
264 <code class="details" id="update">update(annotationSetId, body)</code>
265 <pre>Updates an annotation set. The update must respect all mutability restrictions and other invariants described on the annotation set resource. Caller must have WRITE permission for the associated dataset.
266
267Args:
268 annotationSetId: string, The ID of the annotation set to be updated. (required)
269 body: object, The request body. (required)
270 The object takes the form of:
271
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]272{ # An annotation set is a logical grouping of annotations that share consistent type information and provenance. Examples of annotation sets include 'all genes from refseq', and 'all variant annotations from ClinVar'.
273 "info": { # A string which maps to an array of values.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]274 "a_key": [ # A string which maps to an array of values.
275 "A String",
276 ],
277 },
278 "name": "A String", # The display name for this annotation set.
279 "sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
280 "type": "A String", # The type of annotations contained within this set.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]281 "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]284}
285
286
287Returns:
288 An object of the form:
289
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]290 { # An annotation set is a logical grouping of annotations that share consistent type information and provenance. Examples of annotation sets include 'all genes from refseq', and 'all variant annotations from ClinVar'.
291 "info": { # A string which maps to an array of values.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]292 "a_key": [ # A string which maps to an array of values.
293 "A String",
294 ],
295 },
296 "name": "A String", # The display name for this annotation set.
297 "sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
298 "type": "A String", # The type of annotations contained within this set.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]299 "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]300 "id": "A String", # The server-generated annotation set ID, unique across all annotation sets.
301 "datasetId": "A String", # The dataset to which this annotation set belongs.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]302 }</pre>
303</div>
304
305</body></html>