Blame - docs/dyn/bigquery_v2.datasets.html - platform/external/python/google-api-python-client

2020-05-01 07:42:23 -0700

[diff] [blame]

87

<code><a href="#insert">insert(projectId, body=None)</a></code></p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

88

<p class="firstline">Creates a new empty dataset.</p>

89

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

90

<code><a href="#list">list(projectId, pageToken=None, all=None, maxResults=None, filter=None)</a></code></p>

Nathaniel Manista

4f877e5

2015-06-15 16:44:50 +0000

[diff] [blame]

91

<p class="firstline">Lists all datasets in the specified project to which you have been granted the READER dataset role.</p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

92

93

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

94

<p class="firstline">Retrieves the next page of results.</p>

95

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

96

<code><a href="#patch">patch(projectId, datasetId, body=None)</a></code></p>

John Asmuth

2014-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. This method supports patch semantics.</p>

98

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

99

<code><a href="#update">update(projectId, datasetId, body=None)</a></code></p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

100

<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>

101

<h3>Method Details</h3>

102

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

103

<code class="details" id="close">close()</code>

104

<pre>Close httplib2 connections.</pre>

</div>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

108

<code class="details" id="delete">delete(projectId, datasetId, deleteContents=None)</code>

109

<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.

110

111

Args:

112

projectId: string, Project ID of the dataset being deleted (required)

113

datasetId: string, Dataset ID of dataset being deleted (required)

114

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

</pre>

</div>

<code class="details" id="get">get(projectId, datasetId)</code>

120

<pre>Returns the dataset specified by datasetID.

121

122

Args:

123

projectId: string, Project ID of the requested dataset (required)

124

datasetId: string, Dataset ID of the requested dataset (required)

125

126

Returns:

127

An object of the form:

128

129

{

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

130

"friendlyName": "A String", # [Optional] A descriptive name for the dataset.

131

"lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

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

{

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

134

"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".

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

135

"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.

136

"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.

137

"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".

138

"routine": { # [Pick one] A routine from a different dataset to grant access to. Queries executed against that routine will have read access to views/tables/routines in this dataset. Only UDF is supported for now. The role field is not required when this field is set. If that routine is updated by any user, access to the routine needs to be granted again via an update operation.

139

"routineId": "A String", # [Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.

140

"projectId": "A String", # [Required] The ID of the project containing this routine.

141

"datasetId": "A String", # [Required] The ID of the dataset containing this routine.

142

},

143

"groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to. Maps to IAM policy member "group:GROUP".

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

144

"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.

145

"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.

146

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

147

"projectId": "A String", # [Required] The ID of the project containing this table.

148

},

149

"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".

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

150

},

151

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

152

"satisfiesPZS": True or False, # [Output-only] Reserved for future use.

153

"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.

154

"kind": "bigquery#dataset", # [Output-only] The resource type.

155

"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.

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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

157

"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.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

158

"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.

159

"a_key": "A String",

160

},

161

"defaultEncryptionConfiguration": {

162

"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.

163

},

164

"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.

165

"etag": "A String", # [Output-only] A hash of the resource.

166

"description": "A String", # [Optional] A user-friendly description of the dataset.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

167

