1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="genomics_v1beta2.html">Genomics API</a> . <a href="genomics_v1beta2.datasets.html">datasets</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#create">create(body)</a></code></p>
<p class="firstline">Creates a new dataset.</p>
<p class="toc_element">
<code><a href="#delete">delete(datasetId)</a></code></p>
<p class="firstline">Deletes a dataset and all of its contents (all read group sets, reference sets, variant sets, call sets, annotation sets, etc.) This is reversible (up to one week after the deletion) via the UndeleteDataset operation.</p>
<p class="toc_element">
<code><a href="#get">get(datasetId)</a></code></p>
<p class="firstline">Gets a dataset by ID.</p>
<p class="toc_element">
<code><a href="#list">list(pageToken=None, projectNumber=None, pageSize=None)</a></code></p>
<p class="firstline">Lists datasets within a project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(datasetId, body)</a></code></p>
<p class="firstline">Updates a dataset. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#undelete">undelete(datasetId)</a></code></p>
<p class="firstline">Undeletes a dataset by restoring a dataset which was deleted via this API. This operation is only possible for a week after the deletion occurred.</p>
<p class="toc_element">
<code><a href="#update">update(datasetId, body)</a></code></p>
<p class="firstline">Updates a dataset.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(body)</code>
<pre>Creates a new dataset.
Args:
body: object, The request body. (required)
The object takes the form of:
{ # A Dataset is a collection of genomic data.
"isPublic": True or False, # Flag indicating whether or not a dataset is publicly viewable. If a dataset is not public, it inherits viewing permissions from its project.
"projectNumber": "A String", # The Google Developers Console project number that this dataset belongs to.
"createTime": "A String", # The time this dataset was created, in seconds from the epoch.
"name": "A String", # The dataset name.
"id": "A String", # The Google generated ID of the dataset, immutable.
}
Returns:
An object of the form:
{ # A Dataset is a collection of genomic data.
"isPublic": True or False, # Flag indicating whether or not a dataset is publicly viewable. If a dataset is not public, it inherits viewing permissions from its project.
"projectNumber": "A String", # The Google Developers Console project number that this dataset belongs to.
"createTime": "A String", # The time this dataset was created, in seconds from the epoch.
"name": "A String", # The dataset name.
"id": "A String", # The Google generated ID of the dataset, immutable.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(datasetId)</code>
<pre>Deletes a dataset and all of its contents (all read group sets, reference sets, variant sets, call sets, annotation sets, etc.) This is reversible (up to one week after the deletion) via the UndeleteDataset operation.
Args:
datasetId: string, The ID of the dataset to be deleted. (required)
</pre>
</div>
<div class="method">
<code class="details" id="get">get(datasetId)</code>
<pre>Gets a dataset by ID.
Args:
datasetId: string, The ID of the dataset. (required)
Returns:
An object of the form:
{ # A Dataset is a collection of genomic data.
"isPublic": True or False, # Flag indicating whether or not a dataset is publicly viewable. If a dataset is not public, it inherits viewing permissions from its project.
"projectNumber": "A String", # The Google Developers Console project number that this dataset belongs to.
"createTime": "A String", # The time this dataset was created, in seconds from the epoch.
"name": "A String", # The dataset name.
"id": "A String", # The Google generated ID of the dataset, immutable.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(pageToken=None, projectNumber=None, pageSize=None)</code>
<pre>Lists datasets within a project.
Args:
pageToken: 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.
projectNumber: string, Required. The project to list datasets for.
pageSize: integer, The maximum number of results to return in a single page. If unspecified, defaults to 50. The maximum value is 1024.
Returns:
An object of the form:
{ # The dataset list response.
"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.
"datasets": [ # The list of matching Datasets.
{ # A Dataset is a collection of genomic data.
"isPublic": True or False, # Flag indicating whether or not a dataset is publicly viewable. If a dataset is not public, it inherits viewing permissions from its project.
"projectNumber": "A String", # The Google Developers Console project number that this dataset belongs to.
"createTime": "A String", # The time this dataset was created, in seconds from the epoch.
"name": "A String", # The dataset name.
"id": "A String", # The Google generated ID of the dataset, immutable.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(datasetId, body)</code>
<pre>Updates a dataset. This method supports patch semantics.
Args:
datasetId: string, The ID of the dataset to be updated. (required)
body: object, The request body. (required)
The object takes the form of:
{ # A Dataset is a collection of genomic data.
"isPublic": True or False, # Flag indicating whether or not a dataset is publicly viewable. If a dataset is not public, it inherits viewing permissions from its project.
"projectNumber": "A String", # The Google Developers Console project number that this dataset belongs to.
"createTime": "A String", # The time this dataset was created, in seconds from the epoch.
"name": "A String", # The dataset name.
"id": "A String", # The Google generated ID of the dataset, immutable.
}
Returns:
An object of the form:
{ # A Dataset is a collection of genomic data.
"isPublic": True or False, # Flag indicating whether or not a dataset is publicly viewable. If a dataset is not public, it inherits viewing permissions from its project.
"projectNumber": "A String", # The Google Developers Console project number that this dataset belongs to.
"createTime": "A String", # The time this dataset was created, in seconds from the epoch.
"name": "A String", # The dataset name.
"id": "A String", # The Google generated ID of the dataset, immutable.
}</pre>
</div>
<div class="method">
<code class="details" id="undelete">undelete(datasetId)</code>
<pre>Undeletes a dataset by restoring a dataset which was deleted via this API. This operation is only possible for a week after the deletion occurred.
Args:
datasetId: string, The ID of the dataset to be undeleted. (required)
Returns:
An object of the form:
{ # A Dataset is a collection of genomic data.
"isPublic": True or False, # Flag indicating whether or not a dataset is publicly viewable. If a dataset is not public, it inherits viewing permissions from its project.
"projectNumber": "A String", # The Google Developers Console project number that this dataset belongs to.
"createTime": "A String", # The time this dataset was created, in seconds from the epoch.
"name": "A String", # The dataset name.
"id": "A String", # The Google generated ID of the dataset, immutable.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(datasetId, body)</code>
<pre>Updates a dataset.
Args:
datasetId: string, The ID of the dataset to be updated. (required)
body: object, The request body. (required)
The object takes the form of:
{ # A Dataset is a collection of genomic data.
"isPublic": True or False, # Flag indicating whether or not a dataset is publicly viewable. If a dataset is not public, it inherits viewing permissions from its project.
"projectNumber": "A String", # The Google Developers Console project number that this dataset belongs to.
"createTime": "A String", # The time this dataset was created, in seconds from the epoch.
"name": "A String", # The dataset name.
"id": "A String", # The Google generated ID of the dataset, immutable.
}
Returns:
An object of the form:
{ # A Dataset is a collection of genomic data.
"isPublic": True or False, # Flag indicating whether or not a dataset is publicly viewable. If a dataset is not public, it inherits viewing permissions from its project.
"projectNumber": "A String", # The Google Developers Console project number that this dataset belongs to.
"createTime": "A String", # The time this dataset was created, in seconds from the epoch.
"name": "A String", # The dataset name.
"id": "A String", # The Google generated ID of the dataset, immutable.
}</pre>
</div>
</body></html>
|
