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

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

[diff] [blame^]

84

<code><a href="#getIamPolicy">getIamPolicy(resource, body=None)</a></code></p>

85

<p class="firstline">Gets the access control policy for a resource.</p>

86

Dan O'Meara

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

[diff] [blame]

87

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

John Asmuth

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

[diff] [blame]

88

<p class="firstline">Creates a new, empty table in the dataset.</p>

89

90

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

Nathaniel Manista

4f877e5

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

[diff] [blame]

91

<p class="firstline">Lists all tables in the specified dataset. Requires 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, tableId, 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 table. The update method replaces the entire table resource, whereas the patch method only replaces fields that are provided in the submitted table resource. This method supports patch semantics.</p>

98

Bu Sun Kim

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

[diff] [blame^]

99

<code><a href="#setIamPolicy">setIamPolicy(resource, body=None)</a></code></p>

100

<p class="firstline">Sets the access control policy on the specified resource. Replaces any</p>

101

102

<code><a href="#testIamPermissions">testIamPermissions(resource, body=None)</a></code></p>

103

<p class="firstline">Returns permissions that a caller has on the specified resource.</p>

104

Dan O'Meara

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

[diff] [blame]

105

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

John Asmuth

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

[diff] [blame]

106

<p class="firstline">Updates information in an existing table. The update method replaces the entire table resource, whereas the patch method only replaces fields that are provided in the submitted table resource.</p>

107

<h3>Method Details</h3>

108

109

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

110

<pre>Deletes the table specified by tableId from the dataset. If the table contains data, all the data will be deleted.

111

112

Args:

113

projectId: string, Project ID of the table to delete (required)

114

datasetId: string, Dataset ID of the table to delete (required)

115

tableId: string, Table ID of the table to delete (required)

</pre>

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

120

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

John Asmuth

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

[diff] [blame]

121

<pre>Gets the specified table resource by table ID. This method does not return the data in the table, it only returns the table resource, which describes the structure of this table.

122

123

Args:

124

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

125

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

126

tableId: string, Table ID of the requested table (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

127

selectedFields: string, List of fields to return (comma-separated). If unspecified, all fields are returned

John Asmuth

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

[diff] [blame]

128

129

Returns:

130

An object of the form:

131

132

{

Bu Sun Kim

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

[diff] [blame^]

133

"externalDataConfiguration": { # [Optional] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.

134

"googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.

135

"range": "A String", # [Optional] Range of a sheet to query from. Only used when non-empty. Typical format: sheet_name!top_left_cell_id:bottom_right_cell_id For example: sheet1!A1:B20

136

"skipLeadingRows": "A String", # [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

137

},

Bu Sun Kim

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

[diff] [blame^]

138

"autodetect": True or False, # Try to detect schema and format options automatically. Any option specified explicitly will be honored.

139

"ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.

140

"sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".

141

"csvOptions": { # Additional properties to set if sourceFormat is set to CSV.

142

"encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.

143

"allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.

144

"quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.

145

"skipLeadingRows": "A String", # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.

146

"allowJaggedRows": True or False, # [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.

147

"fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

148

},

Bu Sun Kim

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

[diff] [blame^]

149

"bigtableOptions": { # [Optional] Additional options if sourceFormat is set to BIGTABLE.

150

"columnFamilies": [ # [Optional] List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

151

{

Bu Sun Kim

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

[diff] [blame^]

152

"onlyReadLatest": True or False, # [Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.

153

"encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.

154

"columns": [ # [Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

155

{

Bu Sun Kim

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

[diff] [blame^]

156

"qualifierEncoded": "A String", # [Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name.

157

"onlyReadLatest": True or False, # [Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.

158

"fieldName": "A String", # [Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries.

159

"qualifierString": "A String",

160

"encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.

161

"type": "A String", # [Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

162

},

163

],

Bu Sun Kim

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

[diff] [blame^]

164

"type": "A String", # [Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.

165

"familyId": "A String", # Identifier of the column family.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

166

},

167

],

Bu Sun Kim

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

[diff] [blame^]

168

"ignoreUnspecifiedColumnFamilies": True or False, # [Optional] If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.

169

"readRowkeyAsString": True or False, # [Optional] If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

170

},

Bu Sun Kim

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

[diff] [blame^]

171

"compression": "A String", # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.

172

"schema": { # [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.

173

"fields": [ # Describes the fields in a table.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

174

{

Bu Sun Kim

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

[diff] [blame^]

175

"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

176

# Object with schema name: TableFieldSchema

177

],

Bu Sun Kim

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

[diff] [blame^]

178

"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.

179

"type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).

180

"categories": { # [Optional] The categories attached to this field, used for field-level access control.

181

"names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

182

"A String",

Dan O'Meara

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

[diff] [blame]

183

],

184

},

Bu Sun Kim

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

[diff] [blame^]

185

"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

186

"description": "A String", # [Optional] The field description. The maximum length is 1,024 characters.

187

"policyTags": {

188

"names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.

189

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

190

],

191

},

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

192

},

193

],

194

},

Bu Sun Kim

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

[diff] [blame^]

195

"hivePartitioningOptions": { # [Optional, Trusted Tester] Options to configure hive partitioning support.

196

"sourceUriPrefix": "A String", # [Optional, Trusted Tester] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).

197

"mode": "A String", # [Optional, Trusted Tester] When set, what mode of hive partitioning to use when reading data. Two modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.

198

},

199

"maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV, JSON, and Google Sheets. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.

200

"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '*' wildcard character is not allowed.

201

"A String",

202

],

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

203

},

Bu Sun Kim

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

[diff] [blame^]

204

"model": { # [Output-only, Beta] Present iff this table represents a ML model. Describes the training information for the model, and it is required to run 'PREDICT' queries.

205

"modelOptions": { # [Output-only, Beta] Model options used for the first training run. These options are immutable for subsequent training runs. Default values are used for any options not specified in the input query.

"labels": [

"A String",

],

"lossType": "A String",

210

"modelType": "A String",

211

},

212

"trainingRuns": [ # [Output-only, Beta] Information about ml training runs, each training run comprises of multiple iterations and there may be multiple training runs for the model if warm start is used or if a user decides to continue a previously cancelled query.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

213

{

Bu Sun Kim

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

[diff] [blame^]

214

"trainingOptions": { # [Output-only, Beta] Training options used by this training run. These options are mutable for subsequent training runs. Default values are explicitly stored for options not specified in the input query of the first training run. For subsequent training runs, any option not explicitly specified in the input query will be copied from the previous training run.

215

"minRelProgress": 3.14,

216

"l2Reg": 3.14,

217

"learnRateStrategy": "A String",

218

"warmStart": True or False,

219

"lineSearchInitLearnRate": 3.14,

220

"earlyStop": True or False,

221

"l1Reg": 3.14,

222

"maxIteration": "A String",

223

"learnRate": 3.14,

224

},

225

"state": "A String", # [Output-only, Beta] Different state applicable for a training run. IN PROGRESS: Training run is in progress. FAILED: Training run ended due to a non-retryable failure. SUCCEEDED: Training run successfully completed. CANCELLED: Training run cancelled by the user.

226

"iterationResults": [ # [Output-only, Beta] List of each iteration results.

227

{

228

"durationMs": "A String", # [Output-only, Beta] Time taken to run the training iteration in milliseconds.

229

"trainingLoss": 3.14, # [Output-only, Beta] Training loss computed on the training data at the end of the iteration. The training loss function is defined by model type.

230

"evalLoss": 3.14, # [Output-only, Beta] Eval loss computed on the eval data at the end of the iteration. The eval loss is used for early stopping to avoid overfitting. No eval loss if eval_split_method option is specified as no_split or auto_split with input data size less than 500 rows.

231

"index": 42, # [Output-only, Beta] Index of the ML training iteration, starting from zero for each training run.

232

"learnRate": 3.14, # [Output-only, Beta] Learning rate used for this iteration, it varies for different training iterations if learn_rate_strategy option is not constant.

233

},

234

],

235

"startTime": "A String", # [Output-only, Beta] Training run start time in milliseconds since the epoch.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

236

},

237

],

238

},

Bu Sun Kim

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

[diff] [blame^]

239

"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.

240

"expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created tables.

241

"kind": "bigquery#table", # [Output-only] The type of the resource.

242

"description": "A String", # [Optional] A user-friendly description of this table.

243

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

244

"rangePartitioning": { # [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

245

"range": { # [TrustedTester] [Required] Defines the ranges for range partitioning.

246

"interval": "A String", # [TrustedTester] [Required] The width of each interval.

247

"start": "A String", # [TrustedTester] [Required] The start of range partitioning, inclusive.

248

"end": "A String", # [TrustedTester] [Required] The end of range partitioning, exclusive.

249

},

250

"field": "A String", # [TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.

251

},

252

"schema": { # [Optional] Describes the schema of this table.

253

"fields": [ # Describes the fields in a table.

254

{

255

"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.

256

# Object with schema name: TableFieldSchema

257

],

258

"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.

259

"type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).

260

"categories": { # [Optional] The categories attached to this field, used for field-level access control.

261

"names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

"A String",

],

},

"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

266

"description": "A String", # [Optional] The field description. The maximum length is 1,024 characters.

267

"policyTags": {

268

"names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.

"A String",

],

},

},

],

},

"id": "A String", # [Output-only] An opaque ID uniquely identifying the table.

276

"requirePartitionFilter": false, # [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.

277

"materializedView": { # [Optional] Materialized view definition.

278

"query": "A String", # [Required] A query whose result is persisted.

279

"enableRefresh": True or False, # [Optional] [TrustedTester] Enable automatic refresh of the materialized view when the base table is updated. The default value is "true".

280

"refreshIntervalMs": "A String", # [Optional] [TrustedTester] The maximum frequency at which this materialized view will be refreshed. The default value is "1800000" (30 minutes).

281

"lastRefreshTime": "A String", # [Output-only] [TrustedTester] The time when this materialized view was last modified, in milliseconds since the epoch.

282

},

283

"tableReference": { # [Required] Reference describing the ID of this table.

284

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

285

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

286

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

287

},

288

"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.

289

"numRows": "A String", # [Output-only] The number of rows of data in this table, excluding any data in the streaming buffer.

290

"clustering": { # [Beta] Clustering specification for the table. Must be specified with partitioning, data in the table will be first partitioned and subsequently clustered.

291

"fields": [ # [Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.

"A String",

],

},

"type": "A String", # [Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. [TrustedTester] MATERIALIZED_VIEW: SQL query whose result is persisted. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE.

296

"view": { # [Optional] The view definition.

297

"useLegacySql": True or False, # Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ Queries and views that reference this view must use the same flag value.

298

"query": "A String", # [Required] A query that BigQuery executes when the view is referenced.

299

"userDefinedFunctionResources": [ # Describes user-defined function resources used in the query.

300

{

301

"resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).

302

"inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.

},

],

},

"numLongTermBytes": "A String", # [Output-only] The number of bytes in the table that are considered "long-term storage".

307

"etag": "A String", # [Output-only] A hash of the table metadata. Used to ensure there were no concurrent modifications to the resource when attempting an update. Not guaranteed to change when the table contents or the fields numRows, numBytes, numLongTermBytes or lastModifiedTime change.

308

"encryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys).

309

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

310

},

311

"streamingBuffer": { # [Output-only] Contains information regarding this table's streaming buffer, if one is present. This field will be absent if the table is not being streamed to or if there is no data in the streaming buffer.

312

"estimatedBytes": "A String", # [Output-only] A lower-bound estimate of the number of bytes currently in the streaming buffer.

313

"estimatedRows": "A String", # [Output-only] A lower-bound estimate of the number of rows currently in the streaming buffer.

314

"oldestEntryTime": "A String", # [Output-only] Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.

315

},

316

"numBytes": "A String", # [Output-only] The size of this table in bytes, excluding any data in the streaming buffer.

317

"location": "A String", # [Output-only] The geographic location where the table resides. This value is inherited from the dataset.

318

"friendlyName": "A String", # [Optional] A descriptive name for this table.

319

"timePartitioning": { # Time-based partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

320

"field": "A String", # [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED.

321

"expirationMs": "A String", # [Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value.

322

"type": "A String", # [Required] The only type supported is DAY, which will generate one partition per day.

323

"requirePartitionFilter": True or False,

324

},

325

"numPhysicalBytes": "A String", # [Output-only] [TrustedTester] The physical size of this table in bytes, excluding any data in the streaming buffer. This includes compression and storage used for time travel.

326

"labels": { # The labels associated with this table. You can use these to organize and group your tables. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.

327

"a_key": "A String",

328

},

John Asmuth

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame^]

333

<code class="details" id="getIamPolicy">getIamPolicy(resource, body=None)</code>

334

<pre>Gets the access control policy for a resource.

335

Returns an empty policy if the resource exists and does not have a policy

set.

Args:

resource: string, REQUIRED: The resource for which the policy is being requested.

340

See the operation documentation for the appropriate value for this field. (required)

341

body: object, The request body.

342

The object takes the form of:

343

344

{ # Request message for `GetIamPolicy` method.

345

"options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to

346

# `GetIamPolicy`.

347

"requestedPolicyVersion": 42, # Optional. The policy format version to be returned.

348

#

349

# Valid values are 0, 1, and 3. Requests specifying an invalid value will be

350

# rejected.

351

#

352

# Requests for policies with any conditional bindings must specify version 3.

353

# Policies without any conditional bindings may specify any valid value or

354

# leave the field unset.

355

#

356

# To learn which resources support conditions in their IAM policies, see the

357

# [IAM

358

# documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

},

}

Returns:

An object of the form:

365

366

