Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0a471d3d1d3c16eeda1d1a1288f99be9f8027475 / . / docs / dyn / genomics_v1.annotationsets.html
blob: 1a24a9e45b3c3f1284a07fbfaa2543f440293145 [file] [log] [blame]
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -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.annotationsets.html">annotationsets</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>
79<p class="firstline">Creates a new annotation set. Caller must have WRITE permission for the associated dataset. The following fields are required: * datasetId * referenceSetId All other fields may be optionally specified, unless documented as being server-generated (for example, the `id` field).</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(annotationSetId, x__xgafv=None)</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, x__xgafv=None)</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="#search">search(body, x__xgafv=None)</a></code></p>
88<p class="firstline">Searches for annotation sets that match the given criteria. Annotation sets are returned in an unspecified order. This order is consistent, such that two queries for the same content (regardless of page size) yield annotation sets in the same order across their respective streams of paginated responses. Caller must have READ permission for the queried datasets.</p>
89<p class="toc_element">
90 <code><a href="#update">update(annotationSetId, body, x__xgafv=None, updateMask=None)</a></code></p>
91<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>
92<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="create">create(body, x__xgafv=None)</code>
95 <pre>Creates a new annotation set. Caller must have WRITE permission for the associated dataset. The following fields are required: * datasetId * referenceSetId All other fields may be optionally specified, unless documented as being server-generated (for example, the `id` field).
96
97Args:
98 body: object, The request body. (required)
99 The object takes the form of:
100
101{ # An annotation set is a logical grouping of annotations that share consistent type information and provenance. Examples of annotation sets include 'all genes from refseq', and 'all variant annotations from ClinVar'.
102 "info": { # A map of additional read alignment 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 display name for this annotation set.
108 "sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
109 "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations.
110 "type": "A String", # The type of annotations contained within this set.
111 "id": "A String", # The server-generated annotation set ID, unique across all annotation sets.
112 "datasetId": "A String", # The dataset to which this annotation set belongs.
113}
114
115 x__xgafv: string, V1 error format.
116
117Returns:
118 An object of the form:
119
120 { # An annotation set is a logical grouping of annotations that share consistent type information and provenance. Examples of annotation sets include 'all genes from refseq', and 'all variant annotations from ClinVar'.
121 "info": { # A map of additional read alignment information. This must be of the form map (string key mapping to a list of string values).
122 "a_key": [
123 "",
124 ],
125 },
126 "name": "A String", # The display name for this annotation set.
127 "sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
128 "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations.
129 "type": "A String", # The type of annotations contained within this set.
130 "id": "A String", # The server-generated annotation set ID, unique across all annotation sets.
131 "datasetId": "A String", # The dataset to which this annotation set belongs.
132 }</pre>
133</div>
134
135<div class="method">
136 <code class="details" id="delete">delete(annotationSetId, x__xgafv=None)</code>
137 <pre>Deletes an annotation set. Caller must have WRITE permission for the associated annotation set.
138
139Args:
140 annotationSetId: string, The ID of the annotation set to be deleted. (required)
141 x__xgafv: string, V1 error format.
142
143Returns:
144 An object of the form:
145
146 { # 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 `{}`.
147 }</pre>
148</div>
149
150<div class="method">
151 <code class="details" id="get">get(annotationSetId, x__xgafv=None)</code>
152 <pre>Gets an annotation set. Caller must have READ permission for the associated dataset.
153
154Args:
155 annotationSetId: string, The ID of the annotation set to be retrieved. (required)
156 x__xgafv: string, V1 error format.
157
158Returns:
159 An object of the form:
160
161 { # An annotation set is a logical grouping of annotations that share consistent type information and provenance. Examples of annotation sets include 'all genes from refseq', and 'all variant annotations from ClinVar'.
162 "info": { # A map of additional read alignment information. This must be of the form map (string key mapping to a list of string values).
163 "a_key": [
164 "",
165 ],
166 },
167 "name": "A String", # The display name for this annotation set.
168 "sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
169 "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations.
170 "type": "A String", # The type of annotations contained within this set.
171 "id": "A String", # The server-generated annotation set ID, unique across all annotation sets.
172 "datasetId": "A String", # The dataset to which this annotation set belongs.
173 }</pre>
174</div>
175
176<div class="method">
177 <code class="details" id="search">search(body, x__xgafv=None)</code>
178 <pre>Searches for annotation sets that match the given criteria. Annotation sets are returned in an unspecified order. This order is consistent, such that two queries for the same content (regardless of page size) yield annotation sets in the same order across their respective streams of paginated responses. Caller must have READ permission for the queried datasets.
179
180Args:
181 body: object, The request body. (required)
182 The object takes the form of:
183
184{
185 "name": "A String", # Only return annotations sets for which a substring of the name matches this string (case insensitive).
186 "pageSize": 42, # The maximum number of results to return in a single page. If unspecified, defaults to 128. The maximum value is 1024.
187 "datasetIds": [ # Required. The dataset IDs to search within. Caller must have `READ` access to these datasets.
188 "A String",
189 ],
190 "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.
191 "referenceSetId": "A String", # If specified, only annotation sets associated with the given reference set are returned.
192 "types": [ # If specified, only annotation sets that have any of these types are returned.
193 "A String",
194 ],
195 }
196
197 x__xgafv: string, V1 error format.
198
199Returns:
200 An object of the form:
201
202 {
203 "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.
204 "annotationSets": [ # The matching annotation sets.
205 { # An annotation set is a logical grouping of annotations that share consistent type information and provenance. Examples of annotation sets include 'all genes from refseq', and 'all variant annotations from ClinVar'.
206 "info": { # A map of additional read alignment information. This must be of the form map (string key mapping to a list of string values).
207 "a_key": [
208 "",
209 ],
210 },
211 "name": "A String", # The display name for this annotation set.
212 "sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
213 "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations.
214 "type": "A String", # The type of annotations contained within this set.
215 "id": "A String", # The server-generated annotation set ID, unique across all annotation sets.
216 "datasetId": "A String", # The dataset to which this annotation set belongs.
217 },
218 ],
219 }</pre>
220</div>
221
222<div class="method">
223 <code class="details" id="update">update(annotationSetId, body, x__xgafv=None, updateMask=None)</code>
224 <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.
225
226Args:
227 annotationSetId: string, The ID of the annotation set to be updated. (required)
228 body: object, The request body. (required)
229 The object takes the form of:
230
231{ # An annotation set is a logical grouping of annotations that share consistent type information and provenance. Examples of annotation sets include 'all genes from refseq', and 'all variant annotations from ClinVar'.
232 "info": { # A map of additional read alignment information. This must be of the form map (string key mapping to a list of string values).
233 "a_key": [
234 "",
235 ],
236 },
237 "name": "A String", # The display name for this annotation set.
238 "sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
239 "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations.
240 "type": "A String", # The type of annotations contained within this set.
241 "id": "A String", # The server-generated annotation set ID, unique across all annotation sets.
242 "datasetId": "A String", # The dataset to which this annotation set belongs.
243}
244
245 x__xgafv: string, V1 error format.
246 updateMask: string, An optional mask specifying which fields to update. Mutable fields are name, source_uri, and info. If unspecified, all mutable fields will be updated.
247
248Returns:
249 An object of the form:
250
251 { # An annotation set is a logical grouping of annotations that share consistent type information and provenance. Examples of annotation sets include 'all genes from refseq', and 'all variant annotations from ClinVar'.
252 "info": { # A map of additional read alignment information. This must be of the form map (string key mapping to a list of string values).
253 "a_key": [
254 "",
255 ],
256 },
257 "name": "A String", # The display name for this annotation set.
258 "sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
259 "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations.
260 "type": "A String", # The type of annotations contained within this set.
261 "id": "A String", # The server-generated annotation set ID, unique across all annotation sets.
262 "datasetId": "A String", # The dataset to which this annotation set belongs.
263 }</pre>
264</div>
265
266</body></html>