"datasetReference": { # [Required] A reference that identifies the dataset.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

168

"projectId": "A String", # [Optional] The ID of the project containing this dataset.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

169

"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.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

170

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

171

"creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

172

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

176

<code class="details" id="insert">insert(projectId, body=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

177

<pre>Creates a new empty dataset.

178

179

Args:

180

projectId: string, Project ID of the new dataset (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

181

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

182

The object takes the form of:

183

184

{

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

185

"friendlyName": "A String", # [Optional] A descriptive name for the dataset.

186

"lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

187

"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;

188

{

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

189

"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".

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

190

"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.

191

"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.

192

"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".

193

"routine": { # [Pick one] A routine from a different dataset to grant access to. Queries executed against that routine will have read access to views/tables/routines in this dataset. Only UDF is supported for now. The role field is not required when this field is set. If that routine is updated by any user, access to the routine needs to be granted again via an update operation.

194

"routineId": "A String", # [Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.

195

"projectId": "A String", # [Required] The ID of the project containing this routine.

196

"datasetId": "A String", # [Required] The ID of the dataset containing this routine.

197

},

198

"groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to. Maps to IAM policy member "group:GROUP".

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

199

"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.

200

"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.

201

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

202

"projectId": "A String", # [Required] The ID of the project containing this table.

203

},

204

"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".

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

205

},

206

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

207

"satisfiesPZS": True or False, # [Output-only] Reserved for future use.

208

"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.

209

"kind": "bigquery#dataset", # [Output-only] The resource type.

210

"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.

211

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

212

"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.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

213

"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.

214

"a_key": "A String",

215

},

216

"defaultEncryptionConfiguration": {

217

"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.

218

},

219

"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.

220

"etag": "A String", # [Output-only] A hash of the resource.

221

"description": "A String", # [Optional] A user-friendly description of the dataset.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

222

"datasetReference": { # [Required] A reference that identifies the dataset.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

223

"projectId": "A String", # [Optional] The ID of the project containing this dataset.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

224

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

225

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

226

"creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

227

}

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

228

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

229

230

Returns:

231

An object of the form:

232

233

{

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

234

"friendlyName": "A String", # [Optional] A descriptive name for the dataset.

235

"lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

236

"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;

237

{

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

238

"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".

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

239

"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.

240

"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.

241

"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".

242

"routine": { # [Pick one] A routine from a different dataset to grant access to. Queries executed against that routine will have read access to views/tables/routines in this dataset. Only UDF is supported for now. The role field is not required when this field is set. If that routine is updated by any user, access to the routine needs to be granted again via an update operation.

243

"routineId": "A String", # [Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.

244

"projectId": "A String", # [Required] The ID of the project containing this routine.

245

"datasetId": "A String", # [Required] The ID of the dataset containing this routine.

246

},

247

"groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to. Maps to IAM policy member "group:GROUP".

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

248

"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.

249

"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.

250

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

251

"projectId": "A String", # [Required] The ID of the project containing this table.

252

},

253

"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".

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

254

},

255

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

256

"satisfiesPZS": True or False, # [Output-only] Reserved for future use.

257

"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.

258

"kind": "bigquery#dataset", # [Output-only] The resource type.

259

"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.

260

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

261

"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.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

262

"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.

263

"a_key": "A String",

264

},

265

"defaultEncryptionConfiguration": {

266

"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.

267

},

268

"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.

269

"etag": "A String", # [Output-only] A hash of the resource.

270

"description": "A String", # [Optional] A user-friendly description of the dataset.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

271

"datasetReference": { # [Required] A reference that identifies the dataset.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

272

"projectId": "A String", # [Optional] The ID of the project containing this dataset.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

273

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

274

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

275

"creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

}</pre>

</div>

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

280

<code class="details" id="list">list(projectId, pageToken=None, all=None, maxResults=None, filter=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

281

<pre>Lists all datasets in the specified project to which you have been granted the READER dataset role.

282

283

Args:

284

projectId: string, Project ID of the datasets to be listed (required)

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

285

pageToken: string, Page token, returned by a previous call, to request the next page of results

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

286

all: boolean, Whether to list all datasets, including hidden ones

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

287

maxResults: integer, The maximum number of results to return

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

288

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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

289

290

Returns:

291

An object of the form:

292

293

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

294

"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.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

295

{

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

296

"location": "A String", # The geographic location where the data resides.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

297

"kind": "bigquery#dataset", # The resource type. This property always returns the value "bigquery#dataset".

298

"labels": { # The labels associated with this dataset. You can use these to organize and group your datasets.

299

"a_key": "A String",

300

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

301

"datasetReference": { # The dataset reference. Use this property to access specific parts of the dataset's ID, such as project ID or dataset ID.

302

"projectId": "A String", # [Optional] The ID of the project containing this dataset.

303

"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.

304

},

305

"id": "A String", # The fully-qualified, unique, opaque ID of the dataset.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

306

"friendlyName": "A String", # A descriptive name for the dataset, if one exists.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

307

},

308

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

309

"nextPageToken": "A String", # A token that can be used to request the next results page. This property is omitted on the final results page.

310

"kind": "bigquery#datasetList", # The list type. This property always returns the value "bigquery#datasetList".

311

"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 Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

317

<pre>Retrieves the next page of results.

318

319

Args:

320

previous_request: The request for the previous page. (required)

321

previous_response: The response from the request for the previous page. (required)

322

323

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

324

A request object that you can call 'execute()' on to request the next

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

325

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

330

<code class="details" id="patch">patch(projectId, datasetId, body=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

331

<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.

332

333

Args:

334

projectId: string, Project ID of the dataset being updated (required)

335

datasetId: string, Dataset ID of the dataset being updated (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

336

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

337

The object takes the form of:

338

339

{

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

340

"friendlyName": "A String", # [Optional] A descriptive name for the dataset.

341

"lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

342

"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;

343

{

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

344

"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".

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

345

"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.

346

"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.

347

"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".

348

"routine": { # [Pick one] A routine from a different dataset to grant access to. Queries executed against that routine will have read access to views/tables/routines in this dataset. Only UDF is supported for now. The role field is not required when this field is set. If that routine is updated by any user, access to the routine needs to be granted again via an update operation.

349

"routineId": "A String", # [Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.

350

"projectId": "A String", # [Required] The ID of the project containing this routine.

351

"datasetId": "A String", # [Required] The ID of the dataset containing this routine.

352

},

353

"groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to. Maps to IAM policy member "group:GROUP".

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

354

"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.

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.

357

"projectId": "A String", # [Required] The ID of the project containing this table.

358

},

359

"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".

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

360

},

361

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

362

"satisfiesPZS": True or False, # [Output-only] Reserved for future use.

363

"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.

364

"kind": "bigquery#dataset", # [Output-only] The resource type.

365

"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.

366

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

367

"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.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

368

"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.

369

"a_key": "A String",

370

},

371

"defaultEncryptionConfiguration": {

372

"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.

373

},

374

"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.

375

"etag": "A String", # [Output-only] A hash of the resource.

376

"description": "A String", # [Optional] A user-friendly description of the dataset.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

377

"datasetReference": { # [Required] A reference that identifies the dataset.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

378

"projectId": "A String", # [Optional] The ID of the project containing this dataset.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

379

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

380

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

381

"creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

382

}

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

Returns:

An object of the form:

387

388

{

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

389

"friendlyName": "A String", # [Optional] A descriptive name for the dataset.

390

"lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

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

{

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

393

"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".

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

394

"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.

395

"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.

396

"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".

397

"routine": { # [Pick one] A routine from a different dataset to grant access to. Queries executed against that routine will have read access to views/tables/routines in this dataset. Only UDF is supported for now. The role field is not required when this field is set. If that routine is updated by any user, access to the routine needs to be granted again via an update operation.

398

"routineId": "A String", # [Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.

399

"projectId": "A String", # [Required] The ID of the project containing this routine.

400

"datasetId": "A String", # [Required] The ID of the dataset containing this routine.

401

},

402

"groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to. Maps to IAM policy member "group:GROUP".

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

403

"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.

404

"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.

405

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

406

"projectId": "A String", # [Required] The ID of the project containing this table.

407

},

408

"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".

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

409

},

410

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

411

"satisfiesPZS": True or False, # [Output-only] Reserved for future use.

412

"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.

413

"kind": "bigquery#dataset", # [Output-only] The resource type.

414

"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.

415

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

416

"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.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

417

"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.

418

"a_key": "A String",

419

},

420

"defaultEncryptionConfiguration": {

421

"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.

422

},

423

"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.

424

"etag": "A String", # [Output-only] A hash of the resource.

425

"description": "A String", # [Optional] A user-friendly description of the dataset.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

426

"datasetReference": { # [Required] A reference that identifies the dataset.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

427

"projectId": "A String", # [Optional] The ID of the project containing this dataset.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

428

"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.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

429

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

430

"creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

431

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

435

<code class="details" id="update">update(projectId, datasetId, body=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

436

<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.

437

438

Args:

439

projectId: string, Project ID of the dataset being updated (required)

440

datasetId: string, Dataset ID of the dataset being updated (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

441

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

442

The object takes the form of:

443

444

{

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

445

"friendlyName": "A String", # [Optional] A descriptive name for the dataset.

446

"lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

447

"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;

448

{

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

449

"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".

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

450

"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.

451

"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.

452

"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".

453

"routine": { # [Pick one] A routine from a different dataset to grant access to. Queries executed against that routine will have read access to views/tables/routines in this dataset. Only UDF is supported for now. The role field is not required when this field is set. If that routine is updated by any user, access to the routine needs to be granted again via an update operation.

454

"routineId": "A String", # [Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.

455

"projectId": "A String", # [Required] The ID of the project containing this routine.

456

"datasetId": "A String", # [Required] The ID of the dataset containing this routine.

457

},

458

"groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to. Maps to IAM policy member "group:GROUP".

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

459

"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.

460

"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.

461

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

462

"projectId": "A String", # [Required] The ID of the project containing this table.

463

},

464

"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".

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

465

},

466

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

467

"satisfiesPZS": True or False, # [Output-only] Reserved for future use.

468

"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.

469

"kind": "bigquery#dataset", # [Output-only] The resource type.

470

"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.

471

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

472

"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.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

473

"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.

474

"a_key": "A String",

475

},

476

"defaultEncryptionConfiguration": {

477

"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.

478

},

479

"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.

480

"etag": "A String", # [Output-only] A hash of the resource.

481

"description": "A String", # [Optional] A user-friendly description of the dataset.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

482

"datasetReference": { # [Required] A reference that identifies the dataset.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

483

"projectId": "A String", # [Optional] The ID of the project containing this dataset.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

484

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

485

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

486

"creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

487

}

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

Returns:

An object of the form:

492

493

{

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

494

"friendlyName": "A String", # [Optional] A descriptive name for the dataset.

495

"lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

496

"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;

497

{

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

498

"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".

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

499

"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.

500

"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.

501

"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".

502

"routine": { # [Pick one] A routine from a different dataset to grant access to. Queries executed against that routine will have read access to views/tables/routines in this dataset. Only UDF is supported for now. The role field is not required when this field is set. If that routine is updated by any user, access to the routine needs to be granted again via an update operation.

503

"routineId": "A String", # [Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.

504

"projectId": "A String", # [Required] The ID of the project containing this routine.

505

"datasetId": "A String", # [Required] The ID of the dataset containing this routine.

506

},

507

"groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to. Maps to IAM policy member "group:GROUP".

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

508

"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.

509

"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.

510

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

511

"projectId": "A String", # [Required] The ID of the project containing this table.

512

},

513

"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".

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

514

},

515

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

516

"satisfiesPZS": True or False, # [Output-only] Reserved for future use.

517

"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.

518

"kind": "bigquery#dataset", # [Output-only] The resource type.

519

"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.

520

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

521

"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.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

522

"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.

523

"a_key": "A String",

524

},

525

"defaultEncryptionConfiguration": {

526

"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.

527

},

528

"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.

529

"etag": "A String", # [Output-only] A hash of the resource.

530

"description": "A String", # [Optional] A user-friendly description of the dataset.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

531

"datasetReference": { # [Required] A reference that identifies the dataset.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

532

"projectId": "A String", # [Optional] The ID of the project containing this dataset.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

533

"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.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

534

},

Yoshi Automation Bot