Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / db5a0ed106aff656a031a99ad64780ffd88c8425 / . / docs / dyn / bigquery_v2.datasets.html
blob: a1bbe9ba80ea7b21571a0d35c59e102a4245a0b2 [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">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]87 <code><a href="#list">list(projectId, filter=None, 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 },
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]128 "labels": { # [Experimental] The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Labeling Datasets for more information.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]129 "a_key": "A String",
130 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]131 "creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
132 "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;
133 {
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]134 "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]135 "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]136 "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.
137 "groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to.
138 "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.
139 "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]140 "projectId": "A String", # [Required] The ID of the project containing this table.
141 "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.
142 "datasetId": "A String", # [Required] The ID of the dataset containing this table.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]143 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]144 },
145 ],
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]146 "defaultTableExpirationMs": "A String", # [Optional] 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]147 "etag": "A String", # [Output-only] A hash of the resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]148 "location": "A String", # [Experimental] The geographic location where the dataset should reside. Possible values include EU and US. The default value is US.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]149 "friendlyName": "A String", # [Optional] A descriptive name for the dataset.
150 "lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
151 "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.
152 "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.
153 }</pre>
154</div>
155
156<div class="method">
157 <code class="details" id="insert">insert(projectId, body)</code>
158 <pre>Creates a new empty dataset.
159
160Args:
161 projectId: string, Project ID of the new dataset (required)
162 body: object, The request body. (required)
163 The object takes the form of:
164
165{
166 "kind": "bigquery#dataset", # [Output-only] The resource type.
167 "description": "A String", # [Optional] A user-friendly description of the dataset.
168 "datasetReference": { # [Required] A reference that identifies the dataset.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]169 "projectId": "A String", # [Optional] The ID of the project containing this dataset.
170 "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]171 },
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]172 "labels": { # [Experimental] The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Labeling Datasets for more information.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]173 "a_key": "A String",
174 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]175 "creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
176 "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;
177 {
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]178 "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]179 "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]180 "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.
181 "groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to.
182 "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.
183 "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]184 "projectId": "A String", # [Required] The ID of the project containing this table.
185 "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.
186 "datasetId": "A String", # [Required] The ID of the dataset containing this table.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]187 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]188 },
189 ],
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]190 "defaultTableExpirationMs": "A String", # [Optional] 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]191 "etag": "A String", # [Output-only] A hash of the resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]192 "location": "A String", # [Experimental] The geographic location where the dataset should reside. Possible values include EU and US. The default value is US.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]193 "friendlyName": "A String", # [Optional] A descriptive name for the dataset.
194 "lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
195 "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.
196 "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.
197 }
198
199
200Returns:
201 An object of the form:
202
203 {
204 "kind": "bigquery#dataset", # [Output-only] The resource type.
205 "description": "A String", # [Optional] A user-friendly description of the dataset.
206 "datasetReference": { # [Required] A reference that identifies the dataset.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]207 "projectId": "A String", # [Optional] The ID of the project containing this dataset.
208 "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]209 },
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]210 "labels": { # [Experimental] The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Labeling Datasets for more information.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]211 "a_key": "A String",
212 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]213 "creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
214 "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;
215 {
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]216 "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]217 "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]218 "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.
219 "groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to.
220 "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.
221 "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]222 "projectId": "A String", # [Required] The ID of the project containing this table.
223 "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.
224 "datasetId": "A String", # [Required] The ID of the dataset containing this table.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]225 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]226 },
227 ],
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]228 "defaultTableExpirationMs": "A String", # [Optional] 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]229 "etag": "A String", # [Output-only] A hash of the resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]230 "location": "A String", # [Experimental] The geographic location where the dataset should reside. Possible values include EU and US. The default value is US.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]231 "friendlyName": "A String", # [Optional] A descriptive name for the dataset.
232 "lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
233 "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.
234 "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.
235 }</pre>
236</div>
237
238<div class="method">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]239 <code class="details" id="list">list(projectId, filter=None, all=None, pageToken=None, maxResults=None)</code>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]240 <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]241
242Args:
243 projectId: string, Project ID of the datasets to be listed (required)
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]244 filter: string, An expression for filtering the results of the request by label. The syntax is "labels.<name>[:<value>]". Multiple filters can be ANDed together by connecting with a space. Example: "labels.department:receiving labels.active". See Filtering datasets using labels for details.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]245 all: boolean, Whether to list all datasets, including hidden ones
246 pageToken: string, Page token, returned by a previous call, to request the next page of results
247 maxResults: integer, The maximum number of results to return
248
249Returns:
250 An object of the form:
251
252 {
253 "nextPageToken": "A String", # A token that can be used to request the next results page. This property is omitted on the final results page.
254 "kind": "bigquery#datasetList", # The list type. This property always returns the value "bigquery#datasetList".
255 "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.
256 {
257 "friendlyName": "A String", # A descriptive name for the dataset, if one exists.
258 "kind": "bigquery#dataset", # The resource type. This property always returns the value "bigquery#dataset".
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]259 "labels": { # [Experimental] The labels associated with this dataset. You can use these to organize and group your datasets.
260 "a_key": "A String",
261 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]262 "id": "A String", # The fully-qualified, unique, opaque ID of the dataset.
263 "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]264 "projectId": "A String", # [Optional] The ID of the project containing this dataset.
265 "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]266 },
267 },
268 ],
269 "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.
270 }</pre>
271</div>
272
273<div class="method">
274 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
275 <pre>Retrieves the next page of results.
276
277Args:
278 previous_request: The request for the previous page. (required)
279 previous_response: The response from the request for the previous page. (required)
280
281Returns:
282 A request object that you can call 'execute()' on to request the next
283 page. Returns None if there are no more items in the collection.
284 </pre>
285</div>
286
287<div class="method">
288 <code class="details" id="patch">patch(projectId, datasetId, body)</code>
289 <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.
290
291Args:
292 projectId: string, Project ID of the dataset being updated (required)
293 datasetId: string, Dataset ID of the dataset being updated (required)
294 body: object, The request body. (required)
295 The object takes the form of:
296
297{
298 "kind": "bigquery#dataset", # [Output-only] The resource type.
299 "description": "A String", # [Optional] A user-friendly description of the dataset.
300 "datasetReference": { # [Required] A reference that identifies the dataset.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]301 "projectId": "A String", # [Optional] The ID of the project containing this dataset.
302 "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]303 },
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]304 "labels": { # [Experimental] The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Labeling Datasets for more information.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]305 "a_key": "A String",
306 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]307 "creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
308 "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;
309 {
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]310 "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]311 "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]312 "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.
313 "groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to.
314 "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.
315 "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]316 "projectId": "A String", # [Required] The ID of the project containing this table.
317 "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.
318 "datasetId": "A String", # [Required] The ID of the dataset containing this table.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]319 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]320 },
321 ],
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]322 "defaultTableExpirationMs": "A String", # [Optional] 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]323 "etag": "A String", # [Output-only] A hash of the resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]324 "location": "A String", # [Experimental] The geographic location where the dataset should reside. Possible values include EU and US. The default value is US.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]325 "friendlyName": "A String", # [Optional] A descriptive name for the dataset.
326 "lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
327 "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.
328 "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.
329 }
330
331
332Returns:
333 An object of the form:
334
335 {
336 "kind": "bigquery#dataset", # [Output-only] The resource type.
337 "description": "A String", # [Optional] A user-friendly description of the dataset.
338 "datasetReference": { # [Required] A reference that identifies the dataset.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]339 "projectId": "A String", # [Optional] The ID of the project containing this dataset.
340 "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]341 },
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]342 "labels": { # [Experimental] The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Labeling Datasets for more information.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]343 "a_key": "A String",
344 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]345 "creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
346 "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;
347 {
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]348 "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]349 "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]350 "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.
351 "groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to.
352 "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.
353 "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]354 "projectId": "A String", # [Required] The ID of the project containing this table.
355 "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.
356 "datasetId": "A String", # [Required] The ID of the dataset containing this table.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]357 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]358 },
359 ],
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]360 "defaultTableExpirationMs": "A String", # [Optional] 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]361 "etag": "A String", # [Output-only] A hash of the resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]362 "location": "A String", # [Experimental] The geographic location where the dataset should reside. Possible values include EU and US. The default value is US.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]363 "friendlyName": "A String", # [Optional] A descriptive name for the dataset.
364 "lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
365 "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.
366 "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.
367 }</pre>
368</div>
369
370<div class="method">
371 <code class="details" id="update">update(projectId, datasetId, body)</code>
372 <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.
373
374Args:
375 projectId: string, Project ID of the dataset being updated (required)
376 datasetId: string, Dataset ID of the dataset being updated (required)
377 body: object, The request body. (required)
378 The object takes the form of:
379
380{
381 "kind": "bigquery#dataset", # [Output-only] The resource type.
382 "description": "A String", # [Optional] A user-friendly description of the dataset.
383 "datasetReference": { # [Required] A reference that identifies the dataset.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]384 "projectId": "A String", # [Optional] The ID of the project containing this dataset.
385 "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]386 },
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]387 "labels": { # [Experimental] The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Labeling Datasets for more information.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]388 "a_key": "A String",
389 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]390 "creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
391 "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;
392 {
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]393 "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]394 "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]395 "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.
396 "groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to.
397 "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.
398 "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]399 "projectId": "A String", # [Required] The ID of the project containing this table.
400 "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.
401 "datasetId": "A String", # [Required] The ID of the dataset containing this table.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]402 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]403 },
404 ],
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]405 "defaultTableExpirationMs": "A String", # [Optional] 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]406 "etag": "A String", # [Output-only] A hash of the resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]407 "location": "A String", # [Experimental] The geographic location where the dataset should reside. Possible values include EU and US. The default value is US.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]408 "friendlyName": "A String", # [Optional] A descriptive name for the dataset.
409 "lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
410 "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.
411 "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.
412 }
413
414
415Returns:
416 An object of the form:
417
418 {
419 "kind": "bigquery#dataset", # [Output-only] The resource type.
420 "description": "A String", # [Optional] A user-friendly description of the dataset.
421 "datasetReference": { # [Required] A reference that identifies the dataset.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]422 "projectId": "A String", # [Optional] The ID of the project containing this dataset.
423 "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]424 },
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]425 "labels": { # [Experimental] The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Labeling Datasets for more information.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]426 "a_key": "A String",
427 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]428 "creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
429 "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;
430 {
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]431 "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]432 "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]433 "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.
434 "groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to.
435 "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.
436 "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]437 "projectId": "A String", # [Required] The ID of the project containing this table.
438 "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.
439 "datasetId": "A String", # [Required] The ID of the dataset containing this table.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]440 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]441 },
442 ],
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]443 "defaultTableExpirationMs": "A String", # [Optional] 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]444 "etag": "A String", # [Output-only] A hash of the resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]445 "location": "A String", # [Experimental] The geographic location where the dataset should reside. Possible values include EU and US. The default value is US.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]446 "friendlyName": "A String", # [Optional] A descriptive name for the dataset.
447 "lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
448 "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.
449 "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.
450 }</pre>
451</div>
452
453</body></html>