Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c29aaa9f8e5155f7a948c149fd2fec14e93f588c / . / docs / dyn / bigquery_v2.datasets.html
blob: 46edc17245fae698402098caa642bee6c662b92f [file] [log] [blame]
Joe Gregorio075572b2012-07-09 16:53:09 -0400[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="bigquery_v2.html">BigQuery API</a> . <a href="bigquery_v2.datasets.html">datasets</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(projectId, datasetId, deleteContents=None)</a></code></p>
79<p class="firstline">Deletes the dataset specified by datasetId value. Before you can delete a dataset, you must delete all its tables, either manually or by specifying deleteContents. Immediately after deletion, you can create another dataset with the same name.</p>
80<p class="toc_element">
81 <code><a href="#get">get(projectId, datasetId)</a></code></p>
82<p class="firstline">Returns the dataset specified by datasetID.</p>
83<p class="toc_element">
84 <code><a href="#insert">insert(projectId, body)</a></code></p>
85<p class="firstline">Creates a new empty dataset.</p>
86<p class="toc_element">
87 <code><a href="#list">list(projectId, pageToken=None, maxResults=None)</a></code></p>
88<p class="firstline">Lists all the datasets in the specified project to which the caller has read access; however, a project owner can list (but not necessarily get) all datasets in his project.</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(projectId, datasetId, body)</a></code></p>
94<p class="firstline">Updates information in an existing dataset, specified by datasetId. Properties not included in the submitted resource will not be changed. If you include the access property without any values assigned, the request will fail as you must specify at least one owner for a dataset. This method supports patch semantics.</p>
95<p class="toc_element">
96 <code><a href="#update">update(projectId, datasetId, body)</a></code></p>
97<p class="firstline">Updates information in an existing dataset, specified by datasetId. Properties not included in the submitted resource will not be changed. If you include the access property without any values assigned, the request will fail as you must specify at least one owner for a dataset.</p>
98<h3>Method Details</h3>
99<div class="method">
100 <code class="details" id="delete">delete(projectId, datasetId, deleteContents=None)</code>
101 <pre>Deletes the dataset specified by datasetId value. Before you can delete a dataset, you must delete all its tables, either manually or by specifying deleteContents. Immediately after deletion, you can create another dataset with the same name.
102
103Args:
104 projectId: string, Project ID of the dataset being deleted (required)
105 datasetId: string, Dataset ID of dataset being deleted (required)
106 deleteContents: boolean, If True, delete all the tables in the dataset. If False and the dataset contains tables, the request will fail. Default is False
107</pre>
108</div>
109
110<div class="method">
111 <code class="details" id="get">get(projectId, datasetId)</code>
112 <pre>Returns the dataset specified by datasetID.
113
114Args:
115 projectId: string, Project ID of the requested dataset (required)
116 datasetId: string, Dataset ID of the requested dataset (required)
117
118Returns:
119 An object of the form:
120
121 {
122 "kind": "bigquery#dataset", # [Output-only] The resource type.
123 "description": "A String", # [Optional] A user-friendly string description for the dataset. This might be shown in BigQuery UI for browsing the dataset.
124 "datasetReference": { # [Required] Reference identifying dataset.
125 "projectId": "A String", # [Optional] The ID of the container project.
126 "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.
127 },
128 "creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
129 "access": [ # [Optional] Describes users' rights on the dataset. You can assign the same role to multiple users, and assign multiple roles to the same user.
130 # Default values assigned to a new dataset are as follows: OWNER - Project owners, dataset creator READ - Project readers WRITE - Project writers
131 # See ACLs and Rights for a description of these rights. If you specify any of these roles when creating a dataset, the assigned roles will overwrite the defaults listed above.
132 # To revoke rights to a dataset, call datasets.update() and omit the names of anyone whose rights you wish to revoke. However, every dataset must have at least one entity granted OWNER role.
133 # Each access object can have only one of the following members: userByEmail, groupByEmail, domain, or allAuthenticatedUsers.
134 {
135 "specialGroup": "A String", # [Pick one] A special group to grant access to. The valid values are: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.
136 "domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com".
137 "role": "A String", # [Required] Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READ - User can call any list() or get() method on any collection or resource. WRITE - User can call any method on any collection except for datasets, on which they can call list() and get(). OWNER - User can call any method. The dataset creator is granted this role by default.
138 "groupByEmail": "A String", # [Pick one] A fully-qualified email address of a mailing list to grant access to. This must be either a Google Groups mailing list (ends in @googlegroups.com) or a group managed by an enterprise version of Google Groups.
139 "userByEmail": "A String", # [Pick one] A fully qualified email address of a user to grant access to. For example: fred@example.com.
140 },
141 ],
142 "etag": "A String", # [Output-only] A hash of this resource.
143 "friendlyName": "A String", # [Optional] A descriptive name for this dataset, which might be shown in any BigQuery user interfaces for browsing the dataset. Use datasetId for making API calls.
144 "lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
145 "id": "A String", # [Output-only] The fully-qualified unique name of this dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.
146 "selfLink": "A String", # [Output-only] An URL that can be used to access this resource again. You can use this URL in Get or Update requests to this resource.
147 }</pre>
148</div>
149
150<div class="method">
151 <code class="details" id="insert">insert(projectId, body)</code>
152 <pre>Creates a new empty dataset.
153
154Args:
155 projectId: string, Project ID of the new dataset (required)
156 body: object, The request body. (required)
157 The object takes the form of:
158
159{
160 "kind": "bigquery#dataset", # [Output-only] The resource type.
161 "description": "A String", # [Optional] A user-friendly string description for the dataset. This might be shown in BigQuery UI for browsing the dataset.
162 "datasetReference": { # [Required] Reference identifying dataset.
163 "projectId": "A String", # [Optional] The ID of the container project.
164 "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.
165 },
166 "creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
167 "access": [ # [Optional] Describes users' rights on the dataset. You can assign the same role to multiple users, and assign multiple roles to the same user.
168 # Default values assigned to a new dataset are as follows: OWNER - Project owners, dataset creator READ - Project readers WRITE - Project writers
169 # See ACLs and Rights for a description of these rights. If you specify any of these roles when creating a dataset, the assigned roles will overwrite the defaults listed above.
170 # To revoke rights to a dataset, call datasets.update() and omit the names of anyone whose rights you wish to revoke. However, every dataset must have at least one entity granted OWNER role.
171 # Each access object can have only one of the following members: userByEmail, groupByEmail, domain, or allAuthenticatedUsers.
172 {
173 "specialGroup": "A String", # [Pick one] A special group to grant access to. The valid values are: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.
174 "domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com".
175 "role": "A String", # [Required] Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READ - User can call any list() or get() method on any collection or resource. WRITE - User can call any method on any collection except for datasets, on which they can call list() and get(). OWNER - User can call any method. The dataset creator is granted this role by default.
176 "groupByEmail": "A String", # [Pick one] A fully-qualified email address of a mailing list to grant access to. This must be either a Google Groups mailing list (ends in @googlegroups.com) or a group managed by an enterprise version of Google Groups.
177 "userByEmail": "A String", # [Pick one] A fully qualified email address of a user to grant access to. For example: fred@example.com.
178 },
179 ],
180 "etag": "A String", # [Output-only] A hash of this resource.
181 "friendlyName": "A String", # [Optional] A descriptive name for this dataset, which might be shown in any BigQuery user interfaces for browsing the dataset. Use datasetId for making API calls.
182 "lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
183 "id": "A String", # [Output-only] The fully-qualified unique name of this dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.
184 "selfLink": "A String", # [Output-only] An URL that can be used to access this resource again. You can use this URL in Get or Update requests to this resource.
185 }
186
187
188Returns:
189 An object of the form:
190
191 {
192 "kind": "bigquery#dataset", # [Output-only] The resource type.
193 "description": "A String", # [Optional] A user-friendly string description for the dataset. This might be shown in BigQuery UI for browsing the dataset.
194 "datasetReference": { # [Required] Reference identifying dataset.
195 "projectId": "A String", # [Optional] The ID of the container project.
196 "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.
197 },
198 "creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
199 "access": [ # [Optional] Describes users' rights on the dataset. You can assign the same role to multiple users, and assign multiple roles to the same user.
200 # Default values assigned to a new dataset are as follows: OWNER - Project owners, dataset creator READ - Project readers WRITE - Project writers
201 # See ACLs and Rights for a description of these rights. If you specify any of these roles when creating a dataset, the assigned roles will overwrite the defaults listed above.
202 # To revoke rights to a dataset, call datasets.update() and omit the names of anyone whose rights you wish to revoke. However, every dataset must have at least one entity granted OWNER role.
203 # Each access object can have only one of the following members: userByEmail, groupByEmail, domain, or allAuthenticatedUsers.
204 {
205 "specialGroup": "A String", # [Pick one] A special group to grant access to. The valid values are: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.
206 "domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com".
207 "role": "A String", # [Required] Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READ - User can call any list() or get() method on any collection or resource. WRITE - User can call any method on any collection except for datasets, on which they can call list() and get(). OWNER - User can call any method. The dataset creator is granted this role by default.
208 "groupByEmail": "A String", # [Pick one] A fully-qualified email address of a mailing list to grant access to. This must be either a Google Groups mailing list (ends in @googlegroups.com) or a group managed by an enterprise version of Google Groups.
209 "userByEmail": "A String", # [Pick one] A fully qualified email address of a user to grant access to. For example: fred@example.com.
210 },
211 ],
212 "etag": "A String", # [Output-only] A hash of this resource.
213 "friendlyName": "A String", # [Optional] A descriptive name for this dataset, which might be shown in any BigQuery user interfaces for browsing the dataset. Use datasetId for making API calls.
214 "lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
215 "id": "A String", # [Output-only] The fully-qualified unique name of this dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.
216 "selfLink": "A String", # [Output-only] An URL that can be used to access this resource again. You can use this URL in Get or Update requests to this resource.
217 }</pre>
218</div>
219
220<div class="method">
221 <code class="details" id="list">list(projectId, pageToken=None, maxResults=None)</code>
222 <pre>Lists all the datasets in the specified project to which the caller has read access; however, a project owner can list (but not necessarily get) all datasets in his project.
223
224Args:
225 projectId: string, Project ID of the datasets to be listed (required)
226 pageToken: string, Page token, returned by a previous call, to request the next page of results
227 maxResults: integer, The maximum number of results to return
228
229Returns:
230 An object of the form:
231
232 {
233 "nextPageToken": "A String", # A token to request the next page of results. Present only when there is more than one page of results.* See Paging Through Results in the developer's guide.
234 "kind": "bigquery#datasetList", # The type of list.
235 "datasets": [ # An array of one or more summarized dataset resources. Absent when there are no datasets in the specified project.
236 {
237 "friendlyName": "A String", # A descriptive name for this dataset, if one exists.
238 "kind": "bigquery#dataset", # The resource type.
239 "id": "A String", # The fully-qualified unique name of this dataset in the format projectId:datasetId.
240 "datasetReference": { # Reference identifying dataset.
241 "projectId": "A String", # [Optional] The ID of the container project.
242 "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.
243 },
244 },
245 ],
246 "etag": "A String", # A hash of this page of results. See Paging Through Results in the developer's guide.
247 }</pre>
248</div>
249
250<div class="method">
251 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
252 <pre>Retrieves the next page of results.
253
254Args:
255 previous_request: The request for the previous page. (required)
256 previous_response: The response from the request for the previous page. (required)
257
258Returns:
259 A request object that you can call 'execute()' on to request the next
260 page. Returns None if there are no more items in the collection.
261 </pre>
262</div>
263
264<div class="method">
265 <code class="details" id="patch">patch(projectId, datasetId, body)</code>
266 <pre>Updates information in an existing dataset, specified by datasetId. Properties not included in the submitted resource will not be changed. If you include the access property without any values assigned, the request will fail as you must specify at least one owner for a dataset. This method supports patch semantics.
267
268Args:
269 projectId: string, Project ID of the dataset being updated (required)
270 datasetId: string, Dataset ID of the dataset being updated (required)
271 body: object, The request body. (required)
272 The object takes the form of:
273
274{
275 "kind": "bigquery#dataset", # [Output-only] The resource type.
276 "description": "A String", # [Optional] A user-friendly string description for the dataset. This might be shown in BigQuery UI for browsing the dataset.
277 "datasetReference": { # [Required] Reference identifying dataset.
278 "projectId": "A String", # [Optional] The ID of the container project.
279 "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.
280 },
281 "creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
282 "access": [ # [Optional] Describes users' rights on the dataset. You can assign the same role to multiple users, and assign multiple roles to the same user.
283 # Default values assigned to a new dataset are as follows: OWNER - Project owners, dataset creator READ - Project readers WRITE - Project writers
284 # See ACLs and Rights for a description of these rights. If you specify any of these roles when creating a dataset, the assigned roles will overwrite the defaults listed above.
285 # To revoke rights to a dataset, call datasets.update() and omit the names of anyone whose rights you wish to revoke. However, every dataset must have at least one entity granted OWNER role.
286 # Each access object can have only one of the following members: userByEmail, groupByEmail, domain, or allAuthenticatedUsers.
287 {
288 "specialGroup": "A String", # [Pick one] A special group to grant access to. The valid values are: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.
289 "domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com".
290 "role": "A String", # [Required] Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READ - User can call any list() or get() method on any collection or resource. WRITE - User can call any method on any collection except for datasets, on which they can call list() and get(). OWNER - User can call any method. The dataset creator is granted this role by default.
291 "groupByEmail": "A String", # [Pick one] A fully-qualified email address of a mailing list to grant access to. This must be either a Google Groups mailing list (ends in @googlegroups.com) or a group managed by an enterprise version of Google Groups.
292 "userByEmail": "A String", # [Pick one] A fully qualified email address of a user to grant access to. For example: fred@example.com.
293 },
294 ],
295 "etag": "A String", # [Output-only] A hash of this resource.
296 "friendlyName": "A String", # [Optional] A descriptive name for this dataset, which might be shown in any BigQuery user interfaces for browsing the dataset. Use datasetId for making API calls.
297 "lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
298 "id": "A String", # [Output-only] The fully-qualified unique name of this dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.
299 "selfLink": "A String", # [Output-only] An URL that can be used to access this resource again. You can use this URL in Get or Update requests to this resource.
300 }
301
302
303Returns:
304 An object of the form:
305
306 {
307 "kind": "bigquery#dataset", # [Output-only] The resource type.
308 "description": "A String", # [Optional] A user-friendly string description for the dataset. This might be shown in BigQuery UI for browsing the dataset.
309 "datasetReference": { # [Required] Reference identifying dataset.
310 "projectId": "A String", # [Optional] The ID of the container project.
311 "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.
312 },
313 "creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
314 "access": [ # [Optional] Describes users' rights on the dataset. You can assign the same role to multiple users, and assign multiple roles to the same user.
315 # Default values assigned to a new dataset are as follows: OWNER - Project owners, dataset creator READ - Project readers WRITE - Project writers
316 # See ACLs and Rights for a description of these rights. If you specify any of these roles when creating a dataset, the assigned roles will overwrite the defaults listed above.
317 # To revoke rights to a dataset, call datasets.update() and omit the names of anyone whose rights you wish to revoke. However, every dataset must have at least one entity granted OWNER role.
318 # Each access object can have only one of the following members: userByEmail, groupByEmail, domain, or allAuthenticatedUsers.
319 {
320 "specialGroup": "A String", # [Pick one] A special group to grant access to. The valid values are: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.
321 "domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com".
322 "role": "A String", # [Required] Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READ - User can call any list() or get() method on any collection or resource. WRITE - User can call any method on any collection except for datasets, on which they can call list() and get(). OWNER - User can call any method. The dataset creator is granted this role by default.
323 "groupByEmail": "A String", # [Pick one] A fully-qualified email address of a mailing list to grant access to. This must be either a Google Groups mailing list (ends in @googlegroups.com) or a group managed by an enterprise version of Google Groups.
324 "userByEmail": "A String", # [Pick one] A fully qualified email address of a user to grant access to. For example: fred@example.com.
325 },
326 ],
327 "etag": "A String", # [Output-only] A hash of this resource.
328 "friendlyName": "A String", # [Optional] A descriptive name for this dataset, which might be shown in any BigQuery user interfaces for browsing the dataset. Use datasetId for making API calls.
329 "lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
330 "id": "A String", # [Output-only] The fully-qualified unique name of this dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.
331 "selfLink": "A String", # [Output-only] An URL that can be used to access this resource again. You can use this URL in Get or Update requests to this resource.
332 }</pre>
333</div>
334
335<div class="method">
336 <code class="details" id="update">update(projectId, datasetId, body)</code>
337 <pre>Updates information in an existing dataset, specified by datasetId. Properties not included in the submitted resource will not be changed. If you include the access property without any values assigned, the request will fail as you must specify at least one owner for a dataset.
338
339Args:
340 projectId: string, Project ID of the dataset being updated (required)
341 datasetId: string, Dataset ID of the dataset being updated (required)
342 body: object, The request body. (required)
343 The object takes the form of:
344
345{
346 "kind": "bigquery#dataset", # [Output-only] The resource type.
347 "description": "A String", # [Optional] A user-friendly string description for the dataset. This might be shown in BigQuery UI for browsing the dataset.
348 "datasetReference": { # [Required] Reference identifying dataset.
349 "projectId": "A String", # [Optional] The ID of the container project.
350 "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.
351 },
352 "creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
353 "access": [ # [Optional] Describes users' rights on the dataset. You can assign the same role to multiple users, and assign multiple roles to the same user.
354 # Default values assigned to a new dataset are as follows: OWNER - Project owners, dataset creator READ - Project readers WRITE - Project writers
355 # See ACLs and Rights for a description of these rights. If you specify any of these roles when creating a dataset, the assigned roles will overwrite the defaults listed above.
356 # To revoke rights to a dataset, call datasets.update() and omit the names of anyone whose rights you wish to revoke. However, every dataset must have at least one entity granted OWNER role.
357 # Each access object can have only one of the following members: userByEmail, groupByEmail, domain, or allAuthenticatedUsers.
358 {
359 "specialGroup": "A String", # [Pick one] A special group to grant access to. The valid values are: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.
360 "domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com".
361 "role": "A String", # [Required] Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READ - User can call any list() or get() method on any collection or resource. WRITE - User can call any method on any collection except for datasets, on which they can call list() and get(). OWNER - User can call any method. The dataset creator is granted this role by default.
362 "groupByEmail": "A String", # [Pick one] A fully-qualified email address of a mailing list to grant access to. This must be either a Google Groups mailing list (ends in @googlegroups.com) or a group managed by an enterprise version of Google Groups.
363 "userByEmail": "A String", # [Pick one] A fully qualified email address of a user to grant access to. For example: fred@example.com.
364 },
365 ],
366 "etag": "A String", # [Output-only] A hash of this resource.
367 "friendlyName": "A String", # [Optional] A descriptive name for this dataset, which might be shown in any BigQuery user interfaces for browsing the dataset. Use datasetId for making API calls.
368 "lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
369 "id": "A String", # [Output-only] The fully-qualified unique name of this dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.
370 "selfLink": "A String", # [Output-only] An URL that can be used to access this resource again. You can use this URL in Get or Update requests to this resource.
371 }
372
373
374Returns:
375 An object of the form:
376
377 {
378 "kind": "bigquery#dataset", # [Output-only] The resource type.
379 "description": "A String", # [Optional] A user-friendly string description for the dataset. This might be shown in BigQuery UI for browsing the dataset.
380 "datasetReference": { # [Required] Reference identifying dataset.
381 "projectId": "A String", # [Optional] The ID of the container project.
382 "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.
383 },
384 "creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
385 "access": [ # [Optional] Describes users' rights on the dataset. You can assign the same role to multiple users, and assign multiple roles to the same user.
386 # Default values assigned to a new dataset are as follows: OWNER - Project owners, dataset creator READ - Project readers WRITE - Project writers
387 # See ACLs and Rights for a description of these rights. If you specify any of these roles when creating a dataset, the assigned roles will overwrite the defaults listed above.
388 # To revoke rights to a dataset, call datasets.update() and omit the names of anyone whose rights you wish to revoke. However, every dataset must have at least one entity granted OWNER role.
389 # Each access object can have only one of the following members: userByEmail, groupByEmail, domain, or allAuthenticatedUsers.
390 {
391 "specialGroup": "A String", # [Pick one] A special group to grant access to. The valid values are: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.
392 "domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com".
393 "role": "A String", # [Required] Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READ - User can call any list() or get() method on any collection or resource. WRITE - User can call any method on any collection except for datasets, on which they can call list() and get(). OWNER - User can call any method. The dataset creator is granted this role by default.
394 "groupByEmail": "A String", # [Pick one] A fully-qualified email address of a mailing list to grant access to. This must be either a Google Groups mailing list (ends in @googlegroups.com) or a group managed by an enterprise version of Google Groups.
395 "userByEmail": "A String", # [Pick one] A fully qualified email address of a user to grant access to. For example: fred@example.com.
396 },
397 ],
398 "etag": "A String", # [Output-only] A hash of this resource.
399 "friendlyName": "A String", # [Optional] A descriptive name for this dataset, which might be shown in any BigQuery user interfaces for browsing the dataset. Use datasetId for making API calls.
400 "lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
401 "id": "A String", # [Output-only] The fully-qualified unique name of this dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.
402 "selfLink": "A String", # [Output-only] An URL that can be used to access this resource again. You can use this URL in Get or Update requests to this resource.
403 }</pre>
404</div>
405
406</body></html>