{ # An Identity and Access Management (IAM) policy, which specifies access

367

# controls for Google Cloud resources.

368

#

369

#

370

# A `Policy` is a collection of `bindings`. A `binding` binds one or more

371

# `members` to a single `role`. Members can be user accounts, service accounts,

372

# Google groups, and domains (such as G Suite). A `role` is a named list of

373

# permissions; each `role` can be an IAM predefined role or a user-created

374

# custom role.

375

#

376

# For some types of Google Cloud resources, a `binding` can also specify a

377

# `condition`, which is a logical expression that allows access to a resource

378

# only if the expression evaluates to `true`. A condition can add constraints

379

# based on attributes of the request, the resource, or both. To learn which

380

# resources support conditions in their IAM policies, see the

381

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

#

# **JSON example:**

#

# {

# "bindings": [

# {

# "role": "roles/resourcemanager.organizationAdmin",

389

# "members": [

390

# "user:mike@example.com",

391

# "group:admins@example.com",

392

# "domain:google.com",

393

# "serviceAccount:my-project-id@appspot.gserviceaccount.com"

# ]

# },

# {

# "role": "roles/resourcemanager.organizationViewer",

398

# "members": [

399

# "user:eve@example.com"

400

# ],

401

# "condition": {

402

# "title": "expirable access",

403

# "description": "Does not grant access after Sep 2020",

404

# "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",

# }

# }

# ],

# "etag": "BwWWja0YfJA=",

# "version": 3

# }

#

# **YAML example:**

#

# bindings:

# - members:

# - user:mike@example.com

417

# - group:admins@example.com

418

# - domain:google.com

419

# - serviceAccount:my-project-id@appspot.gserviceaccount.com

420

# role: roles/resourcemanager.organizationAdmin

421

# - members:

422

# - user:eve@example.com

423

# role: roles/resourcemanager.organizationViewer

424

# condition:

425

# title: expirable access

426

# description: Does not grant access after Sep 2020

427

# expression: request.time < timestamp('2020-10-01T00:00:00.000Z')

428

# - etag: BwWWja0YfJA=

429

# - version: 3

430

#

431

# For a description of IAM and its features, see the

432

# [IAM documentation](https://cloud.google.com/iam/docs/).

433

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a

434

# `condition` that determines how and when the `bindings` are applied. Each

435

# of the `bindings` must contain at least one member.

436

{ # Associates `members` with a `role`.

437

"condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.

438

#

439

# If the condition evaluates to `true`, then this binding applies to the

440

# current request.

441

#

442

# If the condition evaluates to `false`, then this binding does not apply to

443

# the current request. However, a different role binding might grant the same

444

# role to one or more of the members in this binding.

445

#

446

# To learn which resources support conditions in their IAM policies, see the

447

# [IAM

448

# documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

449

# syntax. CEL is a C-like expression language. The syntax and semantics of CEL

450

# are documented at https://github.com/google/cel-spec.

451

#

452

# Example (Comparison):

453

#

454

# title: "Summary size limit"

455

# description: "Determines if a summary is less than 100 chars"

456

# expression: "document.summary.size() < 100"

457

#

458

# Example (Equality):

459

#

460

# title: "Requestor is owner"

461

# description: "Determines if requestor is the document owner"

462

# expression: "document.owner == request.auth.claims.email"

#

# Example (Logic):

#

# title: "Public documents"

467

# description: "Determine whether the document should be publicly visible"

468

# expression: "document.type != 'private' && document.type != 'internal'"

469

#

470

# Example (Data Manipulation):

471

#

472

# title: "Notification string"

473

# description: "Create a notification string with a timestamp."

474

# expression: "'New message received at ' + string(document.create_time)"

475

#

476

# The exact variables and functions that may be referenced within an expression

477

# are determined by the service that evaluates it. See the service

478

# documentation for additional information.

479

"title": "A String", # Optional. Title for the expression, i.e. a short string describing

480

# its purpose. This can be used e.g. in UIs which allow to enter the

481

# expression.

482

"location": "A String", # Optional. String indicating the location of the expression for error

483

# reporting, e.g. a file name and a position in the file.

484

"description": "A String", # Optional. Description of the expression. This is a longer text which

485

# describes the expression, e.g. when hovered over it in a UI.

486

"expression": "A String", # Textual representation of an expression in Common Expression Language

487

# syntax.

488

},

489

"members": [ # Specifies the identities requesting access for a Cloud Platform resource.

490

# `members` can have the following values:

491

#

492

# * `allUsers`: A special identifier that represents anyone who is

493

# on the internet; with or without a Google account.

494

#

495

# * `allAuthenticatedUsers`: A special identifier that represents anyone

496

# who is authenticated with a Google account or a service account.

497

#

498

# * `user:{emailid}`: An email address that represents a specific Google

499

# account. For example, `alice@example.com` .

500

#

501

#

502

# * `serviceAccount:{emailid}`: An email address that represents a service

503

# account. For example, `my-other-app@appspot.gserviceaccount.com`.

504

#

505

# * `group:{emailid}`: An email address that represents a Google group.

506

# For example, `admins@example.com`.

507

#

508

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique

509

# identifier) representing a user that has been recently deleted. For

510

# example, `alice@example.com?uid=123456789012345678901`. If the user is

511

# recovered, this value reverts to `user:{emailid}` and the recovered user

512

# retains the role in the binding.

513

#

514

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus

515

# unique identifier) representing a service account that has been recently

516

# deleted. For example,

517

# `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.

518

# If the service account is undeleted, this value reverts to

519

# `serviceAccount:{emailid}` and the undeleted service account retains the

520

# role in the binding.

521

#

522

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique

523

# identifier) representing a Google group that has been recently

524

# deleted. For example, `admins@example.com?uid=123456789012345678901`. If

525

# the group is recovered, this value reverts to `group:{emailid}` and the

526

# recovered group retains the role in the binding.

527

#

528

#

529

# * `domain:{domain}`: The G Suite domain (primary) that represents all the

530

# users of that domain. For example, `google.com` or `example.com`.

#

"A String",

],

"role": "A String", # Role that is assigned to `members`.

535

# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

536

},

537

],

538

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help

539

# prevent simultaneous updates of a policy from overwriting each other.

540

# It is strongly suggested that systems make use of the `etag` in the

541

# read-modify-write cycle to perform policy updates in order to avoid race

542

# conditions: An `etag` is returned in the response to `getIamPolicy`, and

543

# systems are expected to put that etag in the request to `setIamPolicy` to

544

# ensure that their change will be applied to the same version of the policy.

545

#

546

# **Important:** If you use IAM Conditions, you must include the `etag` field

547

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

548

# you to overwrite a version `3` policy with a version `1` policy, and all of

549

# the conditions in the version `3` policy are lost.

550

"version": 42, # Specifies the format of the policy.

551

#

552

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value

553

# are rejected.

554

#

555

# Any operation that affects conditional role bindings must specify version

556

# `3`. This requirement applies to the following operations:

557

#

558

# * Getting a policy that includes a conditional role binding

559

# * Adding a conditional role binding to a policy

560

# * Changing a conditional role binding in a policy

561

# * Removing any role binding, with or without a condition, from a policy

562

# that includes conditions

563

#

564

# **Important:** If you use IAM Conditions, you must include the `etag` field

565

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

566

# you to overwrite a version `3` policy with a version `1` policy, and all of

567

# the conditions in the version `3` policy are lost.

568

#

569

# If a policy does not include any conditions, operations on that policy may

570

# specify any valid version or leave the field unset.

571

#

572

# To learn which resources support conditions in their IAM policies, see the

573

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

574

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

575

{ # Specifies the audit configuration for a service.

576

# The configuration determines which permission types are logged, and what

577

# identities, if any, are exempted from logging.

578

# An AuditConfig must have one or more AuditLogConfigs.

579

#

580

# If there are AuditConfigs for both `allServices` and a specific service,

581

# the union of the two AuditConfigs is used for that service: the log_types

582

# specified in each AuditConfig are enabled, and the exempted_members in each

583

# AuditLogConfig are exempted.

584

#

585

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices"

591

# "audit_log_configs": [

592

# {

593

# "log_type": "DATA_READ",

594

# "exempted_members": [

595

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

600

# },

601

# {

602

# "log_type": "ADMIN_READ",

# }

# ]

# },

# {

# "service": "sampleservice.googleapis.com"

608

# "audit_log_configs": [

609

# {

610

# "log_type": "DATA_READ",

611

# },

612

# {

613

# "log_type": "DATA_WRITE",

614

# "exempted_members": [

615

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ

624

# logging. It also exempts jose@example.com from DATA_READ logging, and

625

# aliya@example.com from DATA_WRITE logging.

626

"auditLogConfigs": [ # The configuration for logging of each type of permission.

627

{ # Provides the configuration for logging a type of permissions.

# Example:

#

# {

# "audit_log_configs": [

632

# {

633

# "log_type": "DATA_READ",

634

# "exempted_members": [

635

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

# }

# ]

# }

#

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting

645

# jose@example.com from DATA_READ logging.

646

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of

647

# permission.

648

# Follows the same format of Binding.members.

649

"A String",

650

],

651

"logType": "A String", # The log type that this config enables.

652

},

653

],

654

"service": "A String", # Specifies a service that will be enabled for audit logging.

655

# For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.

656

# `allServices` is a special value that covers all services.

},

],

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

663

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

John Asmuth

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

[diff] [blame]

664

<pre>Creates a new, empty table in the dataset.

665

666

Args:

667

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

668

datasetId: string, Dataset ID of the new table (required)

Dan O'Meara

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

[diff] [blame]

669

body: object, The request body.

John Asmuth

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

[diff] [blame]

670

The object takes the form of:

671

672

{

Bu Sun Kim

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

[diff] [blame^]

673

"externalDataConfiguration": { # [Optional] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.

674

"googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.

675

"range": "A String", # [Optional] Range of a sheet to query from. Only used when non-empty. Typical format: sheet_name!top_left_cell_id:bottom_right_cell_id For example: sheet1!A1:B20

676

"skipLeadingRows": "A String", # [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

677

},

Bu Sun Kim

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

[diff] [blame^]

678

"autodetect": True or False, # Try to detect schema and format options automatically. Any option specified explicitly will be honored.

679

"ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.

680

"sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".

681

"csvOptions": { # Additional properties to set if sourceFormat is set to CSV.

682

"encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.

683

"allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.

684

"quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.

685

"skipLeadingRows": "A String", # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.

686

"allowJaggedRows": True or False, # [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.

687

"fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

688

},

Bu Sun Kim

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

[diff] [blame^]

689

"bigtableOptions": { # [Optional] Additional options if sourceFormat is set to BIGTABLE.

690

"columnFamilies": [ # [Optional] List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

691

{

Bu Sun Kim

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

[diff] [blame^]

692

"onlyReadLatest": True or False, # [Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.

693

"encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.

694

"columns": [ # [Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

695

{

Bu Sun Kim

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

[diff] [blame^]

696

"qualifierEncoded": "A String", # [Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name.

697

"onlyReadLatest": True or False, # [Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.

698

"fieldName": "A String", # [Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries.

699

"qualifierString": "A String",

700

"encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.

701

"type": "A String", # [Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

702

},

703

],

Bu Sun Kim

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

[diff] [blame^]

704

"type": "A String", # [Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.

705

"familyId": "A String", # Identifier of the column family.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

706

},

707

],

Bu Sun Kim

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

[diff] [blame^]

708

"ignoreUnspecifiedColumnFamilies": True or False, # [Optional] If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.

709

"readRowkeyAsString": True or False, # [Optional] If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

710

},

Bu Sun Kim

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

[diff] [blame^]

711

"compression": "A String", # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.

712

"schema": { # [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.

713

"fields": [ # Describes the fields in a table.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

714

{

Bu Sun Kim

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

[diff] [blame^]

715

"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

716

# Object with schema name: TableFieldSchema

717

],

Bu Sun Kim

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

[diff] [blame^]

718

"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.

719

"type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).

720

"categories": { # [Optional] The categories attached to this field, used for field-level access control.

721

"names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

722

"A String",

Dan O'Meara

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

[diff] [blame]

723

],

724

},

Bu Sun Kim

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

[diff] [blame^]

725

"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

726

"description": "A String", # [Optional] The field description. The maximum length is 1,024 characters.

727

"policyTags": {

728

"names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.

729

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

730

],

731

},

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

732

},

733

],

734

},

Bu Sun Kim

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

[diff] [blame^]

735

"hivePartitioningOptions": { # [Optional, Trusted Tester] Options to configure hive partitioning support.

736

"sourceUriPrefix": "A String", # [Optional, Trusted Tester] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).

737

"mode": "A String", # [Optional, Trusted Tester] When set, what mode of hive partitioning to use when reading data. Two modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.

738

},

739

"maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV, JSON, and Google Sheets. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.

740

"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '*' wildcard character is not allowed.

741

"A String",

742

],

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

743

},

Bu Sun Kim

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

[diff] [blame^]

744

"model": { # [Output-only, Beta] Present iff this table represents a ML model. Describes the training information for the model, and it is required to run 'PREDICT' queries.

745

"modelOptions": { # [Output-only, Beta] Model options used for the first training run. These options are immutable for subsequent training runs. Default values are used for any options not specified in the input query.

"labels": [

"A String",

],

"lossType": "A String",

750

"modelType": "A String",

751

},

752

"trainingRuns": [ # [Output-only, Beta] Information about ml training runs, each training run comprises of multiple iterations and there may be multiple training runs for the model if warm start is used or if a user decides to continue a previously cancelled query.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

753

{

Bu Sun Kim

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

[diff] [blame^]

754

"trainingOptions": { # [Output-only, Beta] Training options used by this training run. These options are mutable for subsequent training runs. Default values are explicitly stored for options not specified in the input query of the first training run. For subsequent training runs, any option not explicitly specified in the input query will be copied from the previous training run.

755

"minRelProgress": 3.14,

756

"l2Reg": 3.14,

757

"learnRateStrategy": "A String",

758

"warmStart": True or False,

759

"lineSearchInitLearnRate": 3.14,

760

"earlyStop": True or False,

761

"l1Reg": 3.14,

762

"maxIteration": "A String",

763

"learnRate": 3.14,

764

},

765

"state": "A String", # [Output-only, Beta] Different state applicable for a training run. IN PROGRESS: Training run is in progress. FAILED: Training run ended due to a non-retryable failure. SUCCEEDED: Training run successfully completed. CANCELLED: Training run cancelled by the user.

766

"iterationResults": [ # [Output-only, Beta] List of each iteration results.

767

{

768

"durationMs": "A String", # [Output-only, Beta] Time taken to run the training iteration in milliseconds.

769

"trainingLoss": 3.14, # [Output-only, Beta] Training loss computed on the training data at the end of the iteration. The training loss function is defined by model type.

770

"evalLoss": 3.14, # [Output-only, Beta] Eval loss computed on the eval data at the end of the iteration. The eval loss is used for early stopping to avoid overfitting. No eval loss if eval_split_method option is specified as no_split or auto_split with input data size less than 500 rows.

771

"index": 42, # [Output-only, Beta] Index of the ML training iteration, starting from zero for each training run.

772

"learnRate": 3.14, # [Output-only, Beta] Learning rate used for this iteration, it varies for different training iterations if learn_rate_strategy option is not constant.

773

},

774

],

775

"startTime": "A String", # [Output-only, Beta] Training run start time in milliseconds since the epoch.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

776

},

777

],

778

},

