Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 9a8f94bab0bd764463c98ea8da71a2d200f65ca3 / . / docs / dyn / genomics_v1beta2.annotationSets.html
blob: 266790094d48159c89346e1455e140b5af560b9e [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>
91<p class="firstline">Searches for annotation sets which match the given criteria. Results are returned in a deterministic order. Caller must have READ permission for the queried datasets.</p>
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
100Args:
101 body: object, The request body. (required)
102 The object takes the form of:
103
104{ # An annotation set is a logical grouping of annotations which share consistent type information and provenance. An example would be 'all genes from refseq', or 'all variant annotations from ClinVar'.
105 "info": { # A map of additional data for this annotation set.
106 "a_key": [ # A string which maps to an array of values.
107 "A String",
108 ],
109 },
110 "name": "A String", # The display name for this annotation set.
111 "sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
112 "type": "A String", # The type of annotations contained within this set.
113 "referenceSetId": "A String", # The ID of the reference set which defines the coordinate-space for this set's annotations.
114 "id": "A String", # The generated unique ID for this annotation set.
115 "datasetId": "A String", # The ID of the containing dataset.
116}
117
118
119Returns:
120 An object of the form:
121
122 { # An annotation set is a logical grouping of annotations which share consistent type information and provenance. An example would be 'all genes from refseq', or 'all variant annotations from ClinVar'.
123 "info": { # A map of additional data for this annotation set.
124 "a_key": [ # A string which maps to an array of values.
125 "A String",
126 ],
127 },
128 "name": "A String", # The display name for this annotation set.
129 "sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
130 "type": "A String", # The type of annotations contained within this set.
131 "referenceSetId": "A String", # The ID of the reference set which defines the coordinate-space for this set's annotations.
132 "id": "A String", # The generated unique ID for this annotation set.
133 "datasetId": "A String", # The ID of the containing dataset.
134 }</pre>
135</div>
136
137<div class="method">
138 <code class="details" id="delete">delete(annotationSetId)</code>
139 <pre>Deletes an annotation set. Caller must have WRITE permission for the associated annotation set.
140
141Args:
142 annotationSetId: string, The ID of the annotation set to be deleted. (required)
143</pre>
144</div>
145
146<div class="method">
147 <code class="details" id="get">get(annotationSetId)</code>
148 <pre>Gets an annotation set. Caller must have READ permission for the associated dataset.
149
150Args:
151 annotationSetId: string, The ID of the annotation set to be retrieved. (required)
152
153Returns:
154 An object of the form:
155
156 { # An annotation set is a logical grouping of annotations which share consistent type information and provenance. An example would be 'all genes from refseq', or 'all variant annotations from ClinVar'.
157 "info": { # A map of additional data for this annotation set.
158 "a_key": [ # A string which maps to an array of values.
159 "A String",
160 ],
161 },
162 "name": "A String", # The display name for this annotation set.
163 "sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
164 "type": "A String", # The type of annotations contained within this set.
165 "referenceSetId": "A String", # The ID of the reference set which defines the coordinate-space for this set's annotations.
166 "id": "A String", # The generated unique ID for this annotation set.
167 "datasetId": "A String", # The ID of the containing dataset.
168 }</pre>
169</div>
170
171<div class="method">
172 <code class="details" id="patch">patch(annotationSetId, body)</code>
173 <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.
174
175Args:
176 annotationSetId: string, The ID of the annotation set to be updated. (required)
177 body: object, The request body. (required)
178 The object takes the form of:
179
180{ # An annotation set is a logical grouping of annotations which share consistent type information and provenance. An example would be 'all genes from refseq', or 'all variant annotations from ClinVar'.
181 "info": { # A map of additional data for this annotation set.
182 "a_key": [ # A string which maps to an array of values.
183 "A String",
184 ],
185 },
186 "name": "A String", # The display name for this annotation set.
187 "sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
188 "type": "A String", # The type of annotations contained within this set.
189 "referenceSetId": "A String", # The ID of the reference set which defines the coordinate-space for this set's annotations.
190 "id": "A String", # The generated unique ID for this annotation set.
191 "datasetId": "A String", # The ID of the containing dataset.
192}
193
194
195Returns:
196 An object of the form:
197
198 { # An annotation set is a logical grouping of annotations which share consistent type information and provenance. An example would be 'all genes from refseq', or 'all variant annotations from ClinVar'.
199 "info": { # A map of additional data for this annotation set.
200 "a_key": [ # A string which maps to an array of values.
201 "A String",
202 ],
203 },
204 "name": "A String", # The display name for this annotation set.
205 "sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
206 "type": "A String", # The type of annotations contained within this set.
207 "referenceSetId": "A String", # The ID of the reference set which defines the coordinate-space for this set's annotations.
208 "id": "A String", # The generated unique ID for this annotation set.
209 "datasetId": "A String", # The ID of the containing dataset.
210 }</pre>
211</div>
212
213<div class="method">
214 <code class="details" id="search">search(body)</code>
215 <pre>Searches for annotation sets which match the given criteria. Results are returned in a deterministic order. Caller must have READ permission for the queried datasets.
216
217Args:
218 body: object, The request body. (required)
219 The object takes the form of:
220
221{
222 "name": "A String", # Only return annotations sets for which a substring of the name matches this string (case insensitive).
223 "pageSize": 42, # Specifies number of results to return in a single page. If unspecified, it will default to 128. The maximum value is 1024.
224 "datasetIds": [ # The dataset IDs to search within. Caller must have READ access to these datasets.
225 "A String",
226 ],
227 "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.
228 "referenceSetId": "A String", # If specified, only annotation sets associated with the given reference set are returned.
229 "types": [ # If specified, only annotation sets which have any of these types are returned.
230 "A String",
231 ],
232 }
233
234
235Returns:
236 An object of the form:
237
238 {
239 "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.
240 "annotationSets": [ # The matching annotation sets.
241 { # An annotation set is a logical grouping of annotations which share consistent type information and provenance. An example would be 'all genes from refseq', or 'all variant annotations from ClinVar'.
242 "info": { # A map of additional data for this annotation set.
243 "a_key": [ # A string which maps to an array of values.
244 "A String",
245 ],
246 },
247 "name": "A String", # The display name for this annotation set.
248 "sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
249 "type": "A String", # The type of annotations contained within this set.
250 "referenceSetId": "A String", # The ID of the reference set which defines the coordinate-space for this set's annotations.
251 "id": "A String", # The generated unique ID for this annotation set.
252 "datasetId": "A String", # The ID of the containing dataset.
253 },
254 ],
255 }</pre>
256</div>
257
258<div class="method">
259 <code class="details" id="update">update(annotationSetId, body)</code>
260 <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.
261
262Args:
263 annotationSetId: string, The ID of the annotation set to be updated. (required)
264 body: object, The request body. (required)
265 The object takes the form of:
266
267{ # An annotation set is a logical grouping of annotations which share consistent type information and provenance. An example would be 'all genes from refseq', or 'all variant annotations from ClinVar'.
268 "info": { # A map of additional data for this annotation set.
269 "a_key": [ # A string which maps to an array of values.
270 "A String",
271 ],
272 },
273 "name": "A String", # The display name for this annotation set.
274 "sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
275 "type": "A String", # The type of annotations contained within this set.
276 "referenceSetId": "A String", # The ID of the reference set which defines the coordinate-space for this set's annotations.
277 "id": "A String", # The generated unique ID for this annotation set.
278 "datasetId": "A String", # The ID of the containing dataset.
279}
280
281
282Returns:
283 An object of the form:
284
285 { # An annotation set is a logical grouping of annotations which share consistent type information and provenance. An example would be 'all genes from refseq', or 'all variant annotations from ClinVar'.
286 "info": { # A map of additional data for this annotation set.
287 "a_key": [ # A string which maps to an array of values.
288 "A String",
289 ],
290 },
291 "name": "A String", # The display name for this annotation set.
292 "sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
293 "type": "A String", # The type of annotations contained within this set.
294 "referenceSetId": "A String", # The ID of the reference set which defines the coordinate-space for this set's annotations.
295 "id": "A String", # The generated unique ID for this annotation set.
296 "datasetId": "A String", # The ID of the containing dataset.
297 }</pre>
298</div>
299
300</body></html>