Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 4f877e562986034f25ea4246ad1256eabd339526 / . / docs / dyn / bigquery_v2.datasets.html
blob: 32c7b97c0de20b7298e4e9c6321e548296d8275f [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -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 the 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, all=None, pageToken=None, maxResults=None)</a></code></p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]88<p class="firstline">Lists all datasets in the specified project to which you have been granted the READER dataset role.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
93 <code><a href="#patch">patch(projectId, datasetId, body)</a></code></p>
94<p class="firstline">Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource. 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. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource.</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 the 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 description of the dataset.
124 "datasetReference": { # [Required] A reference that identifies the dataset.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]125 "projectId": "A String", # [Optional] The ID of the project containing this dataset.
126 "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]127 },
128 "creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
129 "access": [ # [Optional] An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER;
130 {
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]131 "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".
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]132 "userByEmail": "A String", # [Pick one] An email address of a user to grant access to. For example: fred@example.com.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]133 "specialGroup": "A String", # [Pick one] A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.
134 "groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to.
135 "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: READER, WRITER, OWNER.
136 "view": { # [Pick one] A view from a different dataset to grant access to. Queries executed against that view will have read access to tables in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]137 "projectId": "A String", # [Required] The ID of the project containing this table.
138 "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
139 "datasetId": "A String", # [Required] The ID of the dataset containing this table.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]140 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]141 },
142 ],
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]143 "defaultTableExpirationMs": "A String", # [Experimental] The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]144 "etag": "A String", # [Output-only] A hash of the resource.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]145 "location": "A String", # [Experimental] The location where the data resides. If not present, the data will be stored in the US.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]146 "friendlyName": "A String", # [Optional] A descriptive name for the dataset.
147 "lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
148 "id": "A String", # [Output-only] The fully-qualified unique name of the 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.
149 "selfLink": "A String", # [Output-only] A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource.
150 }</pre>
151</div>
152
153<div class="method">
154 <code class="details" id="insert">insert(projectId, body)</code>
155 <pre>Creates a new empty dataset.
156
157Args:
158 projectId: string, Project ID of the new dataset (required)
159 body: object, The request body. (required)
160 The object takes the form of:
161
162{
163 "kind": "bigquery#dataset", # [Output-only] The resource type.
164 "description": "A String", # [Optional] A user-friendly description of the dataset.
165 "datasetReference": { # [Required] A reference that identifies the dataset.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]166 "projectId": "A String", # [Optional] The ID of the project containing this dataset.
167 "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]168 },
169 "creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
170 "access": [ # [Optional] An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER;
171 {
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]172 "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".
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]173 "userByEmail": "A String", # [Pick one] An email address of a user to grant access to. For example: fred@example.com.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]174 "specialGroup": "A String", # [Pick one] A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.
175 "groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to.
176 "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: READER, WRITER, OWNER.
177 "view": { # [Pick one] A view from a different dataset to grant access to. Queries executed against that view will have read access to tables in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]178 "projectId": "A String", # [Required] The ID of the project containing this table.
179 "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
180 "datasetId": "A String", # [Required] The ID of the dataset containing this table.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]181 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]182 },
183 ],
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]184 "defaultTableExpirationMs": "A String", # [Experimental] The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]185 "etag": "A String", # [Output-only] A hash of the resource.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]186 "location": "A String", # [Experimental] The location where the data resides. If not present, the data will be stored in the US.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]187 "friendlyName": "A String", # [Optional] A descriptive name for the dataset.
188 "lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
189 "id": "A String", # [Output-only] The fully-qualified unique name of the 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.
190 "selfLink": "A String", # [Output-only] A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource.
191 }
192
193
194Returns:
195 An object of the form:
196
197 {
198 "kind": "bigquery#dataset", # [Output-only] The resource type.
199 "description": "A String", # [Optional] A user-friendly description of the dataset.
200 "datasetReference": { # [Required] A reference that identifies the dataset.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]201 "projectId": "A String", # [Optional] The ID of the project containing this dataset.
202 "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]203 },
204 "creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
205 "access": [ # [Optional] An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER;
206 {
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]207 "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".
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]208 "userByEmail": "A String", # [Pick one] An email address of a user to grant access to. For example: fred@example.com.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]209 "specialGroup": "A String", # [Pick one] A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.
210 "groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to.
211 "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: READER, WRITER, OWNER.
212 "view": { # [Pick one] A view from a different dataset to grant access to. Queries executed against that view will have read access to tables in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]213 "projectId": "A String", # [Required] The ID of the project containing this table.
214 "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
215 "datasetId": "A String", # [Required] The ID of the dataset containing this table.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]216 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]217 },
218 ],
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]219 "defaultTableExpirationMs": "A String", # [Experimental] The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]220 "etag": "A String", # [Output-only] A hash of the resource.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]221 "location": "A String", # [Experimental] The location where the data resides. If not present, the data will be stored in the US.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]222 "friendlyName": "A String", # [Optional] A descriptive name for the dataset.
223 "lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
224 "id": "A String", # [Output-only] The fully-qualified unique name of the 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.
225 "selfLink": "A String", # [Output-only] A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource.
226 }</pre>
227</div>
228
229<div class="method">
230 <code class="details" id="list">list(projectId, all=None, pageToken=None, maxResults=None)</code>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]231 <pre>Lists all datasets in the specified project to which you have been granted the READER dataset role.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]232
233Args:
234 projectId: string, Project ID of the datasets to be listed (required)
235 all: boolean, Whether to list all datasets, including hidden ones
236 pageToken: string, Page token, returned by a previous call, to request the next page of results
237 maxResults: integer, The maximum number of results to return
238
239Returns:
240 An object of the form:
241
242 {
243 "nextPageToken": "A String", # A token that can be used to request the next results page. This property is omitted on the final results page.
244 "kind": "bigquery#datasetList", # The list type. This property always returns the value "bigquery#datasetList".
245 "datasets": [ # An array of the dataset resources in the project. Each resource contains basic information. For full information about a particular dataset resource, use the Datasets: get method. This property is omitted when there are no datasets in the project.
246 {
247 "friendlyName": "A String", # A descriptive name for the dataset, if one exists.
248 "kind": "bigquery#dataset", # The resource type. This property always returns the value "bigquery#dataset".
249 "id": "A String", # The fully-qualified, unique, opaque ID of the dataset.
250 "datasetReference": { # The dataset reference. Use this property to access specific parts of the dataset's ID, such as project ID or dataset ID.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]251 "projectId": "A String", # [Optional] The ID of the project containing this dataset.
252 "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]253 },
254 },
255 ],
256 "etag": "A String", # A hash value of the results page. You can use this property to determine if the page has changed since the last request.
257 }</pre>
258</div>
259
260<div class="method">
261 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
262 <pre>Retrieves the next page of results.
263
264Args:
265 previous_request: The request for the previous page. (required)
266 previous_response: The response from the request for the previous page. (required)
267
268Returns:
269 A request object that you can call 'execute()' on to request the next
270 page. Returns None if there are no more items in the collection.
271 </pre>
272</div>
273
274<div class="method">
275 <code class="details" id="patch">patch(projectId, datasetId, body)</code>
276 <pre>Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource. This method supports patch semantics.
277
278Args:
279 projectId: string, Project ID of the dataset being updated (required)
280 datasetId: string, Dataset ID of the dataset being updated (required)
281 body: object, The request body. (required)
282 The object takes the form of:
283
284{
285 "kind": "bigquery#dataset", # [Output-only] The resource type.
286 "description": "A String", # [Optional] A user-friendly description of the dataset.
287 "datasetReference": { # [Required] A reference that identifies the dataset.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]288 "projectId": "A String", # [Optional] The ID of the project containing this dataset.
289 "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]290 },
291 "creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
292 "access": [ # [Optional] An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER;
293 {
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]294 "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".
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]295 "userByEmail": "A String", # [Pick one] An email address of a user to grant access to. For example: fred@example.com.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]296 "specialGroup": "A String", # [Pick one] A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.
297 "groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to.
298 "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: READER, WRITER, OWNER.
299 "view": { # [Pick one] A view from a different dataset to grant access to. Queries executed against that view will have read access to tables in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]300 "projectId": "A String", # [Required] The ID of the project containing this table.
301 "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
302 "datasetId": "A String", # [Required] The ID of the dataset containing this table.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]303 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]304 },
305 ],
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]306 "defaultTableExpirationMs": "A String", # [Experimental] The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]307 "etag": "A String", # [Output-only] A hash of the resource.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]308 "location": "A String", # [Experimental] The location where the data resides. If not present, the data will be stored in the US.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]309 "friendlyName": "A String", # [Optional] A descriptive name for the dataset.
310 "lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
311 "id": "A String", # [Output-only] The fully-qualified unique name of the 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.
312 "selfLink": "A String", # [Output-only] A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource.
313 }
314
315
316Returns:
317 An object of the form:
318
319 {
320 "kind": "bigquery#dataset", # [Output-only] The resource type.
321 "description": "A String", # [Optional] A user-friendly description of the dataset.
322 "datasetReference": { # [Required] A reference that identifies the dataset.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]323 "projectId": "A String", # [Optional] The ID of the project containing this dataset.
324 "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]325 },
326 "creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
327 "access": [ # [Optional] An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER;
328 {
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]329 "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".
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]330 "userByEmail": "A String", # [Pick one] An email address of a user to grant access to. For example: fred@example.com.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]331 "specialGroup": "A String", # [Pick one] A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.
332 "groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to.
333 "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: READER, WRITER, OWNER.
334 "view": { # [Pick one] A view from a different dataset to grant access to. Queries executed against that view will have read access to tables in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]335 "projectId": "A String", # [Required] The ID of the project containing this table.
336 "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
337 "datasetId": "A String", # [Required] The ID of the dataset containing this table.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]338 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]339 },
340 ],
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]341 "defaultTableExpirationMs": "A String", # [Experimental] The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]342 "etag": "A String", # [Output-only] A hash of the resource.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]343 "location": "A String", # [Experimental] The location where the data resides. If not present, the data will be stored in the US.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]344 "friendlyName": "A String", # [Optional] A descriptive name for the dataset.
345 "lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
346 "id": "A String", # [Output-only] The fully-qualified unique name of the 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.
347 "selfLink": "A String", # [Output-only] A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource.
348 }</pre>
349</div>
350
351<div class="method">
352 <code class="details" id="update">update(projectId, datasetId, body)</code>
353 <pre>Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource.
354
355Args:
356 projectId: string, Project ID of the dataset being updated (required)
357 datasetId: string, Dataset ID of the dataset being updated (required)
358 body: object, The request body. (required)
359 The object takes the form of:
360
361{
362 "kind": "bigquery#dataset", # [Output-only] The resource type.
363 "description": "A String", # [Optional] A user-friendly description of the dataset.
364 "datasetReference": { # [Required] A reference that identifies the dataset.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]365 "projectId": "A String", # [Optional] The ID of the project containing this dataset.
366 "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]367 },
368 "creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
369 "access": [ # [Optional] An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER;
370 {
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]371 "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".
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]372 "userByEmail": "A String", # [Pick one] An email address of a user to grant access to. For example: fred@example.com.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]373 "specialGroup": "A String", # [Pick one] A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.
374 "groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to.
375 "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: READER, WRITER, OWNER.
376 "view": { # [Pick one] A view from a different dataset to grant access to. Queries executed against that view will have read access to tables in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]377 "projectId": "A String", # [Required] The ID of the project containing this table.
378 "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
379 "datasetId": "A String", # [Required] The ID of the dataset containing this table.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]380 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]381 },
382 ],
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]383 "defaultTableExpirationMs": "A String", # [Experimental] The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]384 "etag": "A String", # [Output-only] A hash of the resource.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]385 "location": "A String", # [Experimental] The location where the data resides. If not present, the data will be stored in the US.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]386 "friendlyName": "A String", # [Optional] A descriptive name for the dataset.
387 "lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
388 "id": "A String", # [Output-only] The fully-qualified unique name of the 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.
389 "selfLink": "A String", # [Output-only] A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource.
390 }
391
392
393Returns:
394 An object of the form:
395
396 {
397 "kind": "bigquery#dataset", # [Output-only] The resource type.
398 "description": "A String", # [Optional] A user-friendly description of the dataset.
399 "datasetReference": { # [Required] A reference that identifies the dataset.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]400 "projectId": "A String", # [Optional] The ID of the project containing this dataset.
401 "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]402 },
403 "creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
404 "access": [ # [Optional] An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER;
405 {
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]406 "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".
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]407 "userByEmail": "A String", # [Pick one] An email address of a user to grant access to. For example: fred@example.com.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]408 "specialGroup": "A String", # [Pick one] A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.
409 "groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to.
410 "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: READER, WRITER, OWNER.
411 "view": { # [Pick one] A view from a different dataset to grant access to. Queries executed against that view will have read access to tables in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]412 "projectId": "A String", # [Required] The ID of the project containing this table.
413 "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
414 "datasetId": "A String", # [Required] The ID of the dataset containing this table.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]415 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]416 },
417 ],
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]418 "defaultTableExpirationMs": "A String", # [Experimental] The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]419 "etag": "A String", # [Output-only] A hash of the resource.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]420 "location": "A String", # [Experimental] The location where the data resides. If not present, the data will be stored in the US.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]421 "friendlyName": "A String", # [Optional] A descriptive name for the dataset.
422 "lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
423 "id": "A String", # [Output-only] The fully-qualified unique name of the 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.
424 "selfLink": "A String", # [Output-only] A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource.
425 }</pre>
426</div>
427
428</body></html>