Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 860a6378c538d8e2e424c7be150b41ba28120387 / . / docs / dyn / genomics_v1.callsets.html
blob: 01de614573b511a26d8bcb358cffd05a6356675b [file] [log] [blame]
Takashi Matsuo06694102015-09-11 13:55:40 -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_v1.html">Genomics API</a> . <a href="genomics_v1.callsets.html">callsets</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#create">create(body, x__xgafv=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]79<p class="firstline">Creates a new call set. For the definitions of call sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]80<p class="toc_element">
81 <code><a href="#delete">delete(callSetId, x__xgafv=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]82<p class="firstline">Deletes a call set. For the definitions of call sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]83<p class="toc_element">
84 <code><a href="#get">get(callSetId, x__xgafv=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]85<p class="firstline">Gets a call set by ID. For the definitions of call sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]86<p class="toc_element">
87 <code><a href="#patch">patch(callSetId, body, updateMask=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]88<p class="firstline">Updates a call set. For the definitions of call sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) This method supports patch semantics.</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]89<p class="toc_element">
90 <code><a href="#search">search(body, x__xgafv=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]91<p class="firstline">Gets a list of call sets matching the criteria. For the definitions of call sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Implements [GlobalAllianceApi.searchCallSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L178).</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]92<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="create">create(body, x__xgafv=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]95 <pre>Creates a new call set. For the definitions of call sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]96
97Args:
98 body: object, The request body. (required)
99 The object takes the form of:
100
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]101{ # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]102 "info": { # A map of additional call set information. This must be of the form map (string key mapping to a list of string values).
103 "a_key": [
104 "",
105 ],
106 },
107 "name": "A String", # The call set name.
108 "created": "A String", # The date this call set was created in milliseconds from the epoch.
109 "sampleId": "A String", # The sample ID this call set corresponds to.
110 "variantSetIds": [ # The IDs of the variant sets this call set belongs to. This field must have exactly length one, as a call set belongs to a single variant set. This field is repeated for compatibility with the [GA4GH 0.5.1 API](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variants.avdl#L76).
111 "A String",
112 ],
113 "id": "A String", # The server-generated call set ID, unique across all call sets.
114}
115
116 x__xgafv: string, V1 error format.
117
118Returns:
119 An object of the form:
120
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]121 { # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]122 "info": { # A map of additional call set information. This must be of the form map (string key mapping to a list of string values).
123 "a_key": [
124 "",
125 ],
126 },
127 "name": "A String", # The call set name.
128 "created": "A String", # The date this call set was created in milliseconds from the epoch.
129 "sampleId": "A String", # The sample ID this call set corresponds to.
130 "variantSetIds": [ # The IDs of the variant sets this call set belongs to. This field must have exactly length one, as a call set belongs to a single variant set. This field is repeated for compatibility with the [GA4GH 0.5.1 API](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variants.avdl#L76).
131 "A String",
132 ],
133 "id": "A String", # The server-generated call set ID, unique across all call sets.
134 }</pre>
135</div>
136
137<div class="method">
138 <code class="details" id="delete">delete(callSetId, x__xgafv=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]139 <pre>Deletes a call set. For the definitions of call sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]140
141Args:
142 callSetId: string, The ID of the call set to be deleted. (required)
143 x__xgafv: string, V1 error format.
144
145Returns:
146 An object of the form:
147
148 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
149 }</pre>
150</div>
151
152<div class="method">
153 <code class="details" id="get">get(callSetId, x__xgafv=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]154 <pre>Gets a call set by ID. For the definitions of call sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]155
156Args:
157 callSetId: string, The ID of the call set. (required)
158 x__xgafv: string, V1 error format.
159
160Returns:
161 An object of the form:
162
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]163 { # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]164 "info": { # A map of additional call set information. This must be of the form map (string key mapping to a list of string values).
165 "a_key": [
166 "",
167 ],
168 },
169 "name": "A String", # The call set name.
170 "created": "A String", # The date this call set was created in milliseconds from the epoch.
171 "sampleId": "A String", # The sample ID this call set corresponds to.
172 "variantSetIds": [ # The IDs of the variant sets this call set belongs to. This field must have exactly length one, as a call set belongs to a single variant set. This field is repeated for compatibility with the [GA4GH 0.5.1 API](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variants.avdl#L76).
173 "A String",
174 ],
175 "id": "A String", # The server-generated call set ID, unique across all call sets.
176 }</pre>
177</div>
178
179<div class="method">
180 <code class="details" id="patch">patch(callSetId, body, updateMask=None, x__xgafv=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]181 <pre>Updates a call set. For the definitions of call sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) This method supports patch semantics.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]182
183Args:
184 callSetId: string, The ID of the call set to be updated. (required)
185 body: object, The request body. (required)
186 The object takes the form of:
187
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]188{ # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]189 "info": { # A map of additional call set information. This must be of the form map (string key mapping to a list of string values).
190 "a_key": [
191 "",
192 ],
193 },
194 "name": "A String", # The call set name.
195 "created": "A String", # The date this call set was created in milliseconds from the epoch.
196 "sampleId": "A String", # The sample ID this call set corresponds to.
197 "variantSetIds": [ # The IDs of the variant sets this call set belongs to. This field must have exactly length one, as a call set belongs to a single variant set. This field is repeated for compatibility with the [GA4GH 0.5.1 API](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variants.avdl#L76).
198 "A String",
199 ],
200 "id": "A String", # The server-generated call set ID, unique across all call sets.
201}
202
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]203 updateMask: string, An optional mask specifying which fields to update. At this time, the only mutable field is name. The only acceptable value is "name". If unspecified, all mutable fields will be updated.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]204 x__xgafv: string, V1 error format.
205
206Returns:
207 An object of the form:
208
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]209 { # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]210 "info": { # A map of additional call set information. This must be of the form map (string key mapping to a list of string values).
211 "a_key": [
212 "",
213 ],
214 },
215 "name": "A String", # The call set name.
216 "created": "A String", # The date this call set was created in milliseconds from the epoch.
217 "sampleId": "A String", # The sample ID this call set corresponds to.
218 "variantSetIds": [ # The IDs of the variant sets this call set belongs to. This field must have exactly length one, as a call set belongs to a single variant set. This field is repeated for compatibility with the [GA4GH 0.5.1 API](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variants.avdl#L76).
219 "A String",
220 ],
221 "id": "A String", # The server-generated call set ID, unique across all call sets.
222 }</pre>
223</div>
224
225<div class="method">
226 <code class="details" id="search">search(body, x__xgafv=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]227 <pre>Gets a list of call sets matching the criteria. For the definitions of call sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Implements [GlobalAllianceApi.searchCallSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L178).
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]228
229Args:
230 body: object, The request body. (required)
231 The object takes the form of:
232
233{ # The call set search request.
234 "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.
235 "variantSetIds": [ # Restrict the query to call sets within the given variant sets. At least one ID must be provided.
236 "A String",
237 ],
238 "name": "A String", # Only return call sets for which a substring of the name matches this string.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]239 "pageSize": 42, # The maximum number of results to return in a single page. If unspecified, defaults to 1024.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]240 }
241
242 x__xgafv: string, V1 error format.
243
244Returns:
245 An object of the form:
246
247 { # The call set search response.
248 "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.
249 "callSets": [ # The list of matching call sets.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]250 { # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]251 "info": { # A map of additional call set information. This must be of the form map (string key mapping to a list of string values).
252 "a_key": [
253 "",
254 ],
255 },
256 "name": "A String", # The call set name.
257 "created": "A String", # The date this call set was created in milliseconds from the epoch.
258 "sampleId": "A String", # The sample ID this call set corresponds to.
259 "variantSetIds": [ # The IDs of the variant sets this call set belongs to. This field must have exactly length one, as a call set belongs to a single variant set. This field is repeated for compatibility with the [GA4GH 0.5.1 API](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variants.avdl#L76).
260 "A String",
261 ],
262 "id": "A String", # The server-generated call set ID, unique across all call sets.
263 },
264 ],
265 }</pre>
266</div>
267
268</body></html>