Bu Sun Kim

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

[diff] [blame^]

779

"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.

780

"expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created tables.

781

"kind": "bigquery#table", # [Output-only] The type of the resource.

782

"description": "A String", # [Optional] A user-friendly description of this table.

783

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

784

"rangePartitioning": { # [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

785

"range": { # [TrustedTester] [Required] Defines the ranges for range partitioning.

786

"interval": "A String", # [TrustedTester] [Required] The width of each interval.

787

"start": "A String", # [TrustedTester] [Required] The start of range partitioning, inclusive.

788

"end": "A String", # [TrustedTester] [Required] The end of range partitioning, exclusive.

789

},

790

"field": "A String", # [TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.

791

},

792

"schema": { # [Optional] Describes the schema of this table.

793

"fields": [ # Describes the fields in a table.

794

{

795

"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.

796

# Object with schema name: TableFieldSchema

797

],

798

"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.

799

"type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).

800

"categories": { # [Optional] The categories attached to this field, used for field-level access control.

801

"names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

"A String",

],

},

"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

806

"description": "A String", # [Optional] The field description. The maximum length is 1,024 characters.

807

"policyTags": {

808

"names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.

"A String",

],

},

},

],

},

"id": "A String", # [Output-only] An opaque ID uniquely identifying the table.

816

"requirePartitionFilter": false, # [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.

817

"materializedView": { # [Optional] Materialized view definition.

818

"query": "A String", # [Required] A query whose result is persisted.

819

"enableRefresh": True or False, # [Optional] [TrustedTester] Enable automatic refresh of the materialized view when the base table is updated. The default value is "true".

820

"refreshIntervalMs": "A String", # [Optional] [TrustedTester] The maximum frequency at which this materialized view will be refreshed. The default value is "1800000" (30 minutes).

821

"lastRefreshTime": "A String", # [Output-only] [TrustedTester] The time when this materialized view was last modified, in milliseconds since the epoch.

822

},

823

"tableReference": { # [Required] Reference describing the ID of this table.

824

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

825

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

826

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

827

},

828

"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.

829

"numRows": "A String", # [Output-only] The number of rows of data in this table, excluding any data in the streaming buffer.

830

"clustering": { # [Beta] Clustering specification for the table. Must be specified with partitioning, data in the table will be first partitioned and subsequently clustered.

831

"fields": [ # [Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.

"A String",

],

},

"type": "A String", # [Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. [TrustedTester] MATERIALIZED_VIEW: SQL query whose result is persisted. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE.

836

"view": { # [Optional] The view definition.

837

"useLegacySql": True or False, # Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ Queries and views that reference this view must use the same flag value.

838

"query": "A String", # [Required] A query that BigQuery executes when the view is referenced.

839

"userDefinedFunctionResources": [ # Describes user-defined function resources used in the query.

840

{

841

"resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).

842

"inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.

},

],

},

"numLongTermBytes": "A String", # [Output-only] The number of bytes in the table that are considered "long-term storage".

847

"etag": "A String", # [Output-only] A hash of the table metadata. Used to ensure there were no concurrent modifications to the resource when attempting an update. Not guaranteed to change when the table contents or the fields numRows, numBytes, numLongTermBytes or lastModifiedTime change.

848

"encryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys).

849

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

850

},

851

"streamingBuffer": { # [Output-only] Contains information regarding this table's streaming buffer, if one is present. This field will be absent if the table is not being streamed to or if there is no data in the streaming buffer.

852

"estimatedBytes": "A String", # [Output-only] A lower-bound estimate of the number of bytes currently in the streaming buffer.

853

"estimatedRows": "A String", # [Output-only] A lower-bound estimate of the number of rows currently in the streaming buffer.

854

"oldestEntryTime": "A String", # [Output-only] Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.

855

},

856

"numBytes": "A String", # [Output-only] The size of this table in bytes, excluding any data in the streaming buffer.

857

"location": "A String", # [Output-only] The geographic location where the table resides. This value is inherited from the dataset.

858

"friendlyName": "A String", # [Optional] A descriptive name for this table.

859

"timePartitioning": { # Time-based partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

860

"field": "A String", # [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED.

861

"expirationMs": "A String", # [Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value.

862

"type": "A String", # [Required] The only type supported is DAY, which will generate one partition per day.

863

"requirePartitionFilter": True or False,

864

},

865

"numPhysicalBytes": "A String", # [Output-only] [TrustedTester] The physical size of this table in bytes, excluding any data in the streaming buffer. This includes compression and storage used for time travel.

866

"labels": { # The labels associated with this table. You can use these to organize and group your tables. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.

867

"a_key": "A String",

868

},

John Asmuth

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

[diff] [blame]

}

Returns:

An object of the form:

874

875

{

Bu Sun Kim

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

[diff] [blame^]

876

"externalDataConfiguration": { # [Optional] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.

877

"googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.

878

"range": "A String", # [Optional] Range of a sheet to query from. Only used when non-empty. Typical format: sheet_name!top_left_cell_id:bottom_right_cell_id For example: sheet1!A1:B20

879

"skipLeadingRows": "A String", # [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

880

},

Bu Sun Kim

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

[diff] [blame^]

881

"autodetect": True or False, # Try to detect schema and format options automatically. Any option specified explicitly will be honored.

882

"ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.

883

"sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".

884

"csvOptions": { # Additional properties to set if sourceFormat is set to CSV.

885

"encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.

886

"allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.

887

"quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.

888

"skipLeadingRows": "A String", # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.

889

"allowJaggedRows": True or False, # [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.

890

"fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

891

},

Bu Sun Kim

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

[diff] [blame^]

892

"bigtableOptions": { # [Optional] Additional options if sourceFormat is set to BIGTABLE.

893

"columnFamilies": [ # [Optional] List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

894

{

Bu Sun Kim

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

[diff] [blame^]

895

"onlyReadLatest": True or False, # [Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.

896

"encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.

897

"columns": [ # [Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

898

{

Bu Sun Kim

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

[diff] [blame^]

899

"qualifierEncoded": "A String", # [Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name.

900

"onlyReadLatest": True or False, # [Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.

901

"fieldName": "A String", # [Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries.

902

"qualifierString": "A String",

903

"encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.

904

"type": "A String", # [Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

905

},

906

],

Bu Sun Kim

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

[diff] [blame^]

907

"type": "A String", # [Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.

908

"familyId": "A String", # Identifier of the column family.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

909

},

910

],

Bu Sun Kim

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

[diff] [blame^]

911

"ignoreUnspecifiedColumnFamilies": True or False, # [Optional] If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.

912

"readRowkeyAsString": True or False, # [Optional] If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

913

},

Bu Sun Kim

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

[diff] [blame^]

914

"compression": "A String", # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.

915

"schema": { # [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.

916

"fields": [ # Describes the fields in a table.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

917

{

Bu Sun Kim

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

[diff] [blame^]

918

"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

919

# Object with schema name: TableFieldSchema

920

],

Bu Sun Kim

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

[diff] [blame^]

921

"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.

922

"type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).

923

"categories": { # [Optional] The categories attached to this field, used for field-level access control.

924

"names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

925

"A String",

Dan O'Meara

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

[diff] [blame]

926

],

927

},

Bu Sun Kim

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

[diff] [blame^]

928

"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

929

"description": "A String", # [Optional] The field description. The maximum length is 1,024 characters.

930

"policyTags": {

931

"names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.

932

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

933

],

934

},

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

935

},

936

],

937

},

Bu Sun Kim

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

[diff] [blame^]

938

"hivePartitioningOptions": { # [Optional, Trusted Tester] Options to configure hive partitioning support.

939

"sourceUriPrefix": "A String", # [Optional, Trusted Tester] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).

940

"mode": "A String", # [Optional, Trusted Tester] When set, what mode of hive partitioning to use when reading data. Two modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.

941

},

942

"maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV, JSON, and Google Sheets. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.

943

"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '*' wildcard character is not allowed.

944

"A String",

945

],

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

946

},

Bu Sun Kim

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

[diff] [blame^]

947

"model": { # [Output-only, Beta] Present iff this table represents a ML model. Describes the training information for the model, and it is required to run 'PREDICT' queries.

948

"modelOptions": { # [Output-only, Beta] Model options used for the first training run. These options are immutable for subsequent training runs. Default values are used for any options not specified in the input query.

"labels": [

"A String",

],

"lossType": "A String",

953

"modelType": "A String",

954

},

955

"trainingRuns": [ # [Output-only, Beta] Information about ml training runs, each training run comprises of multiple iterations and there may be multiple training runs for the model if warm start is used or if a user decides to continue a previously cancelled query.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

956

{

Bu Sun Kim

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

[diff] [blame^]

957

"trainingOptions": { # [Output-only, Beta] Training options used by this training run. These options are mutable for subsequent training runs. Default values are explicitly stored for options not specified in the input query of the first training run. For subsequent training runs, any option not explicitly specified in the input query will be copied from the previous training run.

958

"minRelProgress": 3.14,

959

"l2Reg": 3.14,

960

"learnRateStrategy": "A String",

961

"warmStart": True or False,

962

"lineSearchInitLearnRate": 3.14,

963

"earlyStop": True or False,

964

"l1Reg": 3.14,

965

"maxIteration": "A String",

966

"learnRate": 3.14,

967

},

968

"state": "A String", # [Output-only, Beta] Different state applicable for a training run. IN PROGRESS: Training run is in progress. FAILED: Training run ended due to a non-retryable failure. SUCCEEDED: Training run successfully completed. CANCELLED: Training run cancelled by the user.

969

"iterationResults": [ # [Output-only, Beta] List of each iteration results.

970

{

971

"durationMs": "A String", # [Output-only, Beta] Time taken to run the training iteration in milliseconds.

972

"trainingLoss": 3.14, # [Output-only, Beta] Training loss computed on the training data at the end of the iteration. The training loss function is defined by model type.

973

"evalLoss": 3.14, # [Output-only, Beta] Eval loss computed on the eval data at the end of the iteration. The eval loss is used for early stopping to avoid overfitting. No eval loss if eval_split_method option is specified as no_split or auto_split with input data size less than 500 rows.

974

"index": 42, # [Output-only, Beta] Index of the ML training iteration, starting from zero for each training run.

975

"learnRate": 3.14, # [Output-only, Beta] Learning rate used for this iteration, it varies for different training iterations if learn_rate_strategy option is not constant.

976

},

977

],

978

"startTime": "A String", # [Output-only, Beta] Training run start time in milliseconds since the epoch.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

979

},

980

],

981

},

Bu Sun Kim

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

[diff] [blame^]

982

"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.

983

"expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created tables.

984

"kind": "bigquery#table", # [Output-only] The type of the resource.

985

"description": "A String", # [Optional] A user-friendly description of this table.

986

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

987

"rangePartitioning": { # [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

988

"range": { # [TrustedTester] [Required] Defines the ranges for range partitioning.

989

"interval": "A String", # [TrustedTester] [Required] The width of each interval.

990

"start": "A String", # [TrustedTester] [Required] The start of range partitioning, inclusive.

991

"end": "A String", # [TrustedTester] [Required] The end of range partitioning, exclusive.

992

},

993

"field": "A String", # [TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.

994

},

995

"schema": { # [Optional] Describes the schema of this table.

996

"fields": [ # Describes the fields in a table.

997

{

998

"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.

999

# Object with schema name: TableFieldSchema

1000

],

1001

"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.

1002

"type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).

1003

"categories": { # [Optional] The categories attached to this field, used for field-level access control.

1004

"names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

"A String",

],

},

"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

1009

"description": "A String", # [Optional] The field description. The maximum length is 1,024 characters.

1010

"policyTags": {

1011

"names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.

"A String",

],

},

},

],

},

"id": "A String", # [Output-only] An opaque ID uniquely identifying the table.

1019

"requirePartitionFilter": false, # [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.

1020

"materializedView": { # [Optional] Materialized view definition.

1021

"query": "A String", # [Required] A query whose result is persisted.

1022

"enableRefresh": True or False, # [Optional] [TrustedTester] Enable automatic refresh of the materialized view when the base table is updated. The default value is "true".

1023

"refreshIntervalMs": "A String", # [Optional] [TrustedTester] The maximum frequency at which this materialized view will be refreshed. The default value is "1800000" (30 minutes).

1024

"lastRefreshTime": "A String", # [Output-only] [TrustedTester] The time when this materialized view was last modified, in milliseconds since the epoch.

1025

},

1026

"tableReference": { # [Required] Reference describing the ID of this table.

1027

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

1028

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

1029

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

1030

},

1031

"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.

1032

"numRows": "A String", # [Output-only] The number of rows of data in this table, excluding any data in the streaming buffer.

1033

"clustering": { # [Beta] Clustering specification for the table. Must be specified with partitioning, data in the table will be first partitioned and subsequently clustered.

1034

"fields": [ # [Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.

"A String",

],

},

"type": "A String", # [Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. [TrustedTester] MATERIALIZED_VIEW: SQL query whose result is persisted. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE.

1039

"view": { # [Optional] The view definition.

1040

"useLegacySql": True or False, # Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ Queries and views that reference this view must use the same flag value.

1041

"query": "A String", # [Required] A query that BigQuery executes when the view is referenced.

1042

"userDefinedFunctionResources": [ # Describes user-defined function resources used in the query.

1043

{

1044

"resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).

1045

"inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.

},

],

},

"numLongTermBytes": "A String", # [Output-only] The number of bytes in the table that are considered "long-term storage".

1050

"etag": "A String", # [Output-only] A hash of the table metadata. Used to ensure there were no concurrent modifications to the resource when attempting an update. Not guaranteed to change when the table contents or the fields numRows, numBytes, numLongTermBytes or lastModifiedTime change.

