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