Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 05f19320b0d5d888db81e84d84582fce6daafe6c / . / docs / dyn / genomics_v1beta.datasets.html
blob: 7ab7897cd9c8a159a16a8811a0a423b31b06bf13 [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.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, maxResults=None, projectId=None)</a></code></p>
88<p class="firstline">Lists all datasets.</p>
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 "projectId": "A String", # The Google Developers Console project number that this dataset belongs to.
112 "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.
113 "id": "A String", # The Google generated ID of the dataset, immutable.
114 "name": "A String", # The dataset name.
115}
116
117
118Returns:
119 An object of the form:
120
121 { # A Dataset is a collection of genomic data.
122 "projectId": "A String", # The Google Developers Console project number that this dataset belongs to.
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.
124 "id": "A String", # The Google generated ID of the dataset, immutable.
125 "name": "A String", # The dataset name.
126 }</pre>
127</div>
128
129<div class="method">
130 <code class="details" id="delete">delete(datasetId)</code>
131 <pre>Deletes a dataset.
132
133Args:
134 datasetId: string, The ID of the dataset to be deleted. (required)
135</pre>
136</div>
137
138<div class="method">
139 <code class="details" id="get">get(datasetId)</code>
140 <pre>Gets a dataset by ID.
141
142Args:
143 datasetId: string, The ID of the dataset. (required)
144
145Returns:
146 An object of the form:
147
148 { # A Dataset is a collection of genomic data.
149 "projectId": "A String", # The Google Developers Console project number that this dataset belongs to.
150 "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.
151 "id": "A String", # The Google generated ID of the dataset, immutable.
152 "name": "A String", # The dataset name.
153 }</pre>
154</div>
155
156<div class="method">
157 <code class="details" id="list">list(pageToken=None, maxResults=None, projectId=None)</code>
158 <pre>Lists all datasets.
159
160Args:
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]161 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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]162 maxResults: string, The maximum number of results returned by this request.
Craig Citrobdd05a82014-10-17 20:32:03 -0700[diff] [blame]163 projectId: string, Only return datasets which belong to this Google Developers Console project. Only accepts project numbers. Returns all public projects if no project number is specified.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]164
165Returns:
166 An object of the form:
167
168 { # The dataset list response.
169 "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.
170 "datasets": [ # The list of matching Datasets.
171 { # A Dataset is a collection of genomic data.
172 "projectId": "A String", # The Google Developers Console project number that this dataset belongs to.
173 "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.
174 "id": "A String", # The Google generated ID of the dataset, immutable.
175 "name": "A String", # The dataset name.
176 },
177 ],
178 }</pre>
179</div>
180
181<div class="method">
182 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
183 <pre>Retrieves the next page of results.
184
185Args:
186 previous_request: The request for the previous page. (required)
187 previous_response: The response from the request for the previous page. (required)
188
189Returns:
190 A request object that you can call 'execute()' on to request the next
191 page. Returns None if there are no more items in the collection.
192 </pre>
193</div>
194
195<div class="method">
196 <code class="details" id="patch">patch(datasetId, body)</code>
197 <pre>Updates a dataset. This method supports patch semantics.
198
199Args:
200 datasetId: string, The ID of the dataset to be updated. (required)
201 body: object, The request body. (required)
202 The object takes the form of:
203
204{ # A Dataset is a collection of genomic data.
205 "projectId": "A String", # The Google Developers Console project number that this dataset belongs to.
206 "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.
207 "id": "A String", # The Google generated ID of the dataset, immutable.
208 "name": "A String", # The dataset name.
209}
210
211
212Returns:
213 An object of the form:
214
215 { # A Dataset is a collection of genomic data.
216 "projectId": "A String", # The Google Developers Console project number that this dataset belongs to.
217 "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.
218 "id": "A String", # The Google generated ID of the dataset, immutable.
219 "name": "A String", # The dataset name.
220 }</pre>
221</div>
222
223<div class="method">
224 <code class="details" id="undelete">undelete(datasetId)</code>
225 <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.
226
227Args:
228 datasetId: string, The ID of the dataset to be undeleted. (required)
229
230Returns:
231 An object of the form:
232
233 { # A Dataset is a collection of genomic data.
234 "projectId": "A String", # The Google Developers Console project number that this dataset belongs to.
235 "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.
236 "id": "A String", # The Google generated ID of the dataset, immutable.
237 "name": "A String", # The dataset name.
238 }</pre>
239</div>
240
241<div class="method">
242 <code class="details" id="update">update(datasetId, body)</code>
243 <pre>Updates a dataset.
244
245Args:
246 datasetId: string, The ID of the dataset to be updated. (required)
247 body: object, The request body. (required)
248 The object takes the form of:
249
250{ # A Dataset is a collection of genomic data.
251 "projectId": "A String", # The Google Developers Console project number that this dataset belongs to.
252 "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.
253 "id": "A String", # The Google generated ID of the dataset, immutable.
254 "name": "A String", # The dataset name.
255}
256
257
258Returns:
259 An object of the form:
260
261 { # A Dataset is a collection of genomic data.
262 "projectId": "A String", # The Google Developers Console project number that this dataset belongs to.
263 "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.
264 "id": "A String", # The Google generated ID of the dataset, immutable.
265 "name": "A String", # The dataset name.
266 }</pre>
267</div>
268
269</body></html>