Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / a4ddf955985ebdf2e114171507b38c7b9204093a / . / docs / dyn / genomics_v1beta2.datasets.html
blob: cc075c44f629293b0d245e0b0f49fd36831db507 [file] [log] [blame]
Craig Citroe633be12015-03-02 13:40:36 -0800[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_v1beta2.html">Genomics API</a> . <a href="genomics_v1beta2.datasets.html">datasets</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 dataset.</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(datasetId)</a></code></p>
82<p class="firstline">Deletes a dataset.</p>
83<p class="toc_element">
84 <code><a href="#get">get(datasetId)</a></code></p>
85<p class="firstline">Gets a dataset by ID.</p>
86<p class="toc_element">
87 <code><a href="#list">list(pageToken=None, projectNumber=None, pageSize=None)</a></code></p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]88<p class="firstline">Lists datasets within a project.</p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
93 <code><a href="#patch">patch(datasetId, body)</a></code></p>
94<p class="firstline">Updates a dataset. This method supports patch semantics.</p>
95<p class="toc_element">
96 <code><a href="#undelete">undelete(datasetId)</a></code></p>
97<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>
98<p class="toc_element">
99 <code><a href="#update">update(datasetId, body)</a></code></p>
100<p class="firstline">Updates a dataset.</p>
101<h3>Method Details</h3>
102<div class="method">
103 <code class="details" id="create">create(body)</code>
104 <pre>Creates a new dataset.
105
106Args:
107 body: object, The request body. (required)
108 The object takes the form of:
109
110{ # A Dataset is a collection of genomic data.
111 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]112 "projectNumber": "A String", # The Google Developers Console project number that this dataset belongs to.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]113 "createTime": "A String", # The time this dataset was created, in seconds from the epoch.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]114 "name": "A String", # The dataset name.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]115 "id": "A String", # The Google generated ID of the dataset, immutable.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]116}
117
118
119Returns:
120 An object of the form:
121
122 { # A Dataset is a collection of genomic data.
123 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]124 "projectNumber": "A String", # The Google Developers Console project number that this dataset belongs to.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]125 "createTime": "A String", # The time this dataset was created, in seconds from the epoch.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]126 "name": "A String", # The dataset name.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]127 "id": "A String", # The Google generated ID of the dataset, immutable.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]128 }</pre>
129</div>
130
131<div class="method">
132 <code class="details" id="delete">delete(datasetId)</code>
133 <pre>Deletes a dataset.
134
135Args:
136 datasetId: string, The ID of the dataset to be deleted. (required)
137</pre>
138</div>
139
140<div class="method">
141 <code class="details" id="get">get(datasetId)</code>
142 <pre>Gets a dataset by ID.
143
144Args:
145 datasetId: string, The ID of the dataset. (required)
146
147Returns:
148 An object of the form:
149
150 { # A Dataset is a collection of genomic data.
151 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]152 "projectNumber": "A String", # The Google Developers Console project number that this dataset belongs to.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]153 "createTime": "A String", # The time this dataset was created, in seconds from the epoch.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]154 "name": "A String", # The dataset name.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]155 "id": "A String", # The Google generated ID of the dataset, immutable.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]156 }</pre>
157</div>
158
159<div class="method">
160 <code class="details" id="list">list(pageToken=None, projectNumber=None, pageSize=None)</code>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]161 <pre>Lists datasets within a project.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]162
163Args:
164 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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]165 projectNumber: string, Required. The project to list datasets for.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]166 pageSize: integer, The maximum number of results to return in a single page. If unspecified, defaults to 50. The maximum value is 1024.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]167
168Returns:
169 An object of the form:
170
171 { # The dataset list response.
172 "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.
173 "datasets": [ # The list of matching Datasets.
174 { # A Dataset is a collection of genomic data.
175 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]176 "projectNumber": "A String", # The Google Developers Console project number that this dataset belongs to.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]177 "createTime": "A String", # The time this dataset was created, in seconds from the epoch.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]178 "name": "A String", # The dataset name.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]179 "id": "A String", # The Google generated ID of the dataset, immutable.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]180 },
181 ],
182 }</pre>
183</div>
184
185<div class="method">
186 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
187 <pre>Retrieves the next page of results.
188
189Args:
190 previous_request: The request for the previous page. (required)
191 previous_response: The response from the request for the previous page. (required)
192
193Returns:
194 A request object that you can call 'execute()' on to request the next
195 page. Returns None if there are no more items in the collection.
196 </pre>
197</div>
198
199<div class="method">
200 <code class="details" id="patch">patch(datasetId, body)</code>
201 <pre>Updates a dataset. This method supports patch semantics.
202
203Args:
204 datasetId: string, The ID of the dataset to be updated. (required)
205 body: object, The request body. (required)
206 The object takes the form of:
207
208{ # A Dataset is a collection of genomic data.
209 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]210 "projectNumber": "A String", # The Google Developers Console project number that this dataset belongs to.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]211 "createTime": "A String", # The time this dataset was created, in seconds from the epoch.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]212 "name": "A String", # The dataset name.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]213 "id": "A String", # The Google generated ID of the dataset, immutable.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]214}
215
216
217Returns:
218 An object of the form:
219
220 { # A Dataset is a collection of genomic data.
221 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]222 "projectNumber": "A String", # The Google Developers Console project number that this dataset belongs to.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]223 "createTime": "A String", # The time this dataset was created, in seconds from the epoch.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]224 "name": "A String", # The dataset name.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]225 "id": "A String", # The Google generated ID of the dataset, immutable.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]226 }</pre>
227</div>
228
229<div class="method">
230 <code class="details" id="undelete">undelete(datasetId)</code>
231 <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.
232
233Args:
234 datasetId: string, The ID of the dataset to be undeleted. (required)
235
236Returns:
237 An object of the form:
238
239 { # A Dataset is a collection of genomic data.
240 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]241 "projectNumber": "A String", # The Google Developers Console project number that this dataset belongs to.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]242 "createTime": "A String", # The time this dataset was created, in seconds from the epoch.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]243 "name": "A String", # The dataset name.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]244 "id": "A String", # The Google generated ID of the dataset, immutable.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]245 }</pre>
246</div>
247
248<div class="method">
249 <code class="details" id="update">update(datasetId, body)</code>
250 <pre>Updates a dataset.
251
252Args:
253 datasetId: string, The ID of the dataset to be updated. (required)
254 body: object, The request body. (required)
255 The object takes the form of:
256
257{ # A Dataset is a collection of genomic data.
258 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]259 "projectNumber": "A String", # The Google Developers Console project number that this dataset belongs to.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]260 "createTime": "A String", # The time this dataset was created, in seconds from the epoch.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]261 "name": "A String", # The dataset name.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]262 "id": "A String", # The Google generated ID of the dataset, immutable.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]263}
264
265
266Returns:
267 An object of the form:
268
269 { # A Dataset is a collection of genomic data.
270 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]271 "projectNumber": "A String", # The Google Developers Console project number that this dataset belongs to.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]272 "createTime": "A String", # The time this dataset was created, in seconds from the epoch.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]273 "name": "A String", # The dataset name.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]274 "id": "A String", # The Google generated ID of the dataset, immutable.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]275 }</pre>
276</div>
277
278</body></html>