Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / bigquery_v2.datasets.html
blob: 7c563c175520f578810c74181b62d1f1fc28c114 [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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]84 <code><a href="#insert">insert(projectId, body=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]93 <code><a href="#patch">patch(projectId, datasetId, body=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]96 <code><a href="#update">update(projectId, datasetId, body=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]128 "labels": { # 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 Creating and Updating Dataset Labels 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 {
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[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". Maps to IAM policy member "domain:DOMAIN".
135 "userByEmail": "A String", # [Pick one] An email address of a user to grant access to. For example: fred@example.com. Maps to IAM policy member "user:EMAIL" or "serviceAccount:EMAIL".
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. Maps to similarly-named IAM members.
137 "groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to. Maps to IAM policy member "group:GROUP".
138 "role": "A String", # [Required] An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: OWNER roles/bigquery.dataOwner WRITER roles/bigquery.dataEditor READER roles/bigquery.dataViewer This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as "OWNER".
139 "iamMember": "A String", # [Pick one] Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]140 "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]141 "projectId": "A String", # [Required] The ID of the project containing this table.
142 "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.
143 "datasetId": "A String", # [Required] The ID of the dataset containing this table.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]144 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]145 },
146 ],
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]147 "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]148 "etag": "A String", # [Output-only] A hash of the resource.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]149 "defaultEncryptionConfiguration": {
150 "kmsKeyName": "A String", # [Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
151 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]152 "location": "A String", # The geographic location where the dataset should reside. The default value is US. See details at https://cloud.google.com/bigquery/docs/locations.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]153 "friendlyName": "A String", # [Optional] A descriptive name for the dataset.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]154 "defaultPartitionExpirationMs": "A String", # [Optional] The default partition expiration for all partitioned tables in the dataset, in milliseconds. Once this property is set, all newly-created partitioned tables in the dataset will have an expirationMs property in the timePartitioning settings set to this value, and changing the value will only affect new tables, not existing ones. The storage in a partition will have an expiration time of its partition time plus this value. Setting this property overrides the use of defaultTableExpirationMs for partitioned tables: only one of defaultTableExpirationMs and defaultPartitionExpirationMs will be used for any new partitioned table. If you provide an explicit timePartitioning.expirationMs when creating or updating a partitioned table, that value takes precedence over the default partition expiration time indicated by this property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]155 "lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
156 "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.
157 "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.
158 }</pre>
159</div>
160
161<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]162 <code class="details" id="insert">insert(projectId, body=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]163 <pre>Creates a new empty dataset.
164
165Args:
166 projectId: string, Project ID of the new dataset (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]167 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]168 The object takes the form of:
169
170{
171 "kind": "bigquery#dataset", # [Output-only] The resource type.
172 "description": "A String", # [Optional] A user-friendly description of the dataset.
173 "datasetReference": { # [Required] A reference that identifies the dataset.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]174 "projectId": "A String", # [Optional] The ID of the project containing this dataset.
175 "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]176 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]177 "labels": { # 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 Creating and Updating Dataset Labels for more information.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]178 "a_key": "A String",
179 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]180 "creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
181 "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;
182 {
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]183 "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". Maps to IAM policy member "domain:DOMAIN".
184 "userByEmail": "A String", # [Pick one] An email address of a user to grant access to. For example: fred@example.com. Maps to IAM policy member "user:EMAIL" or "serviceAccount:EMAIL".
185 "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. Maps to similarly-named IAM members.
186 "groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to. Maps to IAM policy member "group:GROUP".
187 "role": "A String", # [Required] An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: OWNER roles/bigquery.dataOwner WRITER roles/bigquery.dataEditor READER roles/bigquery.dataViewer This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as "OWNER".
188 "iamMember": "A String", # [Pick one] Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]189 "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]190 "projectId": "A String", # [Required] The ID of the project containing this table.
191 "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.
192 "datasetId": "A String", # [Required] The ID of the dataset containing this table.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]193 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]194 },
195 ],
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]196 "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]197 "etag": "A String", # [Output-only] A hash of the resource.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]198 "defaultEncryptionConfiguration": {
199 "kmsKeyName": "A String", # [Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
200 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]201 "location": "A String", # The geographic location where the dataset should reside. The default value is US. See details at https://cloud.google.com/bigquery/docs/locations.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]202 "friendlyName": "A String", # [Optional] A descriptive name for the dataset.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]203 "defaultPartitionExpirationMs": "A String", # [Optional] The default partition expiration for all partitioned tables in the dataset, in milliseconds. Once this property is set, all newly-created partitioned tables in the dataset will have an expirationMs property in the timePartitioning settings set to this value, and changing the value will only affect new tables, not existing ones. The storage in a partition will have an expiration time of its partition time plus this value. Setting this property overrides the use of defaultTableExpirationMs for partitioned tables: only one of defaultTableExpirationMs and defaultPartitionExpirationMs will be used for any new partitioned table. If you provide an explicit timePartitioning.expirationMs when creating or updating a partitioned table, that value takes precedence over the default partition expiration time indicated by this property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]204 "lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
205 "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.
206 "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.
207 }
208
209
210Returns:
211 An object of the form:
212
213 {
214 "kind": "bigquery#dataset", # [Output-only] The resource type.
215 "description": "A String", # [Optional] A user-friendly description of the dataset.
216 "datasetReference": { # [Required] A reference that identifies the dataset.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]217 "projectId": "A String", # [Optional] The ID of the project containing this dataset.
218 "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]219 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]220 "labels": { # 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 Creating and Updating Dataset Labels for more information.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]221 "a_key": "A String",
222 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]223 "creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
224 "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;
225 {
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]226 "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". Maps to IAM policy member "domain:DOMAIN".
227 "userByEmail": "A String", # [Pick one] An email address of a user to grant access to. For example: fred@example.com. Maps to IAM policy member "user:EMAIL" or "serviceAccount:EMAIL".
228 "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. Maps to similarly-named IAM members.
229 "groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to. Maps to IAM policy member "group:GROUP".
230 "role": "A String", # [Required] An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: OWNER roles/bigquery.dataOwner WRITER roles/bigquery.dataEditor READER roles/bigquery.dataViewer This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as "OWNER".
231 "iamMember": "A String", # [Pick one] Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]232 "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]233 "projectId": "A String", # [Required] The ID of the project containing this table.
234 "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.
235 "datasetId": "A String", # [Required] The ID of the dataset containing this table.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]236 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]237 },
238 ],
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]239 "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]240 "etag": "A String", # [Output-only] A hash of the resource.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]241 "defaultEncryptionConfiguration": {
242 "kmsKeyName": "A String", # [Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
243 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]244 "location": "A String", # The geographic location where the dataset should reside. The default value is US. See details at https://cloud.google.com/bigquery/docs/locations.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]245 "friendlyName": "A String", # [Optional] A descriptive name for the dataset.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]246 "defaultPartitionExpirationMs": "A String", # [Optional] The default partition expiration for all partitioned tables in the dataset, in milliseconds. Once this property is set, all newly-created partitioned tables in the dataset will have an expirationMs property in the timePartitioning settings set to this value, and changing the value will only affect new tables, not existing ones. The storage in a partition will have an expiration time of its partition time plus this value. Setting this property overrides the use of defaultTableExpirationMs for partitioned tables: only one of defaultTableExpirationMs and defaultPartitionExpirationMs will be used for any new partitioned table. If you provide an explicit timePartitioning.expirationMs when creating or updating a partitioned table, that value takes precedence over the default partition expiration time indicated by this property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]247 "lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
248 "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.
249 "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.
250 }</pre>
251</div>
252
253<div class="method">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]254 <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]255 <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]256
257Args:
258 projectId: string, Project ID of the datasets to be listed (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]259 filter: string, An expression for filtering the results of the request by label. The syntax is "labels.&lt;name&gt;[:&lt;value&gt;]". 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]260 all: boolean, Whether to list all datasets, including hidden ones
261 pageToken: string, Page token, returned by a previous call, to request the next page of results
262 maxResults: integer, The maximum number of results to return
263
264Returns:
265 An object of the form:
266
267 {
268 "nextPageToken": "A String", # A token that can be used to request the next results page. This property is omitted on the final results page.
269 "kind": "bigquery#datasetList", # The list type. This property always returns the value "bigquery#datasetList".
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]270 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]271 "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.
272 {
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]273 "kind": "bigquery#dataset", # The resource type. This property always returns the value "bigquery#dataset".
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]274 "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]275 "projectId": "A String", # [Optional] The ID of the project containing this dataset.
276 "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]277 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]278 "labels": { # The labels associated with this dataset. You can use these to organize and group your datasets.
279 "a_key": "A String",
280 },
281 "location": "A String", # The geographic location where the data resides.
282 "friendlyName": "A String", # A descriptive name for the dataset, if one exists.
283 "id": "A String", # The fully-qualified, unique, opaque ID of the dataset.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]284 },
285 ],
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]286 }</pre>
287</div>
288
289<div class="method">
290 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
291 <pre>Retrieves the next page of results.
292
293Args:
294 previous_request: The request for the previous page. (required)
295 previous_response: The response from the request for the previous page. (required)
296
297Returns:
298 A request object that you can call 'execute()' on to request the next
299 page. Returns None if there are no more items in the collection.
300 </pre>
301</div>
302
303<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]304 <code class="details" id="patch">patch(projectId, datasetId, body=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]305 <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.
306
307Args:
308 projectId: string, Project ID of the dataset being updated (required)
309 datasetId: string, Dataset ID of the dataset being updated (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]310 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]311 The object takes the form of:
312
313{
314 "kind": "bigquery#dataset", # [Output-only] The resource type.
315 "description": "A String", # [Optional] A user-friendly description of the dataset.
316 "datasetReference": { # [Required] A reference that identifies the dataset.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]317 "projectId": "A String", # [Optional] The ID of the project containing this dataset.
318 "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]319 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]320 "labels": { # 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 Creating and Updating Dataset Labels for more information.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]321 "a_key": "A String",
322 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]323 "creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
324 "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;
325 {
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]326 "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". Maps to IAM policy member "domain:DOMAIN".
327 "userByEmail": "A String", # [Pick one] An email address of a user to grant access to. For example: fred@example.com. Maps to IAM policy member "user:EMAIL" or "serviceAccount:EMAIL".
328 "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. Maps to similarly-named IAM members.
329 "groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to. Maps to IAM policy member "group:GROUP".
330 "role": "A String", # [Required] An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: OWNER roles/bigquery.dataOwner WRITER roles/bigquery.dataEditor READER roles/bigquery.dataViewer This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as "OWNER".
331 "iamMember": "A String", # [Pick one] Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]332 "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]333 "projectId": "A String", # [Required] The ID of the project containing this table.
334 "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.
335 "datasetId": "A String", # [Required] The ID of the dataset containing this table.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]336 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]337 },
338 ],
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]339 "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]340 "etag": "A String", # [Output-only] A hash of the resource.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]341 "defaultEncryptionConfiguration": {
342 "kmsKeyName": "A String", # [Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
343 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]344 "location": "A String", # The geographic location where the dataset should reside. The default value is US. See details at https://cloud.google.com/bigquery/docs/locations.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]345 "friendlyName": "A String", # [Optional] A descriptive name for the dataset.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]346 "defaultPartitionExpirationMs": "A String", # [Optional] The default partition expiration for all partitioned tables in the dataset, in milliseconds. Once this property is set, all newly-created partitioned tables in the dataset will have an expirationMs property in the timePartitioning settings set to this value, and changing the value will only affect new tables, not existing ones. The storage in a partition will have an expiration time of its partition time plus this value. Setting this property overrides the use of defaultTableExpirationMs for partitioned tables: only one of defaultTableExpirationMs and defaultPartitionExpirationMs will be used for any new partitioned table. If you provide an explicit timePartitioning.expirationMs when creating or updating a partitioned table, that value takes precedence over the default partition expiration time indicated by this property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]347 "lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
348 "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.
349 "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.
350 }
351
352
353Returns:
354 An object of the form:
355
356 {
357 "kind": "bigquery#dataset", # [Output-only] The resource type.
358 "description": "A String", # [Optional] A user-friendly description of the dataset.
359 "datasetReference": { # [Required] A reference that identifies the dataset.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]360 "projectId": "A String", # [Optional] The ID of the project containing this dataset.
361 "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]362 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]363 "labels": { # 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 Creating and Updating Dataset Labels for more information.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]364 "a_key": "A String",
365 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]366 "creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
367 "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;
368 {
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]369 "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". Maps to IAM policy member "domain:DOMAIN".
370 "userByEmail": "A String", # [Pick one] An email address of a user to grant access to. For example: fred@example.com. Maps to IAM policy member "user:EMAIL" or "serviceAccount:EMAIL".
371 "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. Maps to similarly-named IAM members.
372 "groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to. Maps to IAM policy member "group:GROUP".
373 "role": "A String", # [Required] An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: OWNER roles/bigquery.dataOwner WRITER roles/bigquery.dataEditor READER roles/bigquery.dataViewer This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as "OWNER".
374 "iamMember": "A String", # [Pick one] Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]375 "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]376 "projectId": "A String", # [Required] The ID of the project containing this table.
377 "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.
378 "datasetId": "A String", # [Required] The ID of the dataset containing this table.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]379 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]380 },
381 ],
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]382 "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]383 "etag": "A String", # [Output-only] A hash of the resource.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]384 "defaultEncryptionConfiguration": {
385 "kmsKeyName": "A String", # [Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
386 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]387 "location": "A String", # The geographic location where the dataset should reside. The default value is US. See details at https://cloud.google.com/bigquery/docs/locations.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]388 "friendlyName": "A String", # [Optional] A descriptive name for the dataset.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]389 "defaultPartitionExpirationMs": "A String", # [Optional] The default partition expiration for all partitioned tables in the dataset, in milliseconds. Once this property is set, all newly-created partitioned tables in the dataset will have an expirationMs property in the timePartitioning settings set to this value, and changing the value will only affect new tables, not existing ones. The storage in a partition will have an expiration time of its partition time plus this value. Setting this property overrides the use of defaultTableExpirationMs for partitioned tables: only one of defaultTableExpirationMs and defaultPartitionExpirationMs will be used for any new partitioned table. If you provide an explicit timePartitioning.expirationMs when creating or updating a partitioned table, that value takes precedence over the default partition expiration time indicated by this property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]390 "lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
391 "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.
392 "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.
393 }</pre>
394</div>
395
396<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]397 <code class="details" id="update">update(projectId, datasetId, body=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]398 <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.
399
400Args:
401 projectId: string, Project ID of the dataset being updated (required)
402 datasetId: string, Dataset ID of the dataset being updated (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]403 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]404 The object takes the form of:
405
406{
407 "kind": "bigquery#dataset", # [Output-only] The resource type.
408 "description": "A String", # [Optional] A user-friendly description of the dataset.
409 "datasetReference": { # [Required] A reference that identifies the dataset.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]410 "projectId": "A String", # [Optional] The ID of the project containing this dataset.
411 "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]412 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]413 "labels": { # 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 Creating and Updating Dataset Labels for more information.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]414 "a_key": "A String",
415 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]416 "creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
417 "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;
418 {
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]419 "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". Maps to IAM policy member "domain:DOMAIN".
420 "userByEmail": "A String", # [Pick one] An email address of a user to grant access to. For example: fred@example.com. Maps to IAM policy member "user:EMAIL" or "serviceAccount:EMAIL".
421 "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. Maps to similarly-named IAM members.
422 "groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to. Maps to IAM policy member "group:GROUP".
423 "role": "A String", # [Required] An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: OWNER roles/bigquery.dataOwner WRITER roles/bigquery.dataEditor READER roles/bigquery.dataViewer This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as "OWNER".
424 "iamMember": "A String", # [Pick one] Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]425 "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]426 "projectId": "A String", # [Required] The ID of the project containing this table.
427 "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.
428 "datasetId": "A String", # [Required] The ID of the dataset containing this table.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]429 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]430 },
431 ],
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]432 "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]433 "etag": "A String", # [Output-only] A hash of the resource.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]434 "defaultEncryptionConfiguration": {
435 "kmsKeyName": "A String", # [Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
436 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]437 "location": "A String", # The geographic location where the dataset should reside. The default value is US. See details at https://cloud.google.com/bigquery/docs/locations.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]438 "friendlyName": "A String", # [Optional] A descriptive name for the dataset.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]439 "defaultPartitionExpirationMs": "A String", # [Optional] The default partition expiration for all partitioned tables in the dataset, in milliseconds. Once this property is set, all newly-created partitioned tables in the dataset will have an expirationMs property in the timePartitioning settings set to this value, and changing the value will only affect new tables, not existing ones. The storage in a partition will have an expiration time of its partition time plus this value. Setting this property overrides the use of defaultTableExpirationMs for partitioned tables: only one of defaultTableExpirationMs and defaultPartitionExpirationMs will be used for any new partitioned table. If you provide an explicit timePartitioning.expirationMs when creating or updating a partitioned table, that value takes precedence over the default partition expiration time indicated by this property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]440 "lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
441 "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.
442 "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.
443 }
444
445
446Returns:
447 An object of the form:
448
449 {
450 "kind": "bigquery#dataset", # [Output-only] The resource type.
451 "description": "A String", # [Optional] A user-friendly description of the dataset.
452 "datasetReference": { # [Required] A reference that identifies the dataset.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]453 "projectId": "A String", # [Optional] The ID of the project containing this dataset.
454 "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]455 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]456 "labels": { # 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 Creating and Updating Dataset Labels for more information.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]457 "a_key": "A String",
458 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]459 "creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
460 "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;
461 {
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]462 "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". Maps to IAM policy member "domain:DOMAIN".
463 "userByEmail": "A String", # [Pick one] An email address of a user to grant access to. For example: fred@example.com. Maps to IAM policy member "user:EMAIL" or "serviceAccount:EMAIL".
464 "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. Maps to similarly-named IAM members.
465 "groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to. Maps to IAM policy member "group:GROUP".
466 "role": "A String", # [Required] An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: OWNER roles/bigquery.dataOwner WRITER roles/bigquery.dataEditor READER roles/bigquery.dataViewer This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as "OWNER".
467 "iamMember": "A String", # [Pick one] Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]468 "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]469 "projectId": "A String", # [Required] The ID of the project containing this table.
470 "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.
471 "datasetId": "A String", # [Required] The ID of the dataset containing this table.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]472 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]473 },
474 ],
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]475 "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]476 "etag": "A String", # [Output-only] A hash of the resource.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]477 "defaultEncryptionConfiguration": {
478 "kmsKeyName": "A String", # [Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
479 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]480 "location": "A String", # The geographic location where the dataset should reside. The default value is US. See details at https://cloud.google.com/bigquery/docs/locations.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]481 "friendlyName": "A String", # [Optional] A descriptive name for the dataset.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]482 "defaultPartitionExpirationMs": "A String", # [Optional] The default partition expiration for all partitioned tables in the dataset, in milliseconds. Once this property is set, all newly-created partitioned tables in the dataset will have an expirationMs property in the timePartitioning settings set to this value, and changing the value will only affect new tables, not existing ones. The storage in a partition will have an expiration time of its partition time plus this value. Setting this property overrides the use of defaultTableExpirationMs for partitioned tables: only one of defaultTableExpirationMs and defaultPartitionExpirationMs will be used for any new partitioned table. If you provide an explicit timePartitioning.expirationMs when creating or updating a partitioned table, that value takes precedence over the default partition expiration time indicated by this property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]483 "lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
484 "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.
485 "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.
486 }</pre>
487</div>
488
489</body></html>