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