Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0669410c6b2c48884ae31671b9d710a9ff6346c6 / . / docs / dyn / genomics_v1.datasets.html
blob: 14ca86cfa0b127575f0250125ea880d855cd8428 [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.datasets.html">datasets</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 dataset.</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(datasetId, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes a dataset.</p>
83<p class="toc_element">
84 <code><a href="#get">get(datasetId, x__xgafv=None)</a></code></p>
85<p class="firstline">Gets a dataset by ID.</p>
86<p class="toc_element">
87 <code><a href="#getIamPolicy">getIamPolicy(resource, body, x__xgafv=None)</a></code></p>
88<p class="firstline"></p>
89<p class="toc_element">
90 <code><a href="#list">list(pageSize=None, projectId=None, pageToken=None, x__xgafv=None)</a></code></p>
91<p class="firstline">Lists datasets within a project.</p>
92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
96 <code><a href="#patch">patch(datasetId, body, updateMask=None, x__xgafv=None)</a></code></p>
97<p class="firstline">Updates a dataset. This method supports patch semantics.</p>
98<p class="toc_element">
99 <code><a href="#setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</a></code></p>
100<p class="firstline"></p>
101<p class="toc_element">
102 <code><a href="#testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</a></code></p>
103<p class="firstline"></p>
104<p class="toc_element">
105 <code><a href="#undelete">undelete(datasetId, body, x__xgafv=None)</a></code></p>
106<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>
107<h3>Method Details</h3>
108<div class="method">
109 <code class="details" id="create">create(body, x__xgafv=None)</code>
110 <pre>Creates a new dataset.
111
112Args:
113 body: object, The request body. (required)
114 The object takes the form of:
115
116{ # A Dataset is a collection of genomic data.
117 "projectId": "A String", # The Google Developers Console project ID that this dataset belongs to.
118 "id": "A String", # The server-generated dataset ID, unique across all datasets.
119 "createTime": "A String", # The time this dataset was created, in seconds from the epoch.
120 "name": "A String", # The dataset name.
121}
122
123 x__xgafv: string, V1 error format.
124
125Returns:
126 An object of the form:
127
128 { # A Dataset is a collection of genomic data.
129 "projectId": "A String", # The Google Developers Console project ID that this dataset belongs to.
130 "id": "A String", # The server-generated dataset ID, unique across all datasets.
131 "createTime": "A String", # The time this dataset was created, in seconds from the epoch.
132 "name": "A String", # The dataset name.
133 }</pre>
134</div>
135
136<div class="method">
137 <code class="details" id="delete">delete(datasetId, x__xgafv=None)</code>
138 <pre>Deletes a dataset.
139
140Args:
141 datasetId: string, The ID of the dataset to be deleted. (required)
142 x__xgafv: string, V1 error format.
143
144Returns:
145 An object of the form:
146
147 { # 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 `{}`.
148 }</pre>
149</div>
150
151<div class="method">
152 <code class="details" id="get">get(datasetId, x__xgafv=None)</code>
153 <pre>Gets a dataset by ID.
154
155Args:
156 datasetId: string, The ID of the dataset. (required)
157 x__xgafv: string, V1 error format.
158
159Returns:
160 An object of the form:
161
162 { # A Dataset is a collection of genomic data.
163 "projectId": "A String", # The Google Developers Console project ID that this dataset belongs to.
164 "id": "A String", # The server-generated dataset ID, unique across all datasets.
165 "createTime": "A String", # The time this dataset was created, in seconds from the epoch.
166 "name": "A String", # The dataset name.
167 }</pre>
168</div>
169
170<div class="method">
171 <code class="details" id="getIamPolicy">getIamPolicy(resource, body, x__xgafv=None)</code>
172 <pre>
173
174Args:
175 resource: string, REQUIRED: The resource for which policy is being specified. Format is `datasets/`. (required)
176 body: object, The request body. (required)
177 The object takes the form of:
178
179{ # Request message for `GetIamPolicy` method.
180 }
181
182 x__xgafv: string, V1 error format.
183
184Returns:
185 An object of the form:
186
187 { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com"] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
188 "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
189 { # Associates `members` with a `role`.
190 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
191 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following formats: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
192 "A String",
193 ],
194 },
195 ],
196 "version": 42, # Version of the `Policy`. The default version is 0.
197 "etag": "A String", # Can be used to perform a read-modify-write.
198 }</pre>
199</div>
200
201<div class="method">
202 <code class="details" id="list">list(pageSize=None, projectId=None, pageToken=None, x__xgafv=None)</code>
203 <pre>Lists datasets within a project.
204
205Args:
206 pageSize: integer, The maximum number of results returned by this request. If unspecified, defaults to 50. The maximum value is 1024.
207 projectId: string, Required. The project to list datasets for.
208 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.
209 x__xgafv: string, V1 error format.
210
211Returns:
212 An object of the form:
213
214 { # The dataset list response.
215 "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.
216 "datasets": [ # The list of matching Datasets.
217 { # A Dataset is a collection of genomic data.
218 "projectId": "A String", # The Google Developers Console project ID that this dataset belongs to.
219 "id": "A String", # The server-generated dataset ID, unique across all datasets.
220 "createTime": "A String", # The time this dataset was created, in seconds from the epoch.
221 "name": "A String", # The dataset name.
222 },
223 ],
224 }</pre>
225</div>
226
227<div class="method">
228 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
229 <pre>Retrieves the next page of results.
230
231Args:
232 previous_request: The request for the previous page. (required)
233 previous_response: The response from the request for the previous page. (required)
234
235Returns:
236 A request object that you can call 'execute()' on to request the next
237 page. Returns None if there are no more items in the collection.
238 </pre>
239</div>
240
241<div class="method">
242 <code class="details" id="patch">patch(datasetId, body, updateMask=None, x__xgafv=None)</code>
243 <pre>Updates a dataset. This method supports patch semantics.
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 ID that this dataset belongs to.
252 "id": "A String", # The server-generated dataset ID, unique across all datasets.
253 "createTime": "A String", # The time this dataset was created, in seconds from the epoch.
254 "name": "A String", # The dataset name.
255}
256
257 updateMask: string, An optional mask specifying which fields to update. At this time, the only mutable field is [name][google.genomics.v1.Dataset.name]. The only acceptable value is "name". If unspecified, all mutable fields will be updated.
258 x__xgafv: string, V1 error format.
259
260Returns:
261 An object of the form:
262
263 { # A Dataset is a collection of genomic data.
264 "projectId": "A String", # The Google Developers Console project ID that this dataset belongs to.
265 "id": "A String", # The server-generated dataset ID, unique across all datasets.
266 "createTime": "A String", # The time this dataset was created, in seconds from the epoch.
267 "name": "A String", # The dataset name.
268 }</pre>
269</div>
270
271<div class="method">
272 <code class="details" id="setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</code>
273 <pre>
274
275Args:
276 resource: string, REQUIRED: The resource for which policy is being specified. Format is `datasets/`. (required)
277 body: object, The request body. (required)
278 The object takes the form of:
279
280{ # Request message for `SetIamPolicy` method.
281 "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com"] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
282 "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
283 { # Associates `members` with a `role`.
284 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
285 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following formats: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
286 "A String",
287 ],
288 },
289 ],
290 "version": 42, # Version of the `Policy`. The default version is 0.
291 "etag": "A String", # Can be used to perform a read-modify-write.
292 },
293 }
294
295 x__xgafv: string, V1 error format.
296
297Returns:
298 An object of the form:
299
300 { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com"] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
301 "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
302 { # Associates `members` with a `role`.
303 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
304 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following formats: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
305 "A String",
306 ],
307 },
308 ],
309 "version": 42, # Version of the `Policy`. The default version is 0.
310 "etag": "A String", # Can be used to perform a read-modify-write.
311 }</pre>
312</div>
313
314<div class="method">
315 <code class="details" id="testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</code>
316 <pre>
317
318Args:
319 resource: string, REQUIRED: The resource for which policy is being specified. Format is `datasets/`. (required)
320 body: object, The request body. (required)
321 The object takes the form of:
322
323{ # Request message for `TestIamPermissions` method.
324 "permissions": [ # REQUIRED: The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. Allowed permissions are: * `genomics.datasets.create` * `genomics.datasets.delete` * `genomics.datasets.get` * `genomics.datasets.list` * `genomics.datasets.update` * `genomics.datasets.getIamPolicy` * `genomics.datasets.setIamPolicy`
325 "A String",
326 ],
327 }
328
329 x__xgafv: string, V1 error format.
330
331Returns:
332 An object of the form:
333
334 { # Response message for `TestIamPermissions` method.
335 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
336 "A String",
337 ],
338 }</pre>
339</div>
340
341<div class="method">
342 <code class="details" id="undelete">undelete(datasetId, body, x__xgafv=None)</code>
343 <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.
344
345Args:
346 datasetId: string, The ID of the dataset to be undeleted. (required)
347 body: object, The request body. (required)
348 The object takes the form of:
349
350{
351 }
352
353 x__xgafv: string, V1 error format.
354
355Returns:
356 An object of the form:
357
358 { # A Dataset is a collection of genomic data.
359 "projectId": "A String", # The Google Developers Console project ID that this dataset belongs to.
360 "id": "A String", # The server-generated dataset ID, unique across all datasets.
361 "createTime": "A String", # The time this dataset was created, in seconds from the epoch.
362 "name": "A String", # The dataset name.
363 }</pre>
364</div>
365
366</body></html>