1051

"encryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys).

1052

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

1053

},

1054

"streamingBuffer": { # [Output-only] Contains information regarding this table's streaming buffer, if one is present. This field will be absent if the table is not being streamed to or if there is no data in the streaming buffer.

1055

"estimatedBytes": "A String", # [Output-only] A lower-bound estimate of the number of bytes currently in the streaming buffer.

1056

"estimatedRows": "A String", # [Output-only] A lower-bound estimate of the number of rows currently in the streaming buffer.

1057

"oldestEntryTime": "A String", # [Output-only] Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.

1058

},

1059

"numBytes": "A String", # [Output-only] The size of this table in bytes, excluding any data in the streaming buffer.

1060

"location": "A String", # [Output-only] The geographic location where the table resides. This value is inherited from the dataset.

1061

"friendlyName": "A String", # [Optional] A descriptive name for this table.

1062

"timePartitioning": { # Time-based partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

1063

"field": "A String", # [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED.

1064

"expirationMs": "A String", # [Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value.

1065

"type": "A String", # [Required] The only type supported is DAY, which will generate one partition per day.

1066

"requirePartitionFilter": True or False,

1067

},

1068

"numPhysicalBytes": "A String", # [Output-only] [TrustedTester] The physical size of this table in bytes, excluding any data in the streaming buffer. This includes compression and storage used for time travel.

1069

"labels": { # The labels associated with this table. You can use these to organize and group your tables. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.

1070

"a_key": "A String",

1071

},

John Asmuth

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

[diff] [blame]

}</pre>

</div>

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

Nathaniel Manista

4f877e5

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

[diff] [blame]

1077

<pre>Lists all tables in the specified dataset. Requires the READER dataset role.

John Asmuth

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

[diff] [blame]

1078

1079

Args:

1080

projectId: string, Project ID of the tables to list (required)

1081

datasetId: string, Dataset ID of the tables to list (required)

1082

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

1083

maxResults: integer, Maximum number of results to return

1084

1085

Returns:

1086

An object of the form:

1087

1088

{

Bu Sun Kim

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

[diff] [blame^]

1089

"nextPageToken": "A String", # A token to request the next page of results.

1090

"totalItems": 42, # The total number of tables in the dataset.

1091

"kind": "bigquery#tableList", # The type of list.

1092

"tables": [ # Tables in the requested dataset.

John Asmuth

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

[diff] [blame]

1093

{

Bu Sun Kim

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

[diff] [blame^]

1094

"type": "A String", # The type of table. Possible values are: TABLE, VIEW.

1095

"clustering": { # [Beta] Clustering specification for this table, if configured.

1096

"fields": [ # [Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.

1097

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1098

],

1099

},

Bu Sun Kim

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

[diff] [blame^]

1100

"expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed.

1101

"kind": "bigquery#table", # The resource type.

1102

"view": { # Additional details for a view.

1103

"useLegacySql": True or False, # True if view is defined in legacy SQL dialect, false if in standard SQL.

1104

},

1105

"creationTime": "A String", # The time when this table was created, in milliseconds since the epoch.

1106

"rangePartitioning": { # The range partitioning specification for this table, if configured.

1107

"range": { # [TrustedTester] [Required] Defines the ranges for range partitioning.

1108

"interval": "A String", # [TrustedTester] [Required] The width of each interval.

1109

"start": "A String", # [TrustedTester] [Required] The start of range partitioning, inclusive.

1110

"end": "A String", # [TrustedTester] [Required] The end of range partitioning, exclusive.

Dan O'Meara

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

[diff] [blame]

1111

},

Bu Sun Kim

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

[diff] [blame^]

1112

"field": "A String", # [TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.

Dan O'Meara

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

[diff] [blame]

1113

},

Bu Sun Kim

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

[diff] [blame^]

1114

"id": "A String", # An opaque ID of the table

1115

"tableReference": { # A reference uniquely identifying the table.

1116

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

1117

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

1118

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1119

},

Bu Sun Kim

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

[diff] [blame^]

1120

"friendlyName": "A String", # The user-friendly name for this table.

1121

"timePartitioning": { # The time-based partitioning specification for this table, if configured.

1122

"field": "A String", # [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED.

1123

"expirationMs": "A String", # [Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value.

1124

"type": "A String", # [Required] The only type supported is DAY, which will generate one partition per day.

1125

"requirePartitionFilter": True or False,

John Asmuth

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

[diff] [blame]

1126

},

Bu Sun Kim

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

[diff] [blame^]

1127

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

1128

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1129

},

John Asmuth

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

[diff] [blame]

1130

},

1131

],

Bu Sun Kim

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

[diff] [blame^]

1132

"etag": "A String", # A hash of this page of results.

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>

1138

<pre>Retrieves the next page of results.

1139

1140

Args:

1141

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

1142

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

1143

1144

Returns:

Bu Sun Kim

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

[diff] [blame^]

1145

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

John Asmuth

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

[diff] [blame]

1146

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]

1151

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

John Asmuth

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

[diff] [blame]

1152

<pre>Updates information in an existing table. The update method replaces the entire table resource, whereas the patch method only replaces fields that are provided in the submitted table resource. This method supports patch semantics.

1153

1154

Args:

1155

projectId: string, Project ID of the table to update (required)

1156

datasetId: string, Dataset ID of the table to update (required)

1157

tableId: string, Table ID of the table to update (required)

Dan O'Meara

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

[diff] [blame]

1158

body: object, The request body.

John Asmuth

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

[diff] [blame]

1159

The object takes the form of:

1160

1161

{

Bu Sun Kim

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

[diff] [blame^]

1162

"externalDataConfiguration": { # [Optional] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.

1163

"googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.

1164

"range": "A String", # [Optional] Range of a sheet to query from. Only used when non-empty. Typical format: sheet_name!top_left_cell_id:bottom_right_cell_id For example: sheet1!A1:B20

1165

"skipLeadingRows": "A String", # [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1166

},

Bu Sun Kim

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

[diff] [blame^]

1167

"autodetect": True or False, # Try to detect schema and format options automatically. Any option specified explicitly will be honored.

1168

"ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.

1169

"sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".

1170

"csvOptions": { # Additional properties to set if sourceFormat is set to CSV.

1171

"encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.

1172

"allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.

1173

"quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.

1174

"skipLeadingRows": "A String", # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.

1175

"allowJaggedRows": True or False, # [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.

1176

"fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1177

},

Bu Sun Kim

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

[diff] [blame^]

1178

"bigtableOptions": { # [Optional] Additional options if sourceFormat is set to BIGTABLE.

1179

"columnFamilies": [ # [Optional] List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

1180

{

Bu Sun Kim

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

[diff] [blame^]

1181

"onlyReadLatest": True or False, # [Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.

1182

"encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.

1183

"columns": [ # [Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

1184

{

Bu Sun Kim

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

[diff] [blame^]

1185

"qualifierEncoded": "A String", # [Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name.

1186

"onlyReadLatest": True or False, # [Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.

1187

"fieldName": "A String", # [Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries.

1188

"qualifierString": "A String",

1189

"encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.

1190

"type": "A String", # [Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

1191

},

1192

],

Bu Sun Kim

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

[diff] [blame^]

1193

"type": "A String", # [Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.

1194

"familyId": "A String", # Identifier of the column family.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

1195

},

1196

],

Bu Sun Kim

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

[diff] [blame^]

1197

"ignoreUnspecifiedColumnFamilies": True or False, # [Optional] If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.

1198

"readRowkeyAsString": True or False, # [Optional] If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

1199

},

Bu Sun Kim

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

[diff] [blame^]

1200

"compression": "A String", # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.

1201

"schema": { # [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.

1202

"fields": [ # Describes the fields in a table.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1203

{

Bu Sun Kim

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

[diff] [blame^]

1204

"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1205

# Object with schema name: TableFieldSchema

1206

],

Bu Sun Kim

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

[diff] [blame^]

1207

"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.

1208

"type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).

1209

"categories": { # [Optional] The categories attached to this field, used for field-level access control.

1210

"names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

1211

"A String",

Dan O'Meara

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

[diff] [blame]

1212

],

1213

},

Bu Sun Kim

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

[diff] [blame^]

1214

"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

1215

"description": "A String", # [Optional] The field description. The maximum length is 1,024 characters.

1216

"policyTags": {

1217

"names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.

1218

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1219

],

1220

},

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1221

},

1222

],

1223

},

Bu Sun Kim

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

[diff] [blame^]

1224

"hivePartitioningOptions": { # [Optional, Trusted Tester] Options to configure hive partitioning support.

1225

"sourceUriPrefix": "A String", # [Optional, Trusted Tester] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).

1226

"mode": "A String", # [Optional, Trusted Tester] When set, what mode of hive partitioning to use when reading data. Two modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.

1227

},

1228

"maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV, JSON, and Google Sheets. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.

1229

"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '*' wildcard character is not allowed.

1230

"A String",

1231

],

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1232

},

Bu Sun Kim

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

[diff] [blame^]

1233

"model": { # [Output-only, Beta] Present iff this table represents a ML model. Describes the training information for the model, and it is required to run 'PREDICT' queries.

1234

"modelOptions": { # [Output-only, Beta] Model options used for the first training run. These options are immutable for subsequent training runs. Default values are used for any options not specified in the input query.

"labels": [

"A String",

],

"lossType": "A String",

1239

"modelType": "A String",

1240

},

1241

"trainingRuns": [ # [Output-only, Beta] Information about ml training runs, each training run comprises of multiple iterations and there may be multiple training runs for the model if warm start is used or if a user decides to continue a previously cancelled query.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1242

{

Bu Sun Kim

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

[diff] [blame^]

1243

"trainingOptions": { # [Output-only, Beta] Training options used by this training run. These options are mutable for subsequent training runs. Default values are explicitly stored for options not specified in the input query of the first training run. For subsequent training runs, any option not explicitly specified in the input query will be copied from the previous training run.

1244

"minRelProgress": 3.14,

1245

"l2Reg": 3.14,

1246

"learnRateStrategy": "A String",

1247

"warmStart": True or False,

1248

"lineSearchInitLearnRate": 3.14,

1249

"earlyStop": True or False,

1250

"l1Reg": 3.14,

1251

"maxIteration": "A String",

1252

"learnRate": 3.14,

1253

},

1254

"state": "A String", # [Output-only, Beta] Different state applicable for a training run. IN PROGRESS: Training run is in progress. FAILED: Training run ended due to a non-retryable failure. SUCCEEDED: Training run successfully completed. CANCELLED: Training run cancelled by the user.

1255

"iterationResults": [ # [Output-only, Beta] List of each iteration results.

1256

{

1257

"durationMs": "A String", # [Output-only, Beta] Time taken to run the training iteration in milliseconds.

1258

"trainingLoss": 3.14, # [Output-only, Beta] Training loss computed on the training data at the end of the iteration. The training loss function is defined by model type.

1259

"evalLoss": 3.14, # [Output-only, Beta] Eval loss computed on the eval data at the end of the iteration. The eval loss is used for early stopping to avoid overfitting. No eval loss if eval_split_method option is specified as no_split or auto_split with input data size less than 500 rows.

1260

"index": 42, # [Output-only, Beta] Index of the ML training iteration, starting from zero for each training run.

1261

"learnRate": 3.14, # [Output-only, Beta] Learning rate used for this iteration, it varies for different training iterations if learn_rate_strategy option is not constant.

1262

},

1263

],

1264

"startTime": "A String", # [Output-only, Beta] Training run start time in milliseconds since the epoch.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1265

},

1266

],

1267

},

Bu Sun Kim

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

[diff] [blame^]

1268

"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.

1269

"expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created tables.

1270

"kind": "bigquery#table", # [Output-only] The type of the resource.

1271

"description": "A String", # [Optional] A user-friendly description of this table.

1272

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

1273

"rangePartitioning": { # [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

1274

"range": { # [TrustedTester] [Required] Defines the ranges for range partitioning.

1275

"interval": "A String", # [TrustedTester] [Required] The width of each interval.

1276

"start": "A String", # [TrustedTester] [Required] The start of range partitioning, inclusive.

1277

"end": "A String", # [TrustedTester] [Required] The end of range partitioning, exclusive.

1278

},

1279

"field": "A String", # [TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.

1280

},

1281

"schema": { # [Optional] Describes the schema of this table.

1282

"fields": [ # Describes the fields in a table.

1283

{

1284

"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.

1285

# Object with schema name: TableFieldSchema

1286

],

1287

"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.

1288

"type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).

1289

"categories": { # [Optional] The categories attached to this field, used for field-level access control.

1290

"names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

"A String",

],

},

"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

1295

"description": "A String", # [Optional] The field description. The maximum length is 1,024 characters.

1296

"policyTags": {

1297

"names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.

"A String",

],

},

},

],

},

"id": "A String", # [Output-only] An opaque ID uniquely identifying the table.

1305

"requirePartitionFilter": false, # [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.

1306

"materializedView": { # [Optional] Materialized view definition.

1307

"query": "A String", # [Required] A query whose result is persisted.

1308

"enableRefresh": True or False, # [Optional] [TrustedTester] Enable automatic refresh of the materialized view when the base table is updated. The default value is "true".

1309

"refreshIntervalMs": "A String", # [Optional] [TrustedTester] The maximum frequency at which this materialized view will be refreshed. The default value is "1800000" (30 minutes).

1310

"lastRefreshTime": "A String", # [Output-only] [TrustedTester] The time when this materialized view was last modified, in milliseconds since the epoch.

1311

},

1312

"tableReference": { # [Required] Reference describing the ID of this table.

1313

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

1314

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

1315

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

1316

},

1317

"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.

1318

"numRows": "A String", # [Output-only] The number of rows of data in this table, excluding any data in the streaming buffer.

1319

"clustering": { # [Beta] Clustering specification for the table. Must be specified with partitioning, data in the table will be first partitioned and subsequently clustered.

1320

"fields": [ # [Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.

"A String",

],

},

"type": "A String", # [Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. [TrustedTester] MATERIALIZED_VIEW: SQL query whose result is persisted. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE.

1325

