Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / d059ad881c7ae58c67931c48788d0bd7343ab16c / . / docs / dyn / genomics_v1.datasets.html
blob: 9779121ef9509300dca58e5602b8a5528702731a [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>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]79<p class="firstline">Creates a new dataset.</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]80<p class="toc_element">
81 <code><a href="#delete">delete(datasetId, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]82<p class="firstline">Deletes a dataset and all of its contents (all read group sets,</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]83<p class="toc_element">
84 <code><a href="#get">get(datasetId, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]85<p class="firstline">Gets a dataset by ID.</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]86<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]87 <code><a href="#getIamPolicy">getIamPolicy(resource, body, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]88<p class="firstline">Gets the access control policy for the dataset. This is empty if the</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]89<p class="toc_element">
90 <code><a href="#list">list(pageSize=None, projectId=None, pageToken=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]91<p class="firstline">Lists datasets within a project.</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]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>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]97<p class="firstline">Updates a dataset.</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]98<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]99 <code><a href="#setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]100<p class="firstline">Sets the access control policy on the specified dataset. Replaces any</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]101<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]102 <code><a href="#testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]103<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]104<p class="toc_element">
105 <code><a href="#undelete">undelete(datasetId, body, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]106<p class="firstline">Undeletes a dataset by restoring a dataset which was deleted via this API.</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]107<h3>Method Details</h3>
108<div class="method">
109 <code class="details" id="create">create(body, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]110 <pre>Creates a new dataset.
111
112For the definitions of datasets and other genomics resources, see
113[Fundamentals of Google
114Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]115
116Args:
117 body: object, The request body. (required)
118 The object takes the form of:
119
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]120{ # A Dataset is a collection of genomic data.
121 #
122 # For more genomics resource definitions, see [Fundamentals of Google
123 # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]124 "projectId": "A String", # The Google Cloud project ID that this dataset belongs to.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]125 "id": "A String", # The server-generated dataset ID, unique across all datasets.
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]126 "name": "A String", # The dataset name.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]127 "createTime": "A String", # The time this dataset was created, in seconds from the epoch.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]128}
129
130 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]131 Allowed values
132 1 - v1 error format
133 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]134
135Returns:
136 An object of the form:
137
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]138 { # A Dataset is a collection of genomic data.
139 #
140 # For more genomics resource definitions, see [Fundamentals of Google
141 # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]142 "projectId": "A String", # The Google Cloud project ID that this dataset belongs to.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]143 "id": "A String", # The server-generated dataset ID, unique across all datasets.
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]144 "name": "A String", # The dataset name.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]145 "createTime": "A String", # The time this dataset was created, in seconds from the epoch.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]146 }</pre>
147</div>
148
149<div class="method">
150 <code class="details" id="delete">delete(datasetId, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]151 <pre>Deletes a dataset and all of its contents (all read group sets,
152reference sets, variant sets, call sets, annotation sets, etc.)
153This is reversible (up to one week after the deletion) via
154the
155datasets.undelete
156operation.
157
158For the definitions of datasets and other genomics resources, see
159[Fundamentals of Google
160Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]161
162Args:
163 datasetId: string, The ID of the dataset to be deleted. (required)
164 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]165 Allowed values
166 1 - v1 error format
167 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]168
169Returns:
170 An object of the form:
171
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]172 { # A generic empty message that you can re-use to avoid defining duplicated
173 # empty messages in your APIs. A typical example is to use it as the request
174 # or the response type of an API method. For instance:
175 #
176 # service Foo {
177 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
178 # }
179 #
180 # The JSON representation for `Empty` is empty JSON object `{}`.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]181 }</pre>
182</div>
183
184<div class="method">
185 <code class="details" id="get">get(datasetId, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]186 <pre>Gets a dataset by ID.
187
188For the definitions of datasets and other genomics resources, see
189[Fundamentals of Google
190Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]191
192Args:
193 datasetId: string, The ID of the dataset. (required)
194 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]195 Allowed values
196 1 - v1 error format
197 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]198
199Returns:
200 An object of the form:
201
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]202 { # A Dataset is a collection of genomic data.
203 #
204 # For more genomics resource definitions, see [Fundamentals of Google
205 # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]206 "projectId": "A String", # The Google Cloud project ID that this dataset belongs to.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]207 "id": "A String", # The server-generated dataset ID, unique across all datasets.
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]208 "name": "A String", # The dataset name.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]209 "createTime": "A String", # The time this dataset was created, in seconds from the epoch.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]210 }</pre>
211</div>
212
213<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]214 <code class="details" id="getIamPolicy">getIamPolicy(resource, body, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]215 <pre>Gets the access control policy for the dataset. This is empty if the
216policy or resource does not exist.
217
218See <a href="/iam/docs/managing-policies#getting_a_policy">Getting a
219Policy</a> for more information.
220
221For the definitions of datasets and other genomics resources, see
222[Fundamentals of Google
223Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]224
225Args:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]226 resource: string, REQUIRED: The resource for which policy is being specified. Format is
227`datasets/<dataset ID>`. (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]228 body: object, The request body. (required)
229 The object takes the form of:
230
231{ # Request message for `GetIamPolicy` method.
232 }
233
234 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]235 Allowed values
236 1 - v1 error format
237 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]238
239Returns:
240 An object of the form:
241
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]242 { # Defines an Identity and Access Management (IAM) policy. It is used to
243 # specify access control policies for Cloud Platform resources.
244 #
245 #
246 # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
247 # `members` to a `role`, where the members can be user accounts, Google groups,
248 # Google domains, and service accounts. A `role` is a named list of permissions
249 # defined by IAM.
250 #
251 # **Example**
252 #
253 # {
254 # "bindings": [
255 # {
256 # "role": "roles/owner",
257 # "members": [
258 # "user:mike@example.com",
259 # "group:admins@example.com",
260 # "domain:google.com",
261 # "serviceAccount:my-other-app@appspot.gserviceaccount.com",
262 # ]
263 # },
264 # {
265 # "role": "roles/viewer",
266 # "members": ["user:sean@example.com"]
267 # }
268 # ]
269 # }
270 #
271 # For a description of IAM and its features, see the
272 # [IAM developer's guide](https://cloud.google.com/iam).
273 "bindings": [ # Associates a list of `members` to a `role`.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]274 # `bindings` with no members will result in an error.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]275 { # Associates `members` with a `role`.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]276 "role": "A String", # Role that is assigned to `members`.
277 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
278 # Required
279 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
280 # `members` can have the following values:
281 #
282 # * `allUsers`: A special identifier that represents anyone who is
283 # on the internet; with or without a Google account.
284 #
285 # * `allAuthenticatedUsers`: A special identifier that represents anyone
286 # who is authenticated with a Google account or a service account.
287 #
288 # * `user:{emailid}`: An email address that represents a specific Google
289 # account. For example, `alice@gmail.com` or `joe@example.com`.
290 #
291 #
292 # * `serviceAccount:{emailid}`: An email address that represents a service
293 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
294 #
295 # * `group:{emailid}`: An email address that represents a Google group.
296 # For example, `admins@example.com`.
297 #
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]298 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]299 # * `domain:{domain}`: A Google Apps domain name that represents all the
300 # users of that domain. For example, `google.com` or `example.com`.
301 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]302 "A String",
303 ],
304 },
305 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]306 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
307 # prevent simultaneous updates of a policy from overwriting each other.
308 # It is strongly suggested that systems make use of the `etag` in the
309 # read-modify-write cycle to perform policy updates in order to avoid race
310 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
311 # systems are expected to put that etag in the request to `setIamPolicy` to
312 # ensure that their change will be applied to the same version of the policy.
313 #
314 # If no `etag` is provided in the call to `setIamPolicy`, then the existing
315 # policy is overwritten blindly.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]316 "version": 42, # Version of the `Policy`. The default version is 0.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]317 }</pre>
318</div>
319
320<div class="method">
321 <code class="details" id="list">list(pageSize=None, projectId=None, pageToken=None, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]322 <pre>Lists datasets within a project.
323
324For the definitions of datasets and other genomics resources, see
325[Fundamentals of Google
326Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]327
328Args:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]329 pageSize: integer, The maximum number of results to return in a single page. If unspecified,
330defaults to 50. The maximum value is 1024.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]331 projectId: string, Required. The Google Cloud project ID to list datasets for.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]332 pageToken: string, The continuation token, which is used to page through large result sets.
333To get the next page of results, set this parameter to the value of
334`nextPageToken` from the previous response.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]335 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]336 Allowed values
337 1 - v1 error format
338 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]339
340Returns:
341 An object of the form:
342
343 { # The dataset list response.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]344 "nextPageToken": "A String", # The continuation token, which is used to page through large result sets.
345 # Provide this value in a subsequent request to return the next page of
346 # results. This field will be empty if there aren't any additional results.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]347 "datasets": [ # The list of matching Datasets.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]348 { # A Dataset is a collection of genomic data.
349 #
350 # For more genomics resource definitions, see [Fundamentals of Google
351 # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]352 "projectId": "A String", # The Google Cloud project ID that this dataset belongs to.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]353 "id": "A String", # The server-generated dataset ID, unique across all datasets.
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]354 "name": "A String", # The dataset name.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]355 "createTime": "A String", # The time this dataset was created, in seconds from the epoch.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]356 },
357 ],
358 }</pre>
359</div>
360
361<div class="method">
362 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
363 <pre>Retrieves the next page of results.
364
365Args:
366 previous_request: The request for the previous page. (required)
367 previous_response: The response from the request for the previous page. (required)
368
369Returns:
370 A request object that you can call 'execute()' on to request the next
371 page. Returns None if there are no more items in the collection.
372 </pre>
373</div>
374
375<div class="method">
376 <code class="details" id="patch">patch(datasetId, body, updateMask=None, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]377 <pre>Updates a dataset.
378
379For the definitions of datasets and other genomics resources, see
380[Fundamentals of Google
381Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
382
383This method supports patch semantics.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]384
385Args:
386 datasetId: string, The ID of the dataset to be updated. (required)
387 body: object, The request body. (required)
388 The object takes the form of:
389
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]390{ # A Dataset is a collection of genomic data.
391 #
392 # For more genomics resource definitions, see [Fundamentals of Google
393 # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]394 "projectId": "A String", # The Google Cloud project ID that this dataset belongs to.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]395 "id": "A String", # The server-generated dataset ID, unique across all datasets.
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]396 "name": "A String", # The dataset name.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]397 "createTime": "A String", # The time this dataset was created, in seconds from the epoch.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]398}
399
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]400 updateMask: string, An optional mask specifying which fields to update. At this time, the only
401mutable field is name. The only
402acceptable value is "name". If unspecified, all mutable fields will be
403updated.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]404 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]405 Allowed values
406 1 - v1 error format
407 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]408
409Returns:
410 An object of the form:
411
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]412 { # A Dataset is a collection of genomic data.
413 #
414 # For more genomics resource definitions, see [Fundamentals of Google
415 # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]416 "projectId": "A String", # The Google Cloud project ID that this dataset belongs to.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]417 "id": "A String", # The server-generated dataset ID, unique across all datasets.
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]418 "name": "A String", # The dataset name.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]419 "createTime": "A String", # The time this dataset was created, in seconds from the epoch.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]420 }</pre>
421</div>
422
423<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]424 <code class="details" id="setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]425 <pre>Sets the access control policy on the specified dataset. Replaces any
426existing policy.
427
428For the definitions of datasets and other genomics resources, see
429[Fundamentals of Google
430Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
431
432See <a href="/iam/docs/managing-policies#setting_a_policy">Setting a
433Policy</a> for more information.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]434
435Args:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]436 resource: string, REQUIRED: The resource for which policy is being specified. Format is
437`datasets/<dataset ID>`. (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]438 body: object, The request body. (required)
439 The object takes the form of:
440
441{ # Request message for `SetIamPolicy` method.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]442 "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to # REQUIRED: The complete policy to be applied to the `resource`. The size of
443 # the policy is limited to a few 10s of KB. An empty policy is a
444 # valid policy but certain Cloud Platform services (such as Projects)
445 # might reject them.
446 # specify access control policies for Cloud Platform resources.
447 #
448 #
449 # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
450 # `members` to a `role`, where the members can be user accounts, Google groups,
451 # Google domains, and service accounts. A `role` is a named list of permissions
452 # defined by IAM.
453 #
454 # **Example**
455 #
456 # {
457 # "bindings": [
458 # {
459 # "role": "roles/owner",
460 # "members": [
461 # "user:mike@example.com",
462 # "group:admins@example.com",
463 # "domain:google.com",
464 # "serviceAccount:my-other-app@appspot.gserviceaccount.com",
465 # ]
466 # },
467 # {
468 # "role": "roles/viewer",
469 # "members": ["user:sean@example.com"]
470 # }
471 # ]
472 # }
473 #
474 # For a description of IAM and its features, see the
475 # [IAM developer's guide](https://cloud.google.com/iam).
476 "bindings": [ # Associates a list of `members` to a `role`.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]477 # `bindings` with no members will result in an error.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]478 { # Associates `members` with a `role`.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]479 "role": "A String", # Role that is assigned to `members`.
480 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
481 # Required
482 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
483 # `members` can have the following values:
484 #
485 # * `allUsers`: A special identifier that represents anyone who is
486 # on the internet; with or without a Google account.
487 #
488 # * `allAuthenticatedUsers`: A special identifier that represents anyone
489 # who is authenticated with a Google account or a service account.
490 #
491 # * `user:{emailid}`: An email address that represents a specific Google
492 # account. For example, `alice@gmail.com` or `joe@example.com`.
493 #
494 #
495 # * `serviceAccount:{emailid}`: An email address that represents a service
496 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
497 #
498 # * `group:{emailid}`: An email address that represents a Google group.
499 # For example, `admins@example.com`.
500 #
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]501 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]502 # * `domain:{domain}`: A Google Apps domain name that represents all the
503 # users of that domain. For example, `google.com` or `example.com`.
504 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]505 "A String",
506 ],
507 },
508 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]509 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
510 # prevent simultaneous updates of a policy from overwriting each other.
511 # It is strongly suggested that systems make use of the `etag` in the
512 # read-modify-write cycle to perform policy updates in order to avoid race
513 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
514 # systems are expected to put that etag in the request to `setIamPolicy` to
515 # ensure that their change will be applied to the same version of the policy.
516 #
517 # If no `etag` is provided in the call to `setIamPolicy`, then the existing
518 # policy is overwritten blindly.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]519 "version": 42, # Version of the `Policy`. The default version is 0.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]520 },
521 }
522
523 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]524 Allowed values
525 1 - v1 error format
526 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]527
528Returns:
529 An object of the form:
530
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]531 { # Defines an Identity and Access Management (IAM) policy. It is used to
532 # specify access control policies for Cloud Platform resources.
533 #
534 #
535 # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
536 # `members` to a `role`, where the members can be user accounts, Google groups,
537 # Google domains, and service accounts. A `role` is a named list of permissions
538 # defined by IAM.
539 #
540 # **Example**
541 #
542 # {
543 # "bindings": [
544 # {
545 # "role": "roles/owner",
546 # "members": [
547 # "user:mike@example.com",
548 # "group:admins@example.com",
549 # "domain:google.com",
550 # "serviceAccount:my-other-app@appspot.gserviceaccount.com",
551 # ]
552 # },
553 # {
554 # "role": "roles/viewer",
555 # "members": ["user:sean@example.com"]
556 # }
557 # ]
558 # }
559 #
560 # For a description of IAM and its features, see the
561 # [IAM developer's guide](https://cloud.google.com/iam).
562 "bindings": [ # Associates a list of `members` to a `role`.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]563 # `bindings` with no members will result in an error.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]564 { # Associates `members` with a `role`.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]565 "role": "A String", # Role that is assigned to `members`.
566 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
567 # Required
568 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
569 # `members` can have the following values:
570 #
571 # * `allUsers`: A special identifier that represents anyone who is
572 # on the internet; with or without a Google account.
573 #
574 # * `allAuthenticatedUsers`: A special identifier that represents anyone
575 # who is authenticated with a Google account or a service account.
576 #
577 # * `user:{emailid}`: An email address that represents a specific Google
578 # account. For example, `alice@gmail.com` or `joe@example.com`.
579 #
580 #
581 # * `serviceAccount:{emailid}`: An email address that represents a service
582 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
583 #
584 # * `group:{emailid}`: An email address that represents a Google group.
585 # For example, `admins@example.com`.
586 #
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]587 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]588 # * `domain:{domain}`: A Google Apps domain name that represents all the
589 # users of that domain. For example, `google.com` or `example.com`.
590 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]591 "A String",
592 ],
593 },
594 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]595 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
596 # prevent simultaneous updates of a policy from overwriting each other.
597 # It is strongly suggested that systems make use of the `etag` in the
598 # read-modify-write cycle to perform policy updates in order to avoid race
599 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
600 # systems are expected to put that etag in the request to `setIamPolicy` to
601 # ensure that their change will be applied to the same version of the policy.
602 #
603 # If no `etag` is provided in the call to `setIamPolicy`, then the existing
604 # policy is overwritten blindly.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]605 "version": 42, # Version of the `Policy`. The default version is 0.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]606 }</pre>
607</div>
608
609<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]610 <code class="details" id="testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]611 <pre>Returns permissions that a caller has on the specified resource.
612See <a href="/iam/docs/managing-policies#testing_permissions">Testing
613Permissions</a> for more information.
614
615For the definitions of datasets and other genomics resources, see
616[Fundamentals of Google
617Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]618
619Args:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]620 resource: string, REQUIRED: The resource for which policy is being specified. Format is
621`datasets/<dataset ID>`. (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]622 body: object, The request body. (required)
623 The object takes the form of:
624
625{ # Request message for `TestIamPermissions` method.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]626 "permissions": [ # REQUIRED: The set of permissions to check for the 'resource'.
627 # Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
628 # Allowed permissions are&#58;
629 #
630 # * `genomics.datasets.create`
631 # * `genomics.datasets.delete`
632 # * `genomics.datasets.get`
633 # * `genomics.datasets.list`
634 # * `genomics.datasets.update`
635 # * `genomics.datasets.getIamPolicy`
636 # * `genomics.datasets.setIamPolicy`
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]637 "A String",
638 ],
639 }
640
641 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]642 Allowed values
643 1 - v1 error format
644 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]645
646Returns:
647 An object of the form:
648
649 { # Response message for `TestIamPermissions` method.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]650 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
651 # allowed.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]652 "A String",
653 ],
654 }</pre>
655</div>
656
657<div class="method">
658 <code class="details" id="undelete">undelete(datasetId, body, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]659 <pre>Undeletes a dataset by restoring a dataset which was deleted via this API.
660
661For the definitions of datasets and other genomics resources, see
662[Fundamentals of Google
663Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
664
665This operation is only possible for a week after the deletion occurred.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]666
667Args:
668 datasetId: string, The ID of the dataset to be undeleted. (required)
669 body: object, The request body. (required)
670 The object takes the form of:
671
672{
673 }
674
675 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]676 Allowed values
677 1 - v1 error format
678 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]679
680Returns:
681 An object of the form:
682
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]683 { # A Dataset is a collection of genomic data.
684 #
685 # For more genomics resource definitions, see [Fundamentals of Google
686 # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]687 "projectId": "A String", # The Google Cloud project ID that this dataset belongs to.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]688 "id": "A String", # The server-generated dataset ID, unique across all datasets.
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]689 "name": "A String", # The dataset name.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]690 "createTime": "A String", # The time this dataset was created, in seconds from the epoch.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]691 }</pre>
692</div>
693
694</body></html>