Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / e633be11dbb412e5030b5afca31111fa4074dff1 / . / docs / dyn / genomics_v1beta2.callsets.html
blob: 0cdcefcff4fe92c7ee8fa8dfddf922efa211fb9c [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.callsets.html">callsets</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 call set.</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(callSetId)</a></code></p>
82<p class="firstline">Deletes a call set.</p>
83<p class="toc_element">
84 <code><a href="#get">get(callSetId)</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)</a></code></p>
88<p class="firstline">Updates a call set. 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">Gets a list of call sets matching the criteria.</p>
92<p class="toc_element">
93 <code><a href="#update">update(callSetId, body)</a></code></p>
94<p class="firstline">Updates a call set.</p>
95<h3>Method Details</h3>
96<div class="method">
97 <code class="details" id="create">create(body)</code>
98 <pre>Creates a new call set.
99
100Args:
101 body: object, The request body. (required)
102 The object takes the form of:
103
104{ # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set.
105 "info": { # A map of additional call set information.
106 "a_key": [ # A string which maps to an array of values.
107 "A String",
108 ],
109 },
110 "name": "A String", # The call set name.
111 "created": "A String", # The date this call set was created in milliseconds from the epoch.
112 "sampleId": "A String", # The sample ID this call set corresponds to.
113 "variantSetIds": [ # The IDs of the variant sets this call set belongs to.
114 "A String",
115 ],
116 "id": "A String", # The Google generated ID of the call set, immutable.
117}
118
119
120Returns:
121 An object of the form:
122
123 { # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set.
124 "info": { # A map of additional call set information.
125 "a_key": [ # A string which maps to an array of values.
126 "A String",
127 ],
128 },
129 "name": "A String", # The call set name.
130 "created": "A String", # The date this call set was created in milliseconds from the epoch.
131 "sampleId": "A String", # The sample ID this call set corresponds to.
132 "variantSetIds": [ # The IDs of the variant sets this call set belongs to.
133 "A String",
134 ],
135 "id": "A String", # The Google generated ID of the call set, immutable.
136 }</pre>
137</div>
138
139<div class="method">
140 <code class="details" id="delete">delete(callSetId)</code>
141 <pre>Deletes a call set.
142
143Args:
144 callSetId: string, The ID of the call set to be deleted. (required)
145</pre>
146</div>
147
148<div class="method">
149 <code class="details" id="get">get(callSetId)</code>
150 <pre>Gets a call set by ID.
151
152Args:
153 callSetId: string, The ID of the call set. (required)
154
155Returns:
156 An object of the form:
157
158 { # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set.
159 "info": { # A map of additional call set information.
160 "a_key": [ # A string which maps to an array of values.
161 "A String",
162 ],
163 },
164 "name": "A String", # The call set name.
165 "created": "A String", # The date this call set was created in milliseconds from the epoch.
166 "sampleId": "A String", # The sample ID this call set corresponds to.
167 "variantSetIds": [ # The IDs of the variant sets this call set belongs to.
168 "A String",
169 ],
170 "id": "A String", # The Google generated ID of the call set, immutable.
171 }</pre>
172</div>
173
174<div class="method">
175 <code class="details" id="patch">patch(callSetId, body)</code>
176 <pre>Updates a call set. This method supports patch semantics.
177
178Args:
179 callSetId: string, The ID of the call set to be updated. (required)
180 body: object, The request body. (required)
181 The object takes the form of:
182
183{ # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set.
184 "info": { # A map of additional call set information.
185 "a_key": [ # A string which maps to an array of values.
186 "A String",
187 ],
188 },
189 "name": "A String", # The call set name.
190 "created": "A String", # The date this call set was created in milliseconds from the epoch.
191 "sampleId": "A String", # The sample ID this call set corresponds to.
192 "variantSetIds": [ # The IDs of the variant sets this call set belongs to.
193 "A String",
194 ],
195 "id": "A String", # The Google generated ID of the call set, immutable.
196}
197
198
199Returns:
200 An object of the form:
201
202 { # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set.
203 "info": { # A map of additional call set information.
204 "a_key": [ # A string which maps to an array of values.
205 "A String",
206 ],
207 },
208 "name": "A String", # The call set name.
209 "created": "A String", # The date this call set was created in milliseconds from the epoch.
210 "sampleId": "A String", # The sample ID this call set corresponds to.
211 "variantSetIds": [ # The IDs of the variant sets this call set belongs to.
212 "A String",
213 ],
214 "id": "A String", # The Google generated ID of the call set, immutable.
215 }</pre>
216</div>
217
218<div class="method">
219 <code class="details" id="search">search(body)</code>
220 <pre>Gets a list of call sets matching the criteria.
221
222Implements GlobalAllianceApi.searchCallSets.
223
224Args:
225 body: object, The request body. (required)
226 The object takes the form of:
227
228{ # The call set search request.
229 "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.
230 "variantSetIds": [ # Restrict the query to call sets within the given variant sets. At least one ID must be provided.
231 "A String",
232 ],
233 "name": "A String", # Only return call sets for which a substring of the name matches this string.
234 "pageSize": 42, # The maximum number of call sets to return.
235 }
236
237
238Returns:
239 An object of the form:
240
241 { # The call set search response.
242 "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.
243 "callSets": [ # The list of matching call sets.
244 { # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set.
245 "info": { # A map of additional call set information.
246 "a_key": [ # A string which maps to an array of values.
247 "A String",
248 ],
249 },
250 "name": "A String", # The call set name.
251 "created": "A String", # The date this call set was created in milliseconds from the epoch.
252 "sampleId": "A String", # The sample ID this call set corresponds to.
253 "variantSetIds": [ # The IDs of the variant sets this call set belongs to.
254 "A String",
255 ],
256 "id": "A String", # The Google generated ID of the call set, immutable.
257 },
258 ],
259 }</pre>
260</div>
261
262<div class="method">
263 <code class="details" id="update">update(callSetId, body)</code>
264 <pre>Updates a call set.
265
266Args:
267 callSetId: string, The ID of the call set to be updated. (required)
268 body: object, The request body. (required)
269 The object takes the form of:
270
271{ # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set.
272 "info": { # A map of additional call set information.
273 "a_key": [ # A string which maps to an array of values.
274 "A String",
275 ],
276 },
277 "name": "A String", # The call set name.
278 "created": "A String", # The date this call set was created in milliseconds from the epoch.
279 "sampleId": "A String", # The sample ID this call set corresponds to.
280 "variantSetIds": [ # The IDs of the variant sets this call set belongs to.
281 "A String",
282 ],
283 "id": "A String", # The Google generated ID of the call set, immutable.
284}
285
286
287Returns:
288 An object of the form:
289
290 { # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set.
291 "info": { # A map of additional call set information.
292 "a_key": [ # A string which maps to an array of values.
293 "A String",
294 ],
295 },
296 "name": "A String", # The call set name.
297 "created": "A String", # The date this call set was created in milliseconds from the epoch.
298 "sampleId": "A String", # The sample ID this call set corresponds to.
299 "variantSetIds": [ # The IDs of the variant sets this call set belongs to.
300 "A String",
301 ],
302 "id": "A String", # The Google generated ID of the call set, immutable.
303 }</pre>
304</div>
305
306</body></html>