"view": { # [Optional] The view definition.

1326

"useLegacySql": True or False, # Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ Queries and views that reference this view must use the same flag value.

1327

"query": "A String", # [Required] A query that BigQuery executes when the view is referenced.

1328

"userDefinedFunctionResources": [ # Describes user-defined function resources used in the query.

1329

{

1330

"resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).

1331

"inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.

},

],

},

"numLongTermBytes": "A String", # [Output-only] The number of bytes in the table that are considered "long-term storage".

1336

"etag": "A String", # [Output-only] A hash of the table metadata. Used to ensure there were no concurrent modifications to the resource when attempting an update. Not guaranteed to change when the table contents or the fields numRows, numBytes, numLongTermBytes or lastModifiedTime change.

1337

"encryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys).

1338

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

1339

},

1340

"streamingBuffer": { # [Output-only] Contains information regarding this table's streaming buffer, if one is present. This field will be absent if the table is not being streamed to or if there is no data in the streaming buffer.

1341

"estimatedBytes": "A String", # [Output-only] A lower-bound estimate of the number of bytes currently in the streaming buffer.

1342

"estimatedRows": "A String", # [Output-only] A lower-bound estimate of the number of rows currently in the streaming buffer.

1343

"oldestEntryTime": "A String", # [Output-only] Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.

1344

},

1345

"numBytes": "A String", # [Output-only] The size of this table in bytes, excluding any data in the streaming buffer.

1346

"location": "A String", # [Output-only] The geographic location where the table resides. This value is inherited from the dataset.

1347

"friendlyName": "A String", # [Optional] A descriptive name for this table.

1348

"timePartitioning": { # Time-based partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

1349

"field": "A String", # [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED.

1350

"expirationMs": "A String", # [Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value.

1351

"type": "A String", # [Required] The only type supported is DAY, which will generate one partition per day.

1352

"requirePartitionFilter": True or False,

1353

},

1354

"numPhysicalBytes": "A String", # [Output-only] [TrustedTester] The physical size of this table in bytes, excluding any data in the streaming buffer. This includes compression and storage used for time travel.

1355

"labels": { # The labels associated with this table. You can use these to organize and group your tables. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.

1356

"a_key": "A String",

1357

},

John Asmuth

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

[diff] [blame]

}

Returns:

An object of the form:

1363

1364

{

Bu Sun Kim

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

[diff] [blame^]

1365

"externalDataConfiguration": { # [Optional] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.

1366

"googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.

1367

"range": "A String", # [Optional] Range of a sheet to query from. Only used when non-empty. Typical format: sheet_name!top_left_cell_id:bottom_right_cell_id For example: sheet1!A1:B20

1368

"skipLeadingRows": "A String", # [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1369

},

Bu Sun Kim

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

[diff] [blame^]

1370

"autodetect": True or False, # Try to detect schema and format options automatically. Any option specified explicitly will be honored.

1371

"ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.

1372

"sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".

1373

"csvOptions": { # Additional properties to set if sourceFormat is set to CSV.

1374

"encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.

1375

"allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.

1376

"quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.

1377

"skipLeadingRows": "A String", # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.

1378

"allowJaggedRows": True or False, # [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.

1379

"fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1380

},

Bu Sun Kim

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

[diff] [blame^]

1381

"bigtableOptions": { # [Optional] Additional options if sourceFormat is set to BIGTABLE.

1382

"columnFamilies": [ # [Optional] List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

1383

{

Bu Sun Kim

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

[diff] [blame^]

1384

"onlyReadLatest": True or False, # [Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.

1385

"encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.

1386

"columns": [ # [Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

1387

{

Bu Sun Kim

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

[diff] [blame^]

1388

"qualifierEncoded": "A String", # [Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name.

1389

"onlyReadLatest": True or False, # [Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.

1390

"fieldName": "A String", # [Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries.

1391

"qualifierString": "A String",

1392

"encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.

1393

"type": "A String", # [Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

1394

},

1395

],

Bu Sun Kim

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

[diff] [blame^]

1396

"type": "A String", # [Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.

1397

"familyId": "A String", # Identifier of the column family.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

1398

},

1399

],

Bu Sun Kim

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

[diff] [blame^]

1400

"ignoreUnspecifiedColumnFamilies": True or False, # [Optional] If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.

1401

"readRowkeyAsString": True or False, # [Optional] If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

1402

},

Bu Sun Kim

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

[diff] [blame^]

1403

"compression": "A String", # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.

1404

"schema": { # [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.

1405

"fields": [ # Describes the fields in a table.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1406

{

Bu Sun Kim

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

[diff] [blame^]

1407

"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1408

# Object with schema name: TableFieldSchema

1409

],

Bu Sun Kim

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

[diff] [blame^]

1410

"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.

1411

"type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).

1412

"categories": { # [Optional] The categories attached to this field, used for field-level access control.

1413

"names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

1414

"A String",

Dan O'Meara

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

[diff] [blame]

1415

],

1416

},

Bu Sun Kim

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

[diff] [blame^]

1417

"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

1418

"description": "A String", # [Optional] The field description. The maximum length is 1,024 characters.

1419

"policyTags": {

1420

"names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.

1421

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1422

],

1423

},

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1424

},

1425

],

1426

},

Bu Sun Kim

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

[diff] [blame^]

1427

"hivePartitioningOptions": { # [Optional, Trusted Tester] Options to configure hive partitioning support.

1428

"sourceUriPrefix": "A String", # [Optional, Trusted Tester] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).

1429

"mode": "A String", # [Optional, Trusted Tester] When set, what mode of hive partitioning to use when reading data. Two modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.

1430

},

1431

"maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV, JSON, and Google Sheets. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.

1432

"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '*' wildcard character is not allowed.

1433

"A String",

1434

],

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1435

},

Bu Sun Kim

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

[diff] [blame^]

1436

"model": { # [Output-only, Beta] Present iff this table represents a ML model. Describes the training information for the model, and it is required to run 'PREDICT' queries.

1437

"modelOptions": { # [Output-only, Beta] Model options used for the first training run. These options are immutable for subsequent training runs. Default values are used for any options not specified in the input query.

"labels": [

"A String",

],

"lossType": "A String",

1442

"modelType": "A String",

1443

},

1444

"trainingRuns": [ # [Output-only, Beta] Information about ml training runs, each training run comprises of multiple iterations and there may be multiple training runs for the model if warm start is used or if a user decides to continue a previously cancelled query.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1445

{

Bu Sun Kim

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

[diff] [blame^]

1446

"trainingOptions": { # [Output-only, Beta] Training options used by this training run. These options are mutable for subsequent training runs. Default values are explicitly stored for options not specified in the input query of the first training run. For subsequent training runs, any option not explicitly specified in the input query will be copied from the previous training run.

1447

"minRelProgress": 3.14,

1448

"l2Reg": 3.14,

1449

"learnRateStrategy": "A String",

1450

"warmStart": True or False,

1451

"lineSearchInitLearnRate": 3.14,

1452

"earlyStop": True or False,

1453

"l1Reg": 3.14,

1454

"maxIteration": "A String",

1455

"learnRate": 3.14,

1456

},

1457

"state": "A String", # [Output-only, Beta] Different state applicable for a training run. IN PROGRESS: Training run is in progress. FAILED: Training run ended due to a non-retryable failure. SUCCEEDED: Training run successfully completed. CANCELLED: Training run cancelled by the user.

1458

"iterationResults": [ # [Output-only, Beta] List of each iteration results.

1459

{

1460

"durationMs": "A String", # [Output-only, Beta] Time taken to run the training iteration in milliseconds.

1461

"trainingLoss": 3.14, # [Output-only, Beta] Training loss computed on the training data at the end of the iteration. The training loss function is defined by model type.

1462

"evalLoss": 3.14, # [Output-only, Beta] Eval loss computed on the eval data at the end of the iteration. The eval loss is used for early stopping to avoid overfitting. No eval loss if eval_split_method option is specified as no_split or auto_split with input data size less than 500 rows.

1463

"index": 42, # [Output-only, Beta] Index of the ML training iteration, starting from zero for each training run.

1464

"learnRate": 3.14, # [Output-only, Beta] Learning rate used for this iteration, it varies for different training iterations if learn_rate_strategy option is not constant.

1465

},

1466

],

1467

"startTime": "A String", # [Output-only, Beta] Training run start time in milliseconds since the epoch.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1468

},

1469

],

1470

},

Bu Sun Kim

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

[diff] [blame^]

1471

"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.

1472

"expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created tables.

1473

"kind": "bigquery#table", # [Output-only] The type of the resource.

1474

"description": "A String", # [Optional] A user-friendly description of this table.

1475

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

1476

"rangePartitioning": { # [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

1477

"range": { # [TrustedTester] [Required] Defines the ranges for range partitioning.

1478

"interval": "A String", # [TrustedTester] [Required] The width of each interval.

1479

"start": "A String", # [TrustedTester] [Required] The start of range partitioning, inclusive.

1480

"end": "A String", # [TrustedTester] [Required] The end of range partitioning, exclusive.

1481

},

1482

"field": "A String", # [TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.

1483

},

1484

"schema": { # [Optional] Describes the schema of this table.

1485

"fields": [ # Describes the fields in a table.

1486

{

1487

"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.

1488

# Object with schema name: TableFieldSchema

1489

],

1490

"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.

1491

"type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).

1492

"categories": { # [Optional] The categories attached to this field, used for field-level access control.

1493

"names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

"A String",

],

},

"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

1498

"description": "A String", # [Optional] The field description. The maximum length is 1,024 characters.

1499

"policyTags": {

1500

"names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.

"A String",

],

},

},

],

},

"id": "A String", # [Output-only] An opaque ID uniquely identifying the table.

1508

"requirePartitionFilter": false, # [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.

1509

"materializedView": { # [Optional] Materialized view definition.

1510

"query": "A String", # [Required] A query whose result is persisted.

1511

"enableRefresh": True or False, # [Optional] [TrustedTester] Enable automatic refresh of the materialized view when the base table is updated. The default value is "true".

1512

"refreshIntervalMs": "A String", # [Optional] [TrustedTester] The maximum frequency at which this materialized view will be refreshed. The default value is "1800000" (30 minutes).

1513

"lastRefreshTime": "A String", # [Output-only] [TrustedTester] The time when this materialized view was last modified, in milliseconds since the epoch.

1514

},

1515

"tableReference": { # [Required] Reference describing the ID of this table.

1516

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

1517

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

1518

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

1519

},

1520

"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.

1521

"numRows": "A String", # [Output-only] The number of rows of data in this table, excluding any data in the streaming buffer.

1522

"clustering": { # [Beta] Clustering specification for the table. Must be specified with partitioning, data in the table will be first partitioned and subsequently clustered.

1523

"fields": [ # [Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.

"A String",

],

},

"type": "A String", # [Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. [TrustedTester] MATERIALIZED_VIEW: SQL query whose result is persisted. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE.

1528

"view": { # [Optional] The view definition.

1529

"useLegacySql": True or False, # Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ Queries and views that reference this view must use the same flag value.

1530

"query": "A String", # [Required] A query that BigQuery executes when the view is referenced.

1531

"userDefinedFunctionResources": [ # Describes user-defined function resources used in the query.

1532

{

1533

"resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).

1534

"inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.

},

],

},

"numLongTermBytes": "A String", # [Output-only] The number of bytes in the table that are considered "long-term storage".

1539

"etag": "A String", # [Output-only] A hash of the table metadata. Used to ensure there were no concurrent modifications to the resource when attempting an update. Not guaranteed to change when the table contents or the fields numRows, numBytes, numLongTermBytes or lastModifiedTime change.

1540

"encryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys).

1541

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

1542

},

1543

"streamingBuffer": { # [Output-only] Contains information regarding this table's streaming buffer, if one is present. This field will be absent if the table is not being streamed to or if there is no data in the streaming buffer.

1544

"estimatedBytes": "A String", # [Output-only] A lower-bound estimate of the number of bytes currently in the streaming buffer.

1545

"estimatedRows": "A String", # [Output-only] A lower-bound estimate of the number of rows currently in the streaming buffer.

1546

"oldestEntryTime": "A String", # [Output-only] Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.

1547

},

1548

"numBytes": "A String", # [Output-only] The size of this table in bytes, excluding any data in the streaming buffer.

1549

"location": "A String", # [Output-only] The geographic location where the table resides. This value is inherited from the dataset.

1550

"friendlyName": "A String", # [Optional] A descriptive name for this table.

1551

"timePartitioning": { # Time-based partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

1552

"field": "A String", # [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED.

1553

"expirationMs": "A String", # [Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value.

1554

"type": "A String", # [Required] The only type supported is DAY, which will generate one partition per day.

1555

"requirePartitionFilter": True or False,

1556

},

1557

"numPhysicalBytes": "A String", # [Output-only] [TrustedTester] The physical size of this table in bytes, excluding any data in the streaming buffer. This includes compression and storage used for time travel.

1558

"labels": { # The labels associated with this table. You can use these to organize and group your tables. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.

1559

"a_key": "A String",

1560

},

John Asmuth

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame^]

1565

<code class="details" id="setIamPolicy">setIamPolicy(resource, body=None)</code>

1566

<pre>Sets the access control policy on the specified resource. Replaces any

1567

existing policy.

1568

1569

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

1570

1571

Args:

1572

resource: string, REQUIRED: The resource for which the policy is being specified.

1573

See the operation documentation for the appropriate value for this field. (required)

1574

body: object, The request body.

1575

The object takes the form of:

1576

1577

{ # Request message for `SetIamPolicy` method.

1578

"policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the `resource`. The size of

1579

# the policy is limited to a few 10s of KB. An empty policy is a

1580

# valid policy but certain Cloud Platform services (such as Projects)

1581

# might reject them.

1582

# controls for Google Cloud resources.

1583

#

1584

#

1585

# A `Policy` is a collection of `bindings`. A `binding` binds one or more

1586

# `members` to a single `role`. Members can be user accounts, service accounts,

1587

# Google groups, and domains (such as G Suite). A `role` is a named list of

1588

# permissions; each `role` can be an IAM predefined role or a user-created

1589

# custom role.

1590

#

1591

# For some types of Google Cloud resources, a `binding` can also specify a

1592

# `condition`, which is a logical expression that allows access to a resource

1593

# only if the expression evaluates to `true`. A condition can add constraints

1594

# based on attributes of the request, the resource, or both. To learn which

1595

# resources support conditions in their IAM policies, see the

1596

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

#

# **JSON example:**

#

# {

# "bindings": [

# {

# "role": "roles/resourcemanager.organizationAdmin",

1604

# "members": [

1605

# "user:mike@example.com",

1606

# "group:admins@example.com",

1607

# "domain:google.com",

1608

# "serviceAccount:my-project-id@appspot.gserviceaccount.com"

# ]

# },

# {

# "role": "roles/resourcemanager.organizationViewer",

1613

# "members": [

1614

# "user:eve@example.com"

1615

# ],

1616

# "condition": {

1617

# "title": "expirable access",

1618

# "description": "Does not grant access after Sep 2020",

1619

# "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",

# }

# }

# ],

# "etag": "BwWWja0YfJA=",

# "version": 3

# }

#

# **YAML example:**

#

# bindings:

# - members:

# - user:mike@example.com

1632

# - group:admins@example.com

1633

# - domain:google.com

1634

# - serviceAccount:my-project-id@appspot.gserviceaccount.com

1635

# role: roles/resourcemanager.organizationAdmin

1636

# - members:

1637

# - user:eve@example.com

1638

# role: roles/resourcemanager.organizationViewer

1639

# condition:

1640

# title: expirable access

1641

# description: Does not grant access after Sep 2020

1642

# expression: request.time < timestamp('2020-10-01T00:00:00.000Z')

1643

# - etag: BwWWja0YfJA=

1644

# - version: 3

1645

#

1646

# For a description of IAM and its features, see the

1647

# [IAM documentation](https://cloud.google.com/iam/docs/).

1648

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a

1649

# `condition` that determines how and when the `bindings` are applied. Each

1650

# of the `bindings` must contain at least one member.

1651

{ # Associates `members` with a `role`.

1652

"condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.

1653

#

1654

# If the condition evaluates to `true`, then this binding applies to the

1655

# current request.

1656

#

1657

# If the condition evaluates to `false`, then this binding does not apply to

1658

# the current request. However, a different role binding might grant the same

1659

# role to one or more of the members in this binding.

1660

#

1661

# To learn which resources support conditions in their IAM policies, see the

1662

# [IAM

1663

# documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

1664

# syntax. CEL is a C-like expression language. The syntax and semantics of CEL

1665

# are documented at https://github.com/google/cel-spec.

1666

#

1667

# Example (Comparison):

1668

#

1669

# title: "Summary size limit"

1670

# description: "Determines if a summary is less than 100 chars"

1671

# expression: "document.summary.size() < 100"

1672

#

1673

# Example (Equality):

1674

#

1675

# title: "Requestor is owner"

1676

# description: "Determines if requestor is the document owner"

1677

# expression: "document.owner == request.auth.claims.email"

#

# Example (Logic):

#

# title: "Public documents"

1682

# description: "Determine whether the document should be publicly visible"

1683

# expression: "document.type != 'private' && document.type != 'internal'"

1684

#

1685

# Example (Data Manipulation):

1686

#

1687

# title: "Notification string"

1688

# description: "Create a notification string with a timestamp."

1689

# expression: "'New message received at ' + string(document.create_time)"

1690

#

1691

# The exact variables and functions that may be referenced within an expression

1692

# are determined by the service that evaluates it. See the service

1693

# documentation for additional information.

1694

"title": "A String", # Optional. Title for the expression, i.e. a short string describing

1695

# its purpose. This can be used e.g. in UIs which allow to enter the

1696

# expression.

1697

"location": "A String", # Optional. String indicating the location of the expression for error

1698

# reporting, e.g. a file name and a position in the file.

1699

"description": "A String", # Optional. Description of the expression. This is a longer text which

1700

# describes the expression, e.g. when hovered over it in a UI.

1701

"expression": "A String", # Textual representation of an expression in Common Expression Language

1702

# syntax.

1703

},

1704

"members": [ # Specifies the identities requesting access for a Cloud Platform resource.

1705

# `members` can have the following values:

1706

#

1707

# * `allUsers`: A special identifier that represents anyone who is

1708

# on the internet; with or without a Google account.

1709

#

1710

# * `allAuthenticatedUsers`: A special identifier that represents anyone

1711

# who is authenticated with a Google account or a service account.

1712

#

1713

# * `user:{emailid}`: An email address that represents a specific Google

1714

# account. For example, `alice@example.com` .

1715

#

1716

#

1717

# * `serviceAccount:{emailid}`: An email address that represents a service

1718

# account. For example, `my-other-app@appspot.gserviceaccount.com`.

1719

#

1720

# * `group:{emailid}`: An email address that represents a Google group.

1721

# For example, `admins@example.com`.

1722

#

1723

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique

1724

# identifier) representing a user that has been recently deleted. For

1725

# example, `alice@example.com?uid=123456789012345678901`. If the user is

1726

# recovered, this value reverts to `user:{emailid}` and the recovered user

1727

# retains the role in the binding.

1728

#

1729

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus

1730

# unique identifier) representing a service account that has been recently

1731

# deleted. For example,

1732

# `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.

1733

# If the service account is undeleted, this value reverts to

1734

# `serviceAccount:{emailid}` and the undeleted service account retains the

1735

# role in the binding.

1736

#

1737

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique

1738

# identifier) representing a Google group that has been recently

1739

# deleted. For example, `admins@example.com?uid=123456789012345678901`. If

1740

# the group is recovered, this value reverts to `group:{emailid}` and the

1741

# recovered group retains the role in the binding.

1742

#

1743

#

1744

# * `domain:{domain}`: The G Suite domain (primary) that represents all the

1745

# users of that domain. For example, `google.com` or `example.com`.

#

"A String",

],

"role": "A String", # Role that is assigned to `members`.

1750

# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

1751

},

1752

],

1753

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help

1754

# prevent simultaneous updates of a policy from overwriting each other.

1755

# It is strongly suggested that systems make use of the `etag` in the

1756

# read-modify-write cycle to perform policy updates in order to avoid race

1757

# conditions: An `etag` is returned in the response to `getIamPolicy`, and

1758

# systems are expected to put that etag in the request to `setIamPolicy` to

1759

# ensure that their change will be applied to the same version of the policy.

1760

#

1761

# **Important:** If you use IAM Conditions, you must include the `etag` field

1762

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

1763

# you to overwrite a version `3` policy with a version `1` policy, and all of

1764

# the conditions in the version `3` policy are lost.

1765

"version": 42, # Specifies the format of the policy.

1766

#

1767

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value

1768

# are rejected.

1769

#

1770

# Any operation that affects conditional role bindings must specify version

1771

# `3`. This requirement applies to the following operations:

1772

#

1773

# * Getting a policy that includes a conditional role binding

1774

# * Adding a conditional role binding to a policy

1775

# * Changing a conditional role binding in a policy

1776

# * Removing any role binding, with or without a condition, from a policy

1777

# that includes conditions

1778

#

1779

# **Important:** If you use IAM Conditions, you must include the `etag` field

1780

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

1781

# you to overwrite a version `3` policy with a version `1` policy, and all of

1782

# the conditions in the version `3` policy are lost.

1783

#

1784

# If a policy does not include any conditions, operations on that policy may

1785

# specify any valid version or leave the field unset.

1786

#

1787

# To learn which resources support conditions in their IAM policies, see the

1788

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

1789

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

1790

{ # Specifies the audit configuration for a service.

1791

# The configuration determines which permission types are logged, and what

1792

# identities, if any, are exempted from logging.

1793

# An AuditConfig must have one or more AuditLogConfigs.

1794

#

1795

# If there are AuditConfigs for both `allServices` and a specific service,

1796

# the union of the two AuditConfigs is used for that service: the log_types

1797

# specified in each AuditConfig are enabled, and the exempted_members in each

1798

# AuditLogConfig are exempted.

1799

#

1800

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices"

1806

# "audit_log_configs": [

1807

# {

1808

# "log_type": "DATA_READ",

1809

# "exempted_members": [

1810

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

1815

# },

1816

# {

1817

# "log_type": "ADMIN_READ",

# }

# ]

# },

# {

# "service": "sampleservice.googleapis.com"

1823

# "audit_log_configs": [

1824

# {

1825

# "log_type": "DATA_READ",

1826

# },

1827

# {

1828

# "log_type": "DATA_WRITE",

1829

# "exempted_members": [

1830

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ

1839

# logging. It also exempts jose@example.com from DATA_READ logging, and

1840

# aliya@example.com from DATA_WRITE logging.

1841

"auditLogConfigs": [ # The configuration for logging of each type of permission.

1842

{ # Provides the configuration for logging a type of permissions.

# Example:

#

# {

# "audit_log_configs": [

1847

# {

1848

# "log_type": "DATA_READ",

1849

# "exempted_members": [

1850

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

# }

# ]

# }

#

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting

1860

# jose@example.com from DATA_READ logging.

1861

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of

1862

# permission.

1863

# Follows the same format of Binding.members.

1864

"A String",

1865

],

1866

"logType": "A String", # The log type that this config enables.

1867

},

1868

],

1869

"service": "A String", # Specifies a service that will be enabled for audit logging.

1870

# For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.

1871

# `allServices` is a special value that covers all services.

},

],

},

"updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only

1876

# the fields in the mask will be modified. If no mask is provided, the

1877

# following default mask is used:

1878

#

1879

# `paths: "bindings, etag"`

}

Returns:

An object of the form:

1885

1886

{ # An Identity and Access Management (IAM) policy, which specifies access

1887

# controls for Google Cloud resources.

1888

#

1889

#

1890

# A `Policy` is a collection of `bindings`. A `binding` binds one or more

1891

# `members` to a single `role`. Members can be user accounts, service accounts,

1892

# Google groups, and domains (such as G Suite). A `role` is a named list of

1893

# permissions; each `role` can be an IAM predefined role or a user-created

1894

# custom role.

1895

#

1896

# For some types of Google Cloud resources, a `binding` can also specify a

1897

# `condition`, which is a logical expression that allows access to a resource

1898

# only if the expression evaluates to `true`. A condition can add constraints

1899

# based on attributes of the request, the resource, or both. To learn which

1900

# resources support conditions in their IAM policies, see the

1901

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

#

# **JSON example:**

#

# {

# "bindings": [

# {

# "role": "roles/resourcemanager.organizationAdmin",

1909

# "members": [

1910

# "user:mike@example.com",

1911

# "group:admins@example.com",

1912

# "domain:google.com",

1913

# "serviceAccount:my-project-id@appspot.gserviceaccount.com"

# ]

# },

# {

# "role": "roles/resourcemanager.organizationViewer",

1918

# "members": [

1919

# "user:eve@example.com"

1920

# ],

1921

# "condition": {

1922

# "title": "expirable access",

1923

# "description": "Does not grant access after Sep 2020",

1924

# "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",

# }

# }

# ],

# "etag": "BwWWja0YfJA=",

# "version": 3

# }

#

# **YAML example:**

#

# bindings:

# - members:

# - user:mike@example.com

1937

# - group:admins@example.com

1938

# - domain:google.com

1939

# - serviceAccount:my-project-id@appspot.gserviceaccount.com

1940

# role: roles/resourcemanager.organizationAdmin

1941

# - members:

1942

# - user:eve@example.com

1943

# role: roles/resourcemanager.organizationViewer

1944

# condition:

1945

# title: expirable access

1946

# description: Does not grant access after Sep 2020

1947

# expression: request.time < timestamp('2020-10-01T00:00:00.000Z')

1948

# - etag: BwWWja0YfJA=

1949

# - version: 3

1950

#

1951

# For a description of IAM and its features, see the

1952

# [IAM documentation](https://cloud.google.com/iam/docs/).

1953

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a

1954

# `condition` that determines how and when the `bindings` are applied. Each

1955

# of the `bindings` must contain at least one member.

1956

{ # Associates `members` with a `role`.

1957

"condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.

1958

#

1959

# If the condition evaluates to `true`, then this binding applies to the

1960

# current request.

1961

#

1962

# If the condition evaluates to `false`, then this binding does not apply to

1963

# the current request. However, a different role binding might grant the same

1964

# role to one or more of the members in this binding.

1965

#

1966

# To learn which resources support conditions in their IAM policies, see the

1967

# [IAM

1968

# documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

1969

# syntax. CEL is a C-like expression language. The syntax and semantics of CEL

1970

# are documented at https://github.com/google/cel-spec.

1971

#

1972

# Example (Comparison):

1973

#

1974

# title: "Summary size limit"

1975

# description: "Determines if a summary is less than 100 chars"

1976

# expression: "document.summary.size() < 100"

1977

#

1978

# Example (Equality):

1979

#

1980

# title: "Requestor is owner"

1981

# description: "Determines if requestor is the document owner"

1982

# expression: "document.owner == request.auth.claims.email"

#

# Example (Logic):

#

# title: "Public documents"

1987

# description: "Determine whether the document should be publicly visible"

1988

# expression: "document.type != 'private' && document.type != 'internal'"

1989

#

1990

# Example (Data Manipulation):

1991

#

1992

# title: "Notification string"

1993

# description: "Create a notification string with a timestamp."

1994

# expression: "'New message received at ' + string(document.create_time)"

1995

#

1996

# The exact variables and functions that may be referenced within an expression

1997

# are determined by the service that evaluates it. See the service

1998

# documentation for additional information.

1999

"title": "A String", # Optional. Title for the expression, i.e. a short string describing

2000

# its purpose. This can be used e.g. in UIs which allow to enter the

2001

# expression.

2002

"location": "A String", # Optional. String indicating the location of the expression for error

2003

# reporting, e.g. a file name and a position in the file.

2004

"description": "A String", # Optional. Description of the expression. This is a longer text which

2005

# describes the expression, e.g. when hovered over it in a UI.

2006

"expression": "A String", # Textual representation of an expression in Common Expression Language

2007

# syntax.

2008

},

2009

"members": [ # Specifies the identities requesting access for a Cloud Platform resource.

2010

# `members` can have the following values:

2011

#

2012

# * `allUsers`: A special identifier that represents anyone who is

2013

# on the internet; with or without a Google account.

2014

#

2015

# * `allAuthenticatedUsers`: A special identifier that represents anyone

2016

# who is authenticated with a Google account or a service account.

2017

#

2018

# * `user:{emailid}`: An email address that represents a specific Google

2019

# account. For example, `alice@example.com` .

2020

#

2021

#

2022

# * `serviceAccount:{emailid}`: An email address that represents a service

2023

# account. For example, `my-other-app@appspot.gserviceaccount.com`.

2024

#

2025

# * `group:{emailid}`: An email address that represents a Google group.

2026

# For example, `admins@example.com`.

2027

#

2028

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique

2029

# identifier) representing a user that has been recently deleted. For

2030

# example, `alice@example.com?uid=123456789012345678901`. If the user is

2031

# recovered, this value reverts to `user:{emailid}` and the recovered user

2032

# retains the role in the binding.

2033

#

2034

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus

2035

# unique identifier) representing a service account that has been recently

2036

# deleted. For example,

2037

# `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.

2038

# If the service account is undeleted, this value reverts to

2039

# `serviceAccount:{emailid}` and the undeleted service account retains the

2040

# role in the binding.

2041

#

2042

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique

2043

# identifier) representing a Google group that has been recently

2044

# deleted. For example, `admins@example.com?uid=123456789012345678901`. If

2045

# the group is recovered, this value reverts to `group:{emailid}` and the

2046

# recovered group retains the role in the binding.

2047

#

2048

#

2049

# * `domain:{domain}`: The G Suite domain (primary) that represents all the

2050

# users of that domain. For example, `google.com` or `example.com`.

#

"A String",

],

"role": "A String", # Role that is assigned to `members`.

2055

# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

2056

},

2057

],

2058

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help

2059

# prevent simultaneous updates of a policy from overwriting each other.

2060

# It is strongly suggested that systems make use of the `etag` in the

2061

# read-modify-write cycle to perform policy updates in order to avoid race

2062

# conditions: An `etag` is returned in the response to `getIamPolicy`, and

2063

# systems are expected to put that etag in the request to `setIamPolicy` to

2064

# ensure that their change will be applied to the same version of the policy.

2065

#

2066

# **Important:** If you use IAM Conditions, you must include the `etag` field

2067

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

2068

# you to overwrite a version `3` policy with a version `1` policy, and all of

2069

# the conditions in the version `3` policy are lost.

2070

"version": 42, # Specifies the format of the policy.

2071

#

2072

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value

2073

# are rejected.

2074

#

2075

# Any operation that affects conditional role bindings must specify version

2076

# `3`. This requirement applies to the following operations:

2077

#

2078

# * Getting a policy that includes a conditional role binding

2079

# * Adding a conditional role binding to a policy

2080

# * Changing a conditional role binding in a policy

2081

# * Removing any role binding, with or without a condition, from a policy

2082

# that includes conditions

2083

#

2084

# **Important:** If you use IAM Conditions, you must include the `etag` field

2085

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

2086

# you to overwrite a version `3` policy with a version `1` policy, and all of

2087

# the conditions in the version `3` policy are lost.

2088

#

2089

# If a policy does not include any conditions, operations on that policy may

2090

# specify any valid version or leave the field unset.

2091

#

2092

# To learn which resources support conditions in their IAM policies, see the

2093

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

2094

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

2095

{ # Specifies the audit configuration for a service.

2096

# The configuration determines which permission types are logged, and what

2097

# identities, if any, are exempted from logging.

2098

# An AuditConfig must have one or more AuditLogConfigs.

2099

#

2100

# If there are AuditConfigs for both `allServices` and a specific service,

2101

# the union of the two AuditConfigs is used for that service: the log_types

2102

# specified in each AuditConfig are enabled, and the exempted_members in each

2103

# AuditLogConfig are exempted.

2104

#

2105

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices"

2111

# "audit_log_configs": [

2112

# {

2113

# "log_type": "DATA_READ",

2114

# "exempted_members": [

2115

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

2120

# },

2121

# {

2122

# "log_type": "ADMIN_READ",

# }

# ]

# },

# {

# "service": "sampleservice.googleapis.com"

2128

# "audit_log_configs": [

2129

# {

2130

# "log_type": "DATA_READ",

2131

# },

2132

# {

2133

# "log_type": "DATA_WRITE",

2134

# "exempted_members": [

2135

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ

2144

# logging. It also exempts jose@example.com from DATA_READ logging, and

2145

# aliya@example.com from DATA_WRITE logging.

2146

"auditLogConfigs": [ # The configuration for logging of each type of permission.

2147

{ # Provides the configuration for logging a type of permissions.

# Example:

#

# {

# "audit_log_configs": [

2152

# {

2153

# "log_type": "DATA_READ",

2154

# "exempted_members": [

2155

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

# }

# ]

# }

#

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting

2165

# jose@example.com from DATA_READ logging.

2166

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of

2167

# permission.

2168

# Follows the same format of Binding.members.

2169

"A String",

2170

],

2171

"logType": "A String", # The log type that this config enables.

2172

},

2173

],

2174

"service": "A String", # Specifies a service that will be enabled for audit logging.

2175

# For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.

2176

# `allServices` is a special value that covers all services.

},

],

}</pre>

</div>

<code class="details" id="testIamPermissions">testIamPermissions(resource, body=None)</code>

2184

<pre>Returns permissions that a caller has on the specified resource.

2185

If the resource does not exist, this will return an empty set of

2186

permissions, not a `NOT_FOUND` error.

2187

2188

Note: This operation is designed to be used for building permission-aware

2189

UIs and command-line tools, not for authorization checking. This operation

2190

may "fail open" without warning.

2191

2192

Args:

2193

resource: string, REQUIRED: The resource for which the policy detail is being requested.

2194

See the operation documentation for the appropriate value for this field. (required)

2195

body: object, The request body.

2196

The object takes the form of:

2197

2198

{ # Request message for `TestIamPermissions` method.

2199

"permissions": [ # The set of permissions to check for the `resource`. Permissions with

2200

# wildcards (such as '*' or 'storage.*') are not allowed. For more

2201

# information see

2202

# [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).

"A String",

],

}

Returns:

An object of the form:

2210

2211

{ # Response message for `TestIamPermissions` method.

2212

"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is

# allowed.

"A String",

],

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

2220

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

John Asmuth

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

[diff] [blame]

2221

<pre>Updates information in an existing table. The update method replaces the entire table resource, whereas the patch method only replaces fields that are provided in the submitted table resource.

2222

2223

Args:

2224

projectId: string, Project ID of the table to update (required)

2225

datasetId: string, Dataset ID of the table to update (required)

2226

tableId: string, Table ID of the table to update (required)

Dan O'Meara

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

[diff] [blame]

2227

body: object, The request body.

John Asmuth

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

[diff] [blame]

2228

The object takes the form of:

2229

2230

{

Bu Sun Kim

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

[diff] [blame^]

2231

"externalDataConfiguration": { # [Optional] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.

2232

"googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.

2233

"range": "A String", # [Optional] Range of a sheet to query from. Only used when non-empty. Typical format: sheet_name!top_left_cell_id:bottom_right_cell_id For example: sheet1!A1:B20

2234

"skipLeadingRows": "A String", # [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2235

},

Bu Sun Kim

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

[diff] [blame^]

2236

"autodetect": True or False, # Try to detect schema and format options automatically. Any option specified explicitly will be honored.

2237

"ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.

2238

"sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".

2239

"csvOptions": { # Additional properties to set if sourceFormat is set to CSV.

2240

"encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.

2241

"allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.

2242

"quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.

2243

"skipLeadingRows": "A String", # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.

2244

"allowJaggedRows": True or False, # [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.

2245

"fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2246

},

Bu Sun Kim

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

[diff] [blame^]

2247

"bigtableOptions": { # [Optional] Additional options if sourceFormat is set to BIGTABLE.

2248

"columnFamilies": [ # [Optional] List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

2249

{

Bu Sun Kim

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

[diff] [blame^]

2250

"onlyReadLatest": True or False, # [Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.

2251

"encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.

2252

"columns": [ # [Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

2253

{

Bu Sun Kim

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

[diff] [blame^]

2254

"qualifierEncoded": "A String", # [Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name.

2255

"onlyReadLatest": True or False, # [Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.

2256

"fieldName": "A String", # [Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries.

2257

"qualifierString": "A String",

2258

"encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.

2259

"type": "A String", # [Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

2260

},

2261

],

Bu Sun Kim

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

[diff] [blame^]

2262

"type": "A String", # [Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.

2263

"familyId": "A String", # Identifier of the column family.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

2264

},

2265

],

Bu Sun Kim

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

[diff] [blame^]

2266

"ignoreUnspecifiedColumnFamilies": True or False, # [Optional] If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.

2267

"readRowkeyAsString": True or False, # [Optional] If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

2268

},

Bu Sun Kim

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

[diff] [blame^]

2269

"compression": "A String", # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.

2270

"schema": { # [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.

2271

"fields": [ # Describes the fields in a table.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

2272

{

Bu Sun Kim

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

[diff] [blame^]

2273

"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

2274

# Object with schema name: TableFieldSchema

2275

],

Bu Sun Kim

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

[diff] [blame^]

2276

"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.

2277

"type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).

2278

"categories": { # [Optional] The categories attached to this field, used for field-level access control.

2279

"names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

2280

"A String",

Dan O'Meara

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

[diff] [blame]

2281

],

2282

},

Bu Sun Kim

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

[diff] [blame^]

2283

"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

2284

"description": "A String", # [Optional] The field description. The maximum length is 1,024 characters.

2285

"policyTags": {

2286

"names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.

2287

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2288

],

2289

},

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

2290

},

2291

],

2292

},

Bu Sun Kim

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

[diff] [blame^]

2293

"hivePartitioningOptions": { # [Optional, Trusted Tester] Options to configure hive partitioning support.

2294

"sourceUriPrefix": "A String", # [Optional, Trusted Tester] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).

2295

"mode": "A String", # [Optional, Trusted Tester] When set, what mode of hive partitioning to use when reading data. Two modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.

2296

},

2297

"maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV, JSON, and Google Sheets. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.

2298

"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '*' wildcard character is not allowed.

2299

"A String",

2300

],

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

2301

},

Bu Sun Kim

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

[diff] [blame^]

2302

"model": { # [Output-only, Beta] Present iff this table represents a ML model. Describes the training information for the model, and it is required to run 'PREDICT' queries.

2303

"modelOptions": { # [Output-only, Beta] Model options used for the first training run. These options are immutable for subsequent training runs. Default values are used for any options not specified in the input query.

"labels": [

"A String",

],

"lossType": "A String",

2308

"modelType": "A String",

2309

},

2310

"trainingRuns": [ # [Output-only, Beta] Information about ml training runs, each training run comprises of multiple iterations and there may be multiple training runs for the model if warm start is used or if a user decides to continue a previously cancelled query.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2311

{

Bu Sun Kim

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

[diff] [blame^]

2312

"trainingOptions": { # [Output-only, Beta] Training options used by this training run. These options are mutable for subsequent training runs. Default values are explicitly stored for options not specified in the input query of the first training run. For subsequent training runs, any option not explicitly specified in the input query will be copied from the previous training run.

2313

"minRelProgress": 3.14,

2314

"l2Reg": 3.14,

2315

"learnRateStrategy": "A String",

2316

"warmStart": True or False,

2317

"lineSearchInitLearnRate": 3.14,

2318

"earlyStop": True or False,

2319

"l1Reg": 3.14,

2320

"maxIteration": "A String",

2321

"learnRate": 3.14,

2322

},

2323

"state": "A String", # [Output-only, Beta] Different state applicable for a training run. IN PROGRESS: Training run is in progress. FAILED: Training run ended due to a non-retryable failure. SUCCEEDED: Training run successfully completed. CANCELLED: Training run cancelled by the user.

2324

"iterationResults": [ # [Output-only, Beta] List of each iteration results.

2325

{

2326

"durationMs": "A String", # [Output-only, Beta] Time taken to run the training iteration in milliseconds.

2327

"trainingLoss": 3.14, # [Output-only, Beta] Training loss computed on the training data at the end of the iteration. The training loss function is defined by model type.

2328

"evalLoss": 3.14, # [Output-only, Beta] Eval loss computed on the eval data at the end of the iteration. The eval loss is used for early stopping to avoid overfitting. No eval loss if eval_split_method option is specified as no_split or auto_split with input data size less than 500 rows.

2329

"index": 42, # [Output-only, Beta] Index of the ML training iteration, starting from zero for each training run.

2330

"learnRate": 3.14, # [Output-only, Beta] Learning rate used for this iteration, it varies for different training iterations if learn_rate_strategy option is not constant.

2331

},

2332

],

2333

"startTime": "A String", # [Output-only, Beta] Training run start time in milliseconds since the epoch.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2334

},

2335

],

2336

},

Bu Sun Kim

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

[diff] [blame^]

2337

"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.

2338

"expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created tables.

2339

"kind": "bigquery#table", # [Output-only] The type of the resource.

2340

"description": "A String", # [Optional] A user-friendly description of this table.

2341

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

2342

"rangePartitioning": { # [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

2343

"range": { # [TrustedTester] [Required] Defines the ranges for range partitioning.

2344

"interval": "A String", # [TrustedTester] [Required] The width of each interval.

2345

"start": "A String", # [TrustedTester] [Required] The start of range partitioning, inclusive.

2346

"end": "A String", # [TrustedTester] [Required] The end of range partitioning, exclusive.

2347

},

2348

"field": "A String", # [TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.

2349

},

2350

"schema": { # [Optional] Describes the schema of this table.

2351

"fields": [ # Describes the fields in a table.

2352

{

2353

"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.

2354

# Object with schema name: TableFieldSchema

2355

],

2356

"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.

2357

"type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).

2358

"categories": { # [Optional] The categories attached to this field, used for field-level access control.

2359

"names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

"A String",

],

},

"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

2364

"description": "A String", # [Optional] The field description. The maximum length is 1,024 characters.

2365

"policyTags": {

2366

"names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.

"A String",

],

},

},

],

},

"id": "A String", # [Output-only] An opaque ID uniquely identifying the table.

2374

"requirePartitionFilter": false, # [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.

2375

"materializedView": { # [Optional] Materialized view definition.

2376

"query": "A String", # [Required] A query whose result is persisted.

2377

"enableRefresh": True or False, # [Optional] [TrustedTester] Enable automatic refresh of the materialized view when the base table is updated. The default value is "true".

2378

"refreshIntervalMs": "A String", # [Optional] [TrustedTester] The maximum frequency at which this materialized view will be refreshed. The default value is "1800000" (30 minutes).

2379

"lastRefreshTime": "A String", # [Output-only] [TrustedTester] The time when this materialized view was last modified, in milliseconds since the epoch.

2380

},

2381

"tableReference": { # [Required] Reference describing the ID of this table.

2382

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

2383

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

2384

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

2385

},

2386

"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.

2387

"numRows": "A String", # [Output-only] The number of rows of data in this table, excluding any data in the streaming buffer.

2388

"clustering": { # [Beta] Clustering specification for the table. Must be specified with partitioning, data in the table will be first partitioned and subsequently clustered.

2389

"fields": [ # [Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.

"A String",

],

},

"type": "A String", # [Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. [TrustedTester] MATERIALIZED_VIEW: SQL query whose result is persisted. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE.

2394

"view": { # [Optional] The view definition.

2395

"useLegacySql": True or False, # Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ Queries and views that reference this view must use the same flag value.

2396

"query": "A String", # [Required] A query that BigQuery executes when the view is referenced.

2397

"userDefinedFunctionResources": [ # Describes user-defined function resources used in the query.

2398

{

2399

"resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).

2400

"inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.

},

],

},

"numLongTermBytes": "A String", # [Output-only] The number of bytes in the table that are considered "long-term storage".

2405

"etag": "A String", # [Output-only] A hash of the table metadata. Used to ensure there were no concurrent modifications to the resource when attempting an update. Not guaranteed to change when the table contents or the fields numRows, numBytes, numLongTermBytes or lastModifiedTime change.

2406

"encryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys).

2407

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

2408

},

2409

"streamingBuffer": { # [Output-only] Contains information regarding this table's streaming buffer, if one is present. This field will be absent if the table is not being streamed to or if there is no data in the streaming buffer.

2410

"estimatedBytes": "A String", # [Output-only] A lower-bound estimate of the number of bytes currently in the streaming buffer.

2411

"estimatedRows": "A String", # [Output-only] A lower-bound estimate of the number of rows currently in the streaming buffer.

2412

"oldestEntryTime": "A String", # [Output-only] Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.

2413

},

2414

"numBytes": "A String", # [Output-only] The size of this table in bytes, excluding any data in the streaming buffer.

2415

"location": "A String", # [Output-only] The geographic location where the table resides. This value is inherited from the dataset.

2416

"friendlyName": "A String", # [Optional] A descriptive name for this table.

2417

"timePartitioning": { # Time-based partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

2418

"field": "A String", # [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED.

2419

"expirationMs": "A String", # [Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value.

2420

"type": "A String", # [Required] The only type supported is DAY, which will generate one partition per day.

2421

"requirePartitionFilter": True or False,

2422

},

2423

"numPhysicalBytes": "A String", # [Output-only] [TrustedTester] The physical size of this table in bytes, excluding any data in the streaming buffer. This includes compression and storage used for time travel.

2424

"labels": { # The labels associated with this table. You can use these to organize and group your tables. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.

2425

"a_key": "A String",

2426

},

John Asmuth

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

[diff] [blame]

}

Returns:

An object of the form:

2432

2433

{

Bu Sun Kim

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

[diff] [blame^]

2434

"externalDataConfiguration": { # [Optional] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.

2435

"googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.

2436

"range": "A String", # [Optional] Range of a sheet to query from. Only used when non-empty. Typical format: sheet_name!top_left_cell_id:bottom_right_cell_id For example: sheet1!A1:B20

2437

"skipLeadingRows": "A String", # [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2438

},

Bu Sun Kim

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

[diff] [blame^]

2439

"autodetect": True or False, # Try to detect schema and format options automatically. Any option specified explicitly will be honored.

2440

"ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.

2441

"sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".

2442

"csvOptions": { # Additional properties to set if sourceFormat is set to CSV.

2443

"encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.

2444

"allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.

2445

"quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.

2446

"skipLeadingRows": "A String", # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.

2447

"allowJaggedRows": True or False, # [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.

2448

"fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2449

},

Bu Sun Kim

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

[diff] [blame^]

2450

"bigtableOptions": { # [Optional] Additional options if sourceFormat is set to BIGTABLE.

2451

"columnFamilies": [ # [Optional] List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

2452

{

Bu Sun Kim

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

[diff] [blame^]

2453

"onlyReadLatest": True or False, # [Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.

2454

"encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.

2455

"columns": [ # [Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

2456

{

Bu Sun Kim

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

[diff] [blame^]

2457

"qualifierEncoded": "A String", # [Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name.

2458

"onlyReadLatest": True or False, # [Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.

2459

"fieldName": "A String", # [Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries.

2460

"qualifierString": "A String",

2461

"encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.

2462

"type": "A String", # [Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

2463

},

2464

],

Bu Sun Kim

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

[diff] [blame^]

2465

"type": "A String", # [Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.

2466

"familyId": "A String", # Identifier of the column family.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

2467

},

2468

],

Bu Sun Kim

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

[diff] [blame^]

2469

"ignoreUnspecifiedColumnFamilies": True or False, # [Optional] If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.

2470

"readRowkeyAsString": True or False, # [Optional] If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

2471

},

Bu Sun Kim

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

[diff] [blame^]

2472

"compression": "A String", # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.

2473

"schema": { # [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.

2474

"fields": [ # Describes the fields in a table.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

2475

{

Bu Sun Kim

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

[diff] [blame^]

2476

"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

2477

# Object with schema name: TableFieldSchema

2478

],

Bu Sun Kim

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

[diff] [blame^]

2479

"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.

2480

"type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).

2481

"categories": { # [Optional] The categories attached to this field, used for field-level access control.

2482

"names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

2483

"A String",

Dan O'Meara

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

[diff] [blame]

2484

],

2485

},

Bu Sun Kim

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

[diff] [blame^]

2486

"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

2487

"description": "A String", # [Optional] The field description. The maximum length is 1,024 characters.

2488

"policyTags": {

2489

"names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.

2490

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2491

],

2492

},

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

2493

},

2494

],

2495

},

Bu Sun Kim

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

[diff] [blame^]

2496

"hivePartitioningOptions": { # [Optional, Trusted Tester] Options to configure hive partitioning support.

2497

"sourceUriPrefix": "A String", # [Optional, Trusted Tester] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).

2498

"mode": "A String", # [Optional, Trusted Tester] When set, what mode of hive partitioning to use when reading data. Two modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.

2499

},

2500

"maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV, JSON, and Google Sheets. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.

2501

"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '*' wildcard character is not allowed.

2502

"A String",

2503

],

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

2504

},

Bu Sun Kim

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

[diff] [blame^]

2505

"model": { # [Output-only, Beta] Present iff this table represents a ML model. Describes the training information for the model, and it is required to run 'PREDICT' queries.

2506

"modelOptions": { # [Output-only, Beta] Model options used for the first training run. These options are immutable for subsequent training runs. Default values are used for any options not specified in the input query.

"labels": [

"A String",

],

"lossType": "A String",

2511

"modelType": "A String",

2512

},

2513

"trainingRuns": [ # [Output-only, Beta] Information about ml training runs, each training run comprises of multiple iterations and there may be multiple training runs for the model if warm start is used or if a user decides to continue a previously cancelled query.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2514

{

Bu Sun Kim

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

[diff] [blame^]

2515

"trainingOptions": { # [Output-only, Beta] Training options used by this training run. These options are mutable for subsequent training runs. Default values are explicitly stored for options not specified in the input query of the first training run. For subsequent training runs, any option not explicitly specified in the input query will be copied from the previous training run.

2516

"minRelProgress": 3.14,

2517

"l2Reg": 3.14,

2518

"learnRateStrategy": "A String",

2519

"warmStart": True or False,

2520

"lineSearchInitLearnRate": 3.14,

2521

"earlyStop": True or False,

2522

"l1Reg": 3.14,

2523

"maxIteration": "A String",

2524

"learnRate": 3.14,

2525

},

2526

"state": "A String", # [Output-only, Beta] Different state applicable for a training run. IN PROGRESS: Training run is in progress. FAILED: Training run ended due to a non-retryable failure. SUCCEEDED: Training run successfully completed. CANCELLED: Training run cancelled by the user.

2527

"iterationResults": [ # [Output-only, Beta] List of each iteration results.

2528

{

2529

"durationMs": "A String", # [Output-only, Beta] Time taken to run the training iteration in milliseconds.

2530

"trainingLoss": 3.14, # [Output-only, Beta] Training loss computed on the training data at the end of the iteration. The training loss function is defined by model type.

2531

"evalLoss": 3.14, # [Output-only, Beta] Eval loss computed on the eval data at the end of the iteration. The eval loss is used for early stopping to avoid overfitting. No eval loss if eval_split_method option is specified as no_split or auto_split with input data size less than 500 rows.

2532

"index": 42, # [Output-only, Beta] Index of the ML training iteration, starting from zero for each training run.

2533

"learnRate": 3.14, # [Output-only, Beta] Learning rate used for this iteration, it varies for different training iterations if learn_rate_strategy option is not constant.

2534

},

2535

],

2536

"startTime": "A String", # [Output-only, Beta] Training run start time in milliseconds since the epoch.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2537

},

2538

],

2539

},

Bu Sun Kim

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

[diff] [blame^]

2540

"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.

2541

"expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created tables.

2542

"kind": "bigquery#table", # [Output-only] The type of the resource.

2543

"description": "A String", # [Optional] A user-friendly description of this table.

2544

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

2545

"rangePartitioning": { # [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

2546

"range": { # [TrustedTester] [Required] Defines the ranges for range partitioning.

2547

"interval": "A String", # [TrustedTester] [Required] The width of each interval.

2548

"start": "A String", # [TrustedTester] [Required] The start of range partitioning, inclusive.

2549

"end": "A String", # [TrustedTester] [Required] The end of range partitioning, exclusive.

2550

},

2551

"field": "A String", # [TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.

2552

},

2553

"schema": { # [Optional] Describes the schema of this table.

2554

"fields": [ # Describes the fields in a table.

2555

{

2556

"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.

2557

# Object with schema name: TableFieldSchema

2558

],

2559

"name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.

2560

"type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).

2561

"categories": { # [Optional] The categories attached to this field, used for field-level access control.

2562

"names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

"A String",

],

},

"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

2567

"description": "A String", # [Optional] The field description. The maximum length is 1,024 characters.

2568

"policyTags": {

2569

"names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.

"A String",

],

},

},

],

},

"id": "A String", # [Output-only] An opaque ID uniquely identifying the table.

2577

"requirePartitionFilter": false, # [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.

2578

"materializedView": { # [Optional] Materialized view definition.

2579

"query": "A String", # [Required] A query whose result is persisted.

2580

"enableRefresh": True or False, # [Optional] [TrustedTester] Enable automatic refresh of the materialized view when the base table is updated. The default value is "true".

2581

"refreshIntervalMs": "A String", # [Optional] [TrustedTester] The maximum frequency at which this materialized view will be refreshed. The default value is "1800000" (30 minutes).

2582

"lastRefreshTime": "A String", # [Output-only] [TrustedTester] The time when this materialized view was last modified, in milliseconds since the epoch.

2583

},

2584

"tableReference": { # [Required] Reference describing the ID of this table.

2585

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

2586

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

2587

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

2588

},

2589

"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.

2590

"numRows": "A String", # [Output-only] The number of rows of data in this table, excluding any data in the streaming buffer.

2591

"clustering": { # [Beta] Clustering specification for the table. Must be specified with partitioning, data in the table will be first partitioned and subsequently clustered.

2592

"fields": [ # [Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.

"A String",

],

},

"type": "A String", # [Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. [TrustedTester] MATERIALIZED_VIEW: SQL query whose result is persisted. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE.

2597

"view": { # [Optional] The view definition.

2598

"useLegacySql": True or False, # Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ Queries and views that reference this view must use the same flag value.

2599

"query": "A String", # [Required] A query that BigQuery executes when the view is referenced.

2600

"userDefinedFunctionResources": [ # Describes user-defined function resources used in the query.

2601

{

2602

"resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).

2603

"inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.

},

],

},

"numLongTermBytes": "A String", # [Output-only] The number of bytes in the table that are considered "long-term storage".

2608

"etag": "A String", # [Output-only] A hash of the table metadata. Used to ensure there were no concurrent modifications to the resource when attempting an update. Not guaranteed to change when the table contents or the fields numRows, numBytes, numLongTermBytes or lastModifiedTime change.

2609

"encryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys).

2610

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

2611

},

2612

"streamingBuffer": { # [Output-only] Contains information regarding this table's streaming buffer, if one is present. This field will be absent if the table is not being streamed to or if there is no data in the streaming buffer.

2613

"estimatedBytes": "A String", # [Output-only] A lower-bound estimate of the number of bytes currently in the streaming buffer.

2614

"estimatedRows": "A String", # [Output-only] A lower-bound estimate of the number of rows currently in the streaming buffer.

2615

"oldestEntryTime": "A String", # [Output-only] Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.

2616

},

2617

"numBytes": "A String", # [Output-only] The size of this table in bytes, excluding any data in the streaming buffer.

2618

"location": "A String", # [Output-only] The geographic location where the table resides. This value is inherited from the dataset.

2619

"friendlyName": "A String", # [Optional] A descriptive name for this table.

2620

"timePartitioning": { # Time-based partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

2621

"field": "A String", # [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED.

2622

"expirationMs": "A String", # [Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value.

2623

"type": "A String", # [Required] The only type supported is DAY, which will generate one partition per day.

2624

"requirePartitionFilter": True or False,

2625

},

2626

"numPhysicalBytes": "A String", # [Output-only] [TrustedTester] The physical size of this table in bytes, excluding any data in the streaming buffer. This includes compression and storage used for time travel.

2627

"labels": { # The labels associated with this table. You can use these to organize and group your tables. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.

2628

"a_key": "A String",

2629

},

John Asmuth