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

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

[diff] [blame]

87

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

Dmitry Frenkel

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

[diff] [blame]

88

<p class="firstline">Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.</p>

Bu Sun Kim

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

[diff] [blame]

89

Dan O'Meara

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

[diff] [blame]

90

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

John Asmuth

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

[diff] [blame]

91

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

92

93

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

94

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

95

96

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

97

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

98

Dan O'Meara

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

[diff] [blame]

99

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

John Asmuth

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

[diff] [blame]

100

<p class="firstline">Updates information in an existing 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>

101

Bu Sun Kim

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

[diff] [blame]

102

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

Dmitry Frenkel

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

[diff] [blame]

103

<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.</p>

Bu Sun Kim

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

[diff] [blame]

104

105

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

Dmitry Frenkel

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

[diff] [blame]

106

<p class="firstline">Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.</p>

Bu Sun Kim

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

[diff] [blame]

107

Dan O'Meara

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

[diff] [blame]

108

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

John Asmuth

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

[diff] [blame]

109

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

110

<h3>Method Details</h3>

111

Dmitry Frenkel

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

[diff] [blame]

112

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

113

<pre>Close httplib2 connections.</pre>

</div>

John Asmuth

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

[diff] [blame]

117

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

118

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

119

120

Args:

121

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

122

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

123

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

</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

128

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

John Asmuth

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

[diff] [blame]

129

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

130

131

Args:

132

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

133

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

134

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

135

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]

136

137

Returns:

138

An object of the form:

139

140

{

Dmitry Frenkel

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

[diff] [blame]

141

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

142

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

143

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

144

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

145

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

Bu Sun Kim

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

[diff] [blame]

146

},

Dmitry Frenkel

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

[diff] [blame]

147

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

148

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

149

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

150

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

151

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

Bu Sun Kim

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

[diff] [blame]

152

},

153

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

Dmitry Frenkel

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

[diff] [blame]

154

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

155

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

156

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

157

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

158

{

159

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

160

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

161

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

162

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

163

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

164

# Object with schema name: TableFieldSchema

165

],

166

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

167

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

"A String",

],

},

"policyTags": {

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

],

},

},

Bu Sun Kim

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

[diff] [blame]

177

],

178

},

Dmitry Frenkel

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

[diff] [blame]

179

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

Bu Sun Kim

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

[diff] [blame]

180

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

Bu Sun Kim

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

[diff] [blame]

181

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

182

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

183

{ # This is used for defining User Defined Function (UDF) resources only when using legacy SQL. Users of Standard SQL should leverage either DDL (e.g. CREATE [TEMPORARY] FUNCTION ... ) or the Routines API to define UDF resources. For additional information on migrating, see: https://cloud.google.com/bigquery/docs/reference/standard-sql/migrating-from-legacy-sql#differences_in_user-defined_javascript_functions

Bu Sun Kim

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

[diff] [blame]

184

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

Bu Sun Kim

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

[diff] [blame]

185

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

Bu Sun Kim

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

[diff] [blame]

186

},

187

],

Dmitry Frenkel

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

[diff] [blame]

188

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

Bu Sun Kim

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

[diff] [blame]

189

},

Dmitry Frenkel

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

[diff] [blame]

190

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

191

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

192

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

193

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

194

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

Bu Sun Kim

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

[diff] [blame]

195

},

Dmitry Frenkel

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

[diff] [blame]

196

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

197

"snapshotDefinition": { # [Output-only] Snapshot definition.

198

"baseTableReference": { # [Required] Reference describing the ID of the table that is snapshotted.

199

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

200

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

201

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

202

},

203

"snapshotTime": "A String", # [Required] The time at which the base table was snapshot.

204

},

205

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

206

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

207

"type": "A String", # [Required] The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. When the type is not specified, the default behavior is DAY.

208

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

209

"requirePartitionFilter": True or False,

Bu Sun Kim

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

[diff] [blame]

210

},

211

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

Bu Sun Kim

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

[diff] [blame]

212

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

Bu Sun Kim

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

[diff] [blame]

213

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

Dmitry Frenkel

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

[diff] [blame]

214

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

Bu Sun Kim

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

[diff] [blame]

215

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

216

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

217

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

218

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

219

},

Bu Sun Kim

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

[diff] [blame]

220

},

Dmitry Frenkel

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

[diff] [blame]

221

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

222

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

223

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

],

},

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

228

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

229

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

230

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

231

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

232

},

233

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

234

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

235

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

236

"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

237

},

238

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

239

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

240

"sourceUriPrefix": "A String", # [Optional] 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).

241

"requirePartitionFilter": True or False, # [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.

242

"mode": "A String", # [Optional] When set, what mode of hive partitioning to use when reading data. The following 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. (3) CUSTOM: partition key schema is encoded in the source URI prefix. 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.

243

},

244

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

245

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

246

"A String",

247

],

248

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

249

"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 (',').

250

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

251

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

252

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

253

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

254

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

255

},

256

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

257

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

258

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

259

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

260

{

261

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

262

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

263

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

264

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

265

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

266

{

267

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

268

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

269

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

270

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

271

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

272

"qualifierString": "A String",

},

],

},

],

},

"connectionId": "A String", # [Optional, Trusted Tester] Connection for external data source.

279

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

280

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

281

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

282

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

283

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

284

{

285

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

286

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

287

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

288

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

289

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

290

# Object with schema name: TableFieldSchema

291

],

292

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

293

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

"A String",

],

},

"policyTags": {

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

],

},

},

],

},

},

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

307

"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] SNAPSHOT: An immutable, read-only table that is a copy of another table. [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.

308

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

309

"a_key": "A String",

310

},

311

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

312

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

313

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

314

"lossType": "A String",

"labels": [

"A String",

],

"modelType": "A String",

319

},

320

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

Bu Sun Kim

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

[diff] [blame]

321

{

Dmitry Frenkel

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

[diff] [blame]

322

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

323

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

324

"warmStart": True or False,

325

"lineSearchInitLearnRate": 3.14,

326

"earlyStop": True or False,

"l2Reg": 3.14,

"learnRate": 3.14,

"l1Reg": 3.14,

"learnRateStrategy": "A String",

331

"minRelProgress": 3.14,

332

"maxIteration": "A String",

Bu Sun Kim

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

[diff] [blame]

333

},

Dmitry Frenkel

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

[diff] [blame]

334

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

335

{

336

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

337

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

338

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

339

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

340

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

341

},

Bu Sun Kim

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

[diff] [blame]

342

],

Dmitry Frenkel

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

[diff] [blame]

343

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

Bu Sun Kim

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

[diff] [blame]

344

},

345

],

346

},

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]

351

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

Dmitry Frenkel

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

[diff] [blame]

352

<pre>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Bu Sun Kim

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

[diff] [blame]

353

354

Args:

Dmitry Frenkel

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

[diff] [blame]

355

resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required)

Bu Sun Kim

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

[diff] [blame]

356

body: object, The request body.

357

The object takes the form of:

358

359

{ # Request message for `GetIamPolicy` method.

Dmitry Frenkel

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

[diff] [blame]

360

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

361

"requestedPolicyVersion": 42, # Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Bu Sun Kim

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

[diff] [blame]

},

}

Returns:

An object of the form:

368

Dmitry Frenkel

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

[diff] [blame]

369

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

370

"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Bu Sun Kim

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

[diff] [blame]

371

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

Dmitry Frenkel

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

[diff] [blame]

372

{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

373

"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.

Bu Sun Kim

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

[diff] [blame]

374

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

Dmitry Frenkel

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

[diff] [blame]

375

{ # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

Bu Sun Kim

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

[diff] [blame]

376

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

Dmitry Frenkel

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

[diff] [blame]

377

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.

Bu Sun Kim

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

[diff] [blame]

378

"A String",

379

],

Bu Sun Kim

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

[diff] [blame]

380

},

381

],

Bu Sun Kim

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

[diff] [blame]

382

},

383

],

Dmitry Frenkel

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

[diff] [blame]

384

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

385

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.

Bu Sun Kim

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

[diff] [blame]

386

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

Dmitry Frenkel

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

[diff] [blame]

387

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

388

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

Bu Sun Kim

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

[diff] [blame]

389

"A String",

390

],

Dmitry Frenkel

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

[diff] [blame]

391

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

392

"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

393

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

394

"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

395

"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

396

},

Bu Sun Kim

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

[diff] [blame]

},

],

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

403

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

John Asmuth

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

[diff] [blame]

404

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

405

406

Args:

407

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

408

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

Dan O'Meara

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

[diff] [blame]

409

body: object, The request body.

John Asmuth

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

[diff] [blame]

410

The object takes the form of:

411

412

{

Dmitry Frenkel

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

[diff] [blame]

413

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

414

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

415

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

416

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

417

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

Bu Sun Kim

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

[diff] [blame]

418

},

Dmitry Frenkel

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

[diff] [blame]

419

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

420

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

421

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

422

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

423

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

Bu Sun Kim

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

[diff] [blame]

424

},

425

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

Dmitry Frenkel

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

[diff] [blame]

426

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

427

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

428

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

429

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

430

{

431

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

432

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

433

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

434

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

435

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

436

# Object with schema name: TableFieldSchema

437

],

438

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

439

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

"A String",

],

},

"policyTags": {

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

],

},

},

Bu Sun Kim

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

[diff] [blame]

449

],

450

},

Dmitry Frenkel

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

[diff] [blame]

451

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

Bu Sun Kim

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

[diff] [blame]

452

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

Bu Sun Kim

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

[diff] [blame]

453

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

454

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

455

{ # This is used for defining User Defined Function (UDF) resources only when using legacy SQL. Users of Standard SQL should leverage either DDL (e.g. CREATE [TEMPORARY] FUNCTION ... ) or the Routines API to define UDF resources. For additional information on migrating, see: https://cloud.google.com/bigquery/docs/reference/standard-sql/migrating-from-legacy-sql#differences_in_user-defined_javascript_functions

Bu Sun Kim

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

[diff] [blame]

456

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

Bu Sun Kim

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

[diff] [blame]

457

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

Bu Sun Kim

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

[diff] [blame]

458

},

459

],

Dmitry Frenkel

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

[diff] [blame]

460

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

Bu Sun Kim

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

[diff] [blame]

461

},

Dmitry Frenkel

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

[diff] [blame]

462

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

463

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

464

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

465

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

466

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

Bu Sun Kim

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

[diff] [blame]

467

},

Dmitry Frenkel

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

[diff] [blame]

468

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

469

"snapshotDefinition": { # [Output-only] Snapshot definition.

470

"baseTableReference": { # [Required] Reference describing the ID of the table that is snapshotted.

471

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

472

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

473

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

474

},

475

"snapshotTime": "A String", # [Required] The time at which the base table was snapshot.

476

},

477

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

478

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

479

"type": "A String", # [Required] The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. When the type is not specified, the default behavior is DAY.

480

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

481

"requirePartitionFilter": True or False,

Bu Sun Kim

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

[diff] [blame]

482

},

483

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

Bu Sun Kim

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

[diff] [blame]

484

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

Bu Sun Kim

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

[diff] [blame]

485

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

Dmitry Frenkel

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

[diff] [blame]

486

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

Bu Sun Kim

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

[diff] [blame]

487

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

488

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

489

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

490

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

491

},

Bu Sun Kim

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

[diff] [blame]

492

},

Dmitry Frenkel

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

[diff] [blame]

493

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

494

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

495

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

],

},

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

500

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

501

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

502

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

503

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

504

},

505

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

506

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

507

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

508

"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

509

},

510

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

511

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

512

"sourceUriPrefix": "A String", # [Optional] 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).

513

"requirePartitionFilter": True or False, # [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.

514

"mode": "A String", # [Optional] When set, what mode of hive partitioning to use when reading data. The following 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. (3) CUSTOM: partition key schema is encoded in the source URI prefix. 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.

515

},

516

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

517

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

518

"A String",

519

],

520

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

521

"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 (',').

522

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

523

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

524

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

525

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

526

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

527

},

528

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

529

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

530

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

531

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

532

{

533

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

534

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

535

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

536

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

537

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

538

{

539

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

540

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

541

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

542

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

543

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

544

"qualifierString": "A String",

},

],

},

],

},

"connectionId": "A String", # [Optional, Trusted Tester] Connection for external data source.

551

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

552

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

553

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

554

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

555

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

556

{

557

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

558

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

559

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

560

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

561

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

562

# Object with schema name: TableFieldSchema

563

],

564

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

565

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

"A String",

],

},

"policyTags": {

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

],

},

},

],

},

},

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

579

"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] SNAPSHOT: An immutable, read-only table that is a copy of another table. [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.

580

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

581

"a_key": "A String",

582

},

583

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

584

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

585

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

586

"lossType": "A String",

"labels": [

"A String",

],

"modelType": "A String",

591

},

592

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

Bu Sun Kim

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

[diff] [blame]

593

{

Dmitry Frenkel

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

[diff] [blame]

594

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

595

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

596

"warmStart": True or False,

597

"lineSearchInitLearnRate": 3.14,

598

"earlyStop": True or False,

"l2Reg": 3.14,

"learnRate": 3.14,

"l1Reg": 3.14,

"learnRateStrategy": "A String",

603

"minRelProgress": 3.14,

604

"maxIteration": "A String",

Bu Sun Kim

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

[diff] [blame]

605

},

Dmitry Frenkel

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

[diff] [blame]

606

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

607

{

608

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

609

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

610

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

611

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

612

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

613

},

Bu Sun Kim

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

[diff] [blame]

614

],

Dmitry Frenkel

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

[diff] [blame]

615

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

Bu Sun Kim

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

[diff] [blame]

616

},

617

],

618

},

John Asmuth

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

[diff] [blame]

}

Returns:

An object of the form:

624

625

{

Dmitry Frenkel

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

[diff] [blame]

626

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

627

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

628

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

629

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

630

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

Bu Sun Kim

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

[diff] [blame]

631

},

Dmitry Frenkel

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

[diff] [blame]

632

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

633

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

634

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

635

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

636

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

Bu Sun Kim

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

[diff] [blame]

637

},

638

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

Dmitry Frenkel

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

[diff] [blame]

639

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

640

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

641

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

642

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

643

{

644

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

645

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

646

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

647

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

648

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

649

# Object with schema name: TableFieldSchema

650

],

651

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

652

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

"A String",

],

},

"policyTags": {

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

],

},

},

Bu Sun Kim

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

[diff] [blame]

662

],

663

},

Dmitry Frenkel

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

[diff] [blame]

664

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

Bu Sun Kim

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

[diff] [blame]

665

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

Bu Sun Kim

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

[diff] [blame]

666

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

667

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

668

{ # This is used for defining User Defined Function (UDF) resources only when using legacy SQL. Users of Standard SQL should leverage either DDL (e.g. CREATE [TEMPORARY] FUNCTION ... ) or the Routines API to define UDF resources. For additional information on migrating, see: https://cloud.google.com/bigquery/docs/reference/standard-sql/migrating-from-legacy-sql#differences_in_user-defined_javascript_functions

Bu Sun Kim

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

[diff] [blame]

669

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

Bu Sun Kim

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

[diff] [blame]

670

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

Bu Sun Kim

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

[diff] [blame]

671

},

672

],

Dmitry Frenkel

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

[diff] [blame]

673

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

Bu Sun Kim

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

[diff] [blame]

674

},

Dmitry Frenkel

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

[diff] [blame]

675

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

676

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

677

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

678

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

679

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

Bu Sun Kim

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

[diff] [blame]

680

},

Dmitry Frenkel

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

[diff] [blame]

681

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

682

"snapshotDefinition": { # [Output-only] Snapshot definition.

683

"baseTableReference": { # [Required] Reference describing the ID of the table that is snapshotted.

684

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

685

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

686

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

687

},

688

"snapshotTime": "A String", # [Required] The time at which the base table was snapshot.

689

},

690

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

691

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

692

"type": "A String", # [Required] The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. When the type is not specified, the default behavior is DAY.

693

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

694

"requirePartitionFilter": True or False,

Bu Sun Kim

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

[diff] [blame]

695

},

696

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

Bu Sun Kim

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

[diff] [blame]

697

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

Bu Sun Kim

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

[diff] [blame]

698

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

Dmitry Frenkel

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

[diff] [blame]

699

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

Bu Sun Kim

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

[diff] [blame]

700

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

701

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

702

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

703

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

704

},

Bu Sun Kim

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

[diff] [blame]

705

},

Dmitry Frenkel

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

[diff] [blame]

706

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

707

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

708

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

],

},

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

713

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

714

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

715

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

716

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

717

},

718

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

719

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

720

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

721

"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

722

},

723

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

724

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

725

"sourceUriPrefix": "A String", # [Optional] 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).

726

"requirePartitionFilter": True or False, # [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.

727

"mode": "A String", # [Optional] When set, what mode of hive partitioning to use when reading data. The following 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. (3) CUSTOM: partition key schema is encoded in the source URI prefix. 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.

728

},

729

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

730

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

731

"A String",

732

],

733

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

734

"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 (',').

735

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

736

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

737

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

738

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

739

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

740

},

741

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

742

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

743

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

744

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

745

{

746

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

747

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

748

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

749

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

750

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

751

{

752

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

753

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

754

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

755

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

756

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

757

"qualifierString": "A String",

},

],

},

],

},

"connectionId": "A String", # [Optional, Trusted Tester] Connection for external data source.

764

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

765

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

766

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

767

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

768

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

769

{

770

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

771

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

772

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

773

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

774

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

775

# Object with schema name: TableFieldSchema

776

],

777

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

778

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

"A String",

],

},

"policyTags": {

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

],

},

},

],

},

},

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

792

"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] SNAPSHOT: An immutable, read-only table that is a copy of another table. [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.

793

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

794

"a_key": "A String",

795

},

796

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

797

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

798

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

799

"lossType": "A String",

"labels": [

"A String",

],

"modelType": "A String",

804

},

805

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

Bu Sun Kim

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

[diff] [blame]

806

{

Dmitry Frenkel

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

[diff] [blame]

807

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

808

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

809

"warmStart": True or False,

810

"lineSearchInitLearnRate": 3.14,

811

"earlyStop": True or False,

"l2Reg": 3.14,

"learnRate": 3.14,

"l1Reg": 3.14,

"learnRateStrategy": "A String",

816

"minRelProgress": 3.14,

817

"maxIteration": "A String",

Bu Sun Kim

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

[diff] [blame]

818

},

Dmitry Frenkel

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

[diff] [blame]

819

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

820

{

821

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

822

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

823

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

824

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

825

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

826

},

Bu Sun Kim

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

[diff] [blame]

827

],

Dmitry Frenkel

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

[diff] [blame]

828

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

Bu Sun Kim

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

[diff] [blame]

829

},

830

],

831

},

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]

837

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

John Asmuth

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

[diff] [blame]

838

839

Args:

840

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

841

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

842

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

843

maxResults: integer, Maximum number of results to return

844

845

Returns:

846

An object of the form:

847

848

{

Bu Sun Kim

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

[diff] [blame]

849

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

Dmitry Frenkel

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

[diff] [blame]

850

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

Bu Sun Kim

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

[diff] [blame]

851

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

John Asmuth

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

[diff] [blame]

852

{

Bu Sun Kim

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

[diff] [blame]

853

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

Dmitry Frenkel

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

[diff] [blame]

854

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

Bu Sun Kim

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

[diff] [blame]

855

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

856

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

857

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

858

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

Dan O'Meara

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

[diff] [blame]

859

},

860

},

Dmitry Frenkel

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

[diff] [blame]

861

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

862

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

863

"type": "A String", # [Required] The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. When the type is not specified, the default behavior is DAY.

864

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

865

"requirePartitionFilter": True or False,

866

},

867

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

868

"a_key": "A String",

869

},

870

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

871

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

872

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

],

},

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

877

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

878

},

879

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

880

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

Bu Sun Kim

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

[diff] [blame]

881

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

Dmitry Frenkel

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

[diff] [blame]

882

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

Bu Sun Kim

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

[diff] [blame]

883

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

Bu Sun Kim

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

[diff] [blame]

884

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

Bu Sun Kim

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

[diff] [blame]

885

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

886

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

John Asmuth

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

[diff] [blame]

887

},

Bu Sun Kim

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

[diff] [blame]

888

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

John Asmuth

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

[diff] [blame]

889

},

890

],

Dmitry Frenkel

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

[diff] [blame]

891

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

892

"nextPageToken": "A String", # A token to request the next 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>

898

<pre>Retrieves the next page of results.

899

900

Args:

901

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

902

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

903

904

Returns:

Bu Sun Kim

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

[diff] [blame]

905

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

John Asmuth

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

[diff] [blame]

906

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]

911

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

John Asmuth

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

[diff] [blame]

912

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

913

914

Args:

915

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

916

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

917

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

Dan O'Meara

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

[diff] [blame]

918

body: object, The request body.

John Asmuth

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

[diff] [blame]

919

The object takes the form of:

920

921

{

Dmitry Frenkel

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

[diff] [blame]

922

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

923

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

924

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

925

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

926

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

Bu Sun Kim

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

[diff] [blame]

927

},

Dmitry Frenkel

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

[diff] [blame]

928

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

929

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

930

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

931

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

932

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

Bu Sun Kim

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

[diff] [blame]

933

},

934

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

Dmitry Frenkel

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

[diff] [blame]

935

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

936

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

937

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

938

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

939

{

940

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

941

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

942

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

943

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

944

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

945

# Object with schema name: TableFieldSchema

946

],

947

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

948

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

"A String",

],

},

"policyTags": {

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

],

},

},

Bu Sun Kim

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

[diff] [blame]

958

],

959

},

Dmitry Frenkel

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

[diff] [blame]

960

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

Bu Sun Kim

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

[diff] [blame]

961

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

Bu Sun Kim

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

[diff] [blame]

962

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

963

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

964

{ # This is used for defining User Defined Function (UDF) resources only when using legacy SQL. Users of Standard SQL should leverage either DDL (e.g. CREATE [TEMPORARY] FUNCTION ... ) or the Routines API to define UDF resources. For additional information on migrating, see: https://cloud.google.com/bigquery/docs/reference/standard-sql/migrating-from-legacy-sql#differences_in_user-defined_javascript_functions

Bu Sun Kim

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

[diff] [blame]

965

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

Bu Sun Kim

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

[diff] [blame]

966

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

Bu Sun Kim

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

[diff] [blame]

967

},

968

],

Dmitry Frenkel

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

[diff] [blame]

969

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

Bu Sun Kim

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

[diff] [blame]

970

},

Dmitry Frenkel

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

[diff] [blame]

971

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

972

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

973

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

974

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

975

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

Bu Sun Kim

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

[diff] [blame]

976

},

Dmitry Frenkel

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

[diff] [blame]

977

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

978

"snapshotDefinition": { # [Output-only] Snapshot definition.

979

"baseTableReference": { # [Required] Reference describing the ID of the table that is snapshotted.

980

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

981

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

982

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

983

},

984

"snapshotTime": "A String", # [Required] The time at which the base table was snapshot.

985

},

986

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

987

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

988

"type": "A String", # [Required] The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. When the type is not specified, the default behavior is DAY.

989

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

990

"requirePartitionFilter": True or False,

Bu Sun Kim

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

[diff] [blame]

991

},

992

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

Bu Sun Kim

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

[diff] [blame]

993

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

Bu Sun Kim

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

[diff] [blame]

994

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

Dmitry Frenkel

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

[diff] [blame]

995

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

Bu Sun Kim

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

[diff] [blame]

996

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

997

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

998

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

999

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

1000

},

Bu Sun Kim

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

[diff] [blame]

1001

},

Dmitry Frenkel

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

[diff] [blame]

1002

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

1003

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

1004

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

],

},

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

1009

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

1010

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

1011

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

1012

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

1013

},

1014

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

1015

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

1016

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

1017

"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

1018

},

1019

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

1020

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

1021

"sourceUriPrefix": "A String", # [Optional] 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).

1022

"requirePartitionFilter": True or False, # [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.

1023

"mode": "A String", # [Optional] When set, what mode of hive partitioning to use when reading data. The following 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. (3) CUSTOM: partition key schema is encoded in the source URI prefix. 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.

1024

},

1025

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

1026

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

1027

"A String",

1028

],

1029

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

1030

"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 (',').

1031

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

1032

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

1033

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

1034

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

1035

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

1036

},

1037

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

1038

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

1039

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

1040

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

1041

{

1042

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

1043

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

1044

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

1045

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

1046

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

1047

{

1048

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

1049

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

1050

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

1051

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

1052

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

1053

"qualifierString": "A String",

},

],

},

],

},

"connectionId": "A String", # [Optional, Trusted Tester] Connection for external data source.

1060

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

1061

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

1062

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

1063

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

1064

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

1065

{

1066

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

1067

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

1068

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

1069

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

1070

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

1071

# Object with schema name: TableFieldSchema

1072

],

1073

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

1074

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

"A String",

],

},

"policyTags": {

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

],

},

},

],

},

},

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

1088

"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] SNAPSHOT: An immutable, read-only table that is a copy of another table. [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.

1089

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

1090

"a_key": "A String",

1091

},

1092

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

1093

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

1094

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

1095

"lossType": "A String",

"labels": [

"A String",

],

"modelType": "A String",

1100

},

1101

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

Bu Sun Kim

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

[diff] [blame]

1102

{

Dmitry Frenkel

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

[diff] [blame]

1103

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

1104

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

1105

"warmStart": True or False,

1106

"lineSearchInitLearnRate": 3.14,

1107

"earlyStop": True or False,

"l2Reg": 3.14,

"learnRate": 3.14,

"l1Reg": 3.14,

"learnRateStrategy": "A String",

1112

"minRelProgress": 3.14,

1113

"maxIteration": "A String",

Bu Sun Kim

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

[diff] [blame]

1114

},

Dmitry Frenkel

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

[diff] [blame]

1115

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

1116

{

1117

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

1118

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

1119

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

1120

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

1121

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

1122

},

Bu Sun Kim

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

[diff] [blame]

1123

],

Dmitry Frenkel

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

[diff] [blame]

1124

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

Bu Sun Kim

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

[diff] [blame]

1125

},

1126

],

1127

},

John Asmuth

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

[diff] [blame]

}

Returns:

An object of the form:

1133

1134

{

Dmitry Frenkel

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

[diff] [blame]

1135

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

1136

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

1137

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

1138

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

1139

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

Bu Sun Kim

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

[diff] [blame]

1140

},

Dmitry Frenkel

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

[diff] [blame]

1141

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

1142

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

1143

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

1144

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

1145

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

Bu Sun Kim

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

[diff] [blame]

1146

},

1147

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

Dmitry Frenkel

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

[diff] [blame]

1148

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

1149

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

1150

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

1151

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

1152

{

1153

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

1154

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

1155

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

1156

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

1157

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

1158

# Object with schema name: TableFieldSchema

1159

],

1160

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

1161

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

"A String",

],

},

"policyTags": {

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

],

},

},

Bu Sun Kim

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

[diff] [blame]

1171

],

1172

},

Dmitry Frenkel

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

[diff] [blame]

1173

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

Bu Sun Kim

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

[diff] [blame]

1174

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

Bu Sun Kim

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

[diff] [blame]

1175

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

1176

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

1177

{ # This is used for defining User Defined Function (UDF) resources only when using legacy SQL. Users of Standard SQL should leverage either DDL (e.g. CREATE [TEMPORARY] FUNCTION ... ) or the Routines API to define UDF resources. For additional information on migrating, see: https://cloud.google.com/bigquery/docs/reference/standard-sql/migrating-from-legacy-sql#differences_in_user-defined_javascript_functions

Bu Sun Kim

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

[diff] [blame]

1178

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

Bu Sun Kim

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

[diff] [blame]

1179

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

Bu Sun Kim

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

[diff] [blame]

1180

},

1181

],

Dmitry Frenkel

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

[diff] [blame]

1182

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

Bu Sun Kim

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

[diff] [blame]

1183

},

Dmitry Frenkel

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

[diff] [blame]

1184

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

1185

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

1186

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

1187

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

1188

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

Bu Sun Kim

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

[diff] [blame]

1189

},

Dmitry Frenkel

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

[diff] [blame]

1190

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

1191

"snapshotDefinition": { # [Output-only] Snapshot definition.

1192

"baseTableReference": { # [Required] Reference describing the ID of the table that is snapshotted.

1193

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

1194

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

1195

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

1196

},

1197

"snapshotTime": "A String", # [Required] The time at which the base table was snapshot.

1198

},

1199

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

1200

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

1201

"type": "A String", # [Required] The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. When the type is not specified, the default behavior is DAY.

1202

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

1203

"requirePartitionFilter": True or False,

Bu Sun Kim

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

[diff] [blame]

1204

},

1205

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

Bu Sun Kim

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

[diff] [blame]

1206

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

Bu Sun Kim

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

[diff] [blame]

1207

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

Dmitry Frenkel

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

[diff] [blame]

1208

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

Bu Sun Kim

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

[diff] [blame]

1209

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

1210

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

1211

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

1212

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

1213

},

Bu Sun Kim

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

[diff] [blame]

1214

},

Dmitry Frenkel

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

[diff] [blame]

1215

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

1216

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

1217

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

],

},

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

1222

"tableReference": { # [Required] Reference describing the ID of this table.

1223

"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.

1224

"projectId": "A String", # [Required] The ID of the project containing this table.

1225

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

1226

},

1227

"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.

1228

"googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.

1229

"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.

1230

"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

1231

},

1232

"autodetect": True or False, # Try to detect schema and format options automatically. Any option specified explicitly will be honored.

1233

"hivePartitioningOptions": { # [Optional, Trusted Tester] Options to configure hive partitioning support.

1234

"sourceUriPrefix": "A String", # [Optional] 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).

1235

"requirePartitionFilter": True or False, # [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.

1236

"mode": "A String", # [Optional] When set, what mode of hive partitioning to use when reading data. The following 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. (3) CUSTOM: partition key schema is encoded in the source URI prefix. 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.

1237

},

1238

"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.

1239

"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.

1240

"A String",

1241

],

1242

"csvOptions": { # Additional properties to set if sourceFormat is set to CSV.

1243

"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 (',').

1244

"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.

1245

"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.

1246

"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.

1247

"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.

1248

"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.

1249

},

1250

"bigtableOptions": { # [Optional] Additional options if sourceFormat is set to BIGTABLE.

1251

"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.

1252

"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.

1253

"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.

1254

{

1255

"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.

1256

"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.

1257

"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.

1258

"familyId": "A String", # Identifier of the column family.

1259

"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.

1260

{

1261

"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.

1262

"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.

1263

"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.

1264

"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.

1265

"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.

1266

"qualifierString": "A String",

},

],

},

],

},

"connectionId": "A String", # [Optional, Trusted Tester] Connection for external data source.

1273

"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.

1274

"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.

1275

"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".

1276

"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.

1277

"fields": [ # Describes the fields in a table.

1278

{

1279

"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.

1280

"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).

1281

"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

1282

"description": "A String", # [Optional] The field description. The maximum length is 1,024 characters.

1283

"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.

1284

# Object with schema name: TableFieldSchema

1285

],

1286

"categories": { # [Optional] The categories attached to this field, used for field-level access control.

1287

"names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

"A String",

],

},

"policyTags": {

"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",

],

},

},

],

},

},

"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.

1301

"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] SNAPSHOT: An immutable, read-only table that is a copy of another table. [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.

1302

"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.

1303

"a_key": "A String",

1304

},

1305

"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.

1306

"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.

1307

"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.

1308

"lossType": "A String",

"labels": [

"A String",

],

"modelType": "A String",

1313

},

1314

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1315

{

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1316

"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.

1317

"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.

1318

"warmStart": True or False,

1319

"lineSearchInitLearnRate": 3.14,

1320

"earlyStop": True or False,

"l2Reg": 3.14,

"learnRate": 3.14,

"l1Reg": 3.14,

"learnRateStrategy": "A String",

1325

"minRelProgress": 3.14,

1326

"maxIteration": "A String",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1327

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1328

"iterationResults": [ # [Output-only, Beta] List of each iteration results.

1329

{

1330

"index": 42, # [Output-only, Beta] Index of the ML training iteration, starting from zero for each training run.

1331

"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.

1332

"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.

1333

"durationMs": "A String", # [Output-only, Beta] Time taken to run the training iteration in milliseconds.

1334

"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.

1335

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1336

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1337

"startTime": "A String", # [Output-only, Beta] Training run start time in milliseconds since the epoch.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1338

},

1339

],

1340

},

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]

1345

<code class="details" id="setIamPolicy">setIamPolicy(resource, body=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1346

<pre>Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1347

1348

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1349

resource: string, REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. (required)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1350

body: object, The request body.

1351

The object takes the form of:

1352

1353

{ # Request message for `SetIamPolicy` method.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1354

"policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.

1355

"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1356

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1357

{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

1358

"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1359

"auditLogConfigs": [ # The configuration for logging of each type of permission.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1360

{ # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1361

"logType": "A String", # The log type that this config enables.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1362

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1363

"A String",

1364

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1365

},

1366

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1367

},

1368

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1369

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

1370

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1371

{ # Associates `members` with a `role`.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1372

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

1373

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1374

"A String",

1375

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1376

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

1377

"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

1378

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

1379

"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

1380

"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

1381

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1382

},

1383

],

1384

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1385

"updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

}

Returns:

An object of the form:

1391

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1392

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

1393

"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1394

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1395

{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

1396

"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1397

"auditLogConfigs": [ # The configuration for logging of each type of permission.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1398

{ # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1399

"logType": "A String", # The log type that this config enables.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1400

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1401

"A String",

1402

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1403

},

1404

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1405

},

1406

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1407

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

1408

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1409

{ # Associates `members` with a `role`.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1410

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

1411

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1412

"A String",

1413

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1414

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

1415

"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

1416

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

1417

"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

1418

"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

1419

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

}</pre>

</div>

<code class="details" id="testIamPermissions">testIamPermissions(resource, body=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1427

<pre>Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1428

1429

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1430

resource: string, REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. (required)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1431

body: object, The request body.

1432

The object takes the form of:

1433

1434

{ # Request message for `TestIamPermissions` method.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1435

"permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"A String",

],

}

Returns:

An object of the form:

1443

1444

{ # Response message for `TestIamPermissions` method.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1445

"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"A String",

],

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1452

<code class="details" id="update">update(projectId, datasetId, tableId, body=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1453

<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.

1454

1455

Args:

1456

projectId: string, Project ID of the table to update (required)

1457

datasetId: string, Dataset ID of the table to update (required)

1458

tableId: string, Table ID of the table to update (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1459

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1460

The object takes the form of:

1461

1462

{

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1463

"description": "A String", # [Optional] A user-friendly description of this table.

1464

"location": "A String", # [Output-only] The geographic location where the table resides. This value is inherited from the dataset.

1465

"numLongTermBytes": "A String", # [Output-only] The number of bytes in the table that are considered "long-term storage".

1466

"encryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys).

1467

"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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1468

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1469

"numRows": "A String", # [Output-only] The number of rows of data in this table, excluding any data in the streaming buffer.

1470

"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.

1471

"estimatedBytes": "A String", # [Output-only] A lower-bound estimate of the number of bytes currently in the streaming buffer.

1472

"estimatedRows": "A String", # [Output-only] A lower-bound estimate of the number of rows currently in the streaming buffer.

1473

"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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1474

},

1475

"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1476

"creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch.

1477

"kind": "bigquery#table", # [Output-only] The type of the resource.

1478

"schema": { # [Optional] Describes the schema of this table.

1479

"fields": [ # Describes the fields in a table.

1480

{

1481

"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.

1482

"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).

1483

"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

1484

"description": "A String", # [Optional] The field description. The maximum length is 1,024 characters.

1485

"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.

1486

# Object with schema name: TableFieldSchema

1487

],

1488

"categories": { # [Optional] The categories attached to this field, used for field-level access control.

1489

"names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

"A String",

],

},

"policyTags": {

"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",

],

},

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1499

],

1500

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1501

"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.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1502

"view": { # [Optional] The view definition.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1503

"query": "A String", # [Required] A query that BigQuery executes when the view is referenced.

1504

"userDefinedFunctionResources": [ # Describes user-defined function resources used in the query.

1505

{ # This is used for defining User Defined Function (UDF) resources only when using legacy SQL. Users of Standard SQL should leverage either DDL (e.g. CREATE [TEMPORARY] FUNCTION ... ) or the Routines API to define UDF resources. For additional information on migrating, see: https://cloud.google.com/bigquery/docs/reference/standard-sql/migrating-from-legacy-sql#differences_in_user-defined_javascript_functions

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1506

"resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1507

"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.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1508

},

1509

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1510

"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.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1511

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1512

"materializedView": { # [Optional] Materialized view definition.

1513

"refreshIntervalMs": "A String", # [Optional] [TrustedTester] The maximum frequency at which this materialized view will be refreshed. The default value is "1800000" (30 minutes).

1514

"query": "A String", # [Required] A query whose result is persisted.

1515

"enableRefresh": True or False, # [Optional] [TrustedTester] Enable automatic refresh of the materialized view when the base table is updated. The default value is "true".

1516

"lastRefreshTime": "A String", # [Output-only] [TrustedTester] The time when this materialized view was last modified, in milliseconds since the epoch.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1517

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1518

"friendlyName": "A String", # [Optional] A descriptive name for this table.

1519

"snapshotDefinition": { # [Output-only] Snapshot definition.

1520

"baseTableReference": { # [Required] Reference describing the ID of the table that is snapshotted.

1521

"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.

1522

"projectId": "A String", # [Required] The ID of the project containing this table.

1523

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

1524

},

1525

"snapshotTime": "A String", # [Required] The time at which the base table was snapshot.

1526

},

1527

"timePartitioning": { # Time-based partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

1528

"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.

1529

"type": "A String", # [Required] The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. When the type is not specified, the default behavior is DAY.

1530

"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.

1531

"requirePartitionFilter": True or False,

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1532

},

1533

"numBytes": "A String", # [Output-only] The size of this table in bytes, excluding any data in the streaming buffer.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1534

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1535

"rangePartitioning": { # [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1536

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1537

"range": { # [TrustedTester] [Required] Defines the ranges for range partitioning.

1538

"interval": "A String", # [TrustedTester] [Required] The width of each interval.

1539

"start": "A String", # [TrustedTester] [Required] The start of range partitioning, inclusive.

1540

"end": "A String", # [TrustedTester] [Required] The end of range partitioning, exclusive.

1541

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1542

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1543

"id": "A String", # [Output-only] An opaque ID uniquely identifying the table.

1544

"clustering": { # [Beta] Clustering specification for the table. Must be specified with partitioning, data in the table will be first partitioned and subsequently clustered.

1545

"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",

],

},

"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.

1550

"tableReference": { # [Required] Reference describing the ID of this table.

1551

"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.

1552

"projectId": "A String", # [Required] The ID of the project containing this table.

1553

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

1554

},

1555

"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.

1556

"googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.

1557

"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.

1558

"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

1559

},

1560

"autodetect": True or False, # Try to detect schema and format options automatically. Any option specified explicitly will be honored.

1561

"hivePartitioningOptions": { # [Optional, Trusted Tester] Options to configure hive partitioning support.

1562

"sourceUriPrefix": "A String", # [Optional] 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).

1563

"requirePartitionFilter": True or False, # [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.

1564

"mode": "A String", # [Optional] When set, what mode of hive partitioning to use when reading data. The following 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. (3) CUSTOM: partition key schema is encoded in the source URI prefix. 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.

1565

},

1566

"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.

1567

"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.

1568

"A String",

1569

],

1570

"csvOptions": { # Additional properties to set if sourceFormat is set to CSV.

1571

"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 (',').

1572

"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.

1573

"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.

1574

"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.

1575

"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.

1576

"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.

1577

},

1578

"bigtableOptions": { # [Optional] Additional options if sourceFormat is set to BIGTABLE.

1579

"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.

1580

"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.

1581

"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.

1582

{

1583

"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.

1584

"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.

1585

"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.

1586

"familyId": "A String", # Identifier of the column family.

1587

"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.

1588

{

1589

"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.

1590

"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.

1591

"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.

1592

"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.

1593

"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.

1594

"qualifierString": "A String",

},

],

},

],

},

"connectionId": "A String", # [Optional, Trusted Tester] Connection for external data source.

1601

"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.

1602

"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.

1603

"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".

1604

"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.

1605

"fields": [ # Describes the fields in a table.

1606

{

1607

"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.

1608

"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).

1609

"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

1610

"description": "A String", # [Optional] The field description. The maximum length is 1,024 characters.

1611

"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.

1612

# Object with schema name: TableFieldSchema

1613

],

1614

"categories": { # [Optional] The categories attached to this field, used for field-level access control.

1615

"names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

"A String",

],

},

"policyTags": {

"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",

],

},

},

],

},

},

"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.

1629

"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] SNAPSHOT: An immutable, read-only table that is a copy of another table. [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.

1630

"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.

1631

"a_key": "A String",

1632

},

1633

"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.

1634

"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.

1635

"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.

1636

"lossType": "A String",

"labels": [

"A String",

],

"modelType": "A String",

1641

},

1642

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1643

{

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1644

"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.

1645

"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.

1646

"warmStart": True or False,

1647

"lineSearchInitLearnRate": 3.14,

1648

"earlyStop": True or False,

"l2Reg": 3.14,

"learnRate": 3.14,

"l1Reg": 3.14,

"learnRateStrategy": "A String",

1653

"minRelProgress": 3.14,

1654

"maxIteration": "A String",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1655

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1656

"iterationResults": [ # [Output-only, Beta] List of each iteration results.

1657

{

1658

"index": 42, # [Output-only, Beta] Index of the ML training iteration, starting from zero for each training run.

1659

"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.

1660

"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.

1661

"durationMs": "A String", # [Output-only, Beta] Time taken to run the training iteration in milliseconds.

1662

"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.

1663

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1664

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1665

"startTime": "A String", # [Output-only, Beta] Training run start time in milliseconds since the epoch.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1666

},

1667

],

1668

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}

Returns:

An object of the form:

1674

1675

{

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1676

"description": "A String", # [Optional] A user-friendly description of this table.

1677

"location": "A String", # [Output-only] The geographic location where the table resides. This value is inherited from the dataset.

1678

"numLongTermBytes": "A String", # [Output-only] The number of bytes in the table that are considered "long-term storage".

1679

"encryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys).

1680

"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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1681

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1682

"numRows": "A String", # [Output-only] The number of rows of data in this table, excluding any data in the streaming buffer.

1683

"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.

1684

"estimatedBytes": "A String", # [Output-only] A lower-bound estimate of the number of bytes currently in the streaming buffer.

1685

"estimatedRows": "A String", # [Output-only] A lower-bound estimate of the number of rows currently in the streaming buffer.

1686

"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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1687

},

1688

"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1689

"creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch.

1690

"kind": "bigquery#table", # [Output-only] The type of the resource.

1691

"schema": { # [Optional] Describes the schema of this table.

1692

"fields": [ # Describes the fields in a table.

1693

{

1694

"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.

1695

"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).

1696

"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

1697

"description": "A String", # [Optional] The field description. The maximum length is 1,024 characters.

1698

"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.

1699

# Object with schema name: TableFieldSchema

1700

],

1701

"categories": { # [Optional] The categories attached to this field, used for field-level access control.

1702

"names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

"A String",

],

},

"policyTags": {

"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",

],

},

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1712

],

1713

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1714

"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.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1715

"view": { # [Optional] The view definition.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1716

"query": "A String", # [Required] A query that BigQuery executes when the view is referenced.

1717

"userDefinedFunctionResources": [ # Describes user-defined function resources used in the query.

1718

{ # This is used for defining User Defined Function (UDF) resources only when using legacy SQL. Users of Standard SQL should leverage either DDL (e.g. CREATE [TEMPORARY] FUNCTION ... ) or the Routines API to define UDF resources. For additional information on migrating, see: https://cloud.google.com/bigquery/docs/reference/standard-sql/migrating-from-legacy-sql#differences_in_user-defined_javascript_functions

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1719

"resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1720

"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.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1721

},

1722

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1723

"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.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1724

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1725

"materializedView": { # [Optional] Materialized view definition.

1726

"refreshIntervalMs": "A String", # [Optional] [TrustedTester] The maximum frequency at which this materialized view will be refreshed. The default value is "1800000" (30 minutes).

1727

"query": "A String", # [Required] A query whose result is persisted.

1728

"enableRefresh": True or False, # [Optional] [TrustedTester] Enable automatic refresh of the materialized view when the base table is updated. The default value is "true".

1729

"lastRefreshTime": "A String", # [Output-only] [TrustedTester] The time when this materialized view was last modified, in milliseconds since the epoch.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1730

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1731

"friendlyName": "A String", # [Optional] A descriptive name for this table.

1732

"snapshotDefinition": { # [Output-only] Snapshot definition.

1733

"baseTableReference": { # [Required] Reference describing the ID of the table that is snapshotted.

1734

"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.

1735

"projectId": "A String", # [Required] The ID of the project containing this table.

1736

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

1737

},

1738

"snapshotTime": "A String", # [Required] The time at which the base table was snapshot.

1739

},

1740

"timePartitioning": { # Time-based partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

1741

"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.

1742

"type": "A String", # [Required] The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. When the type is not specified, the default behavior is DAY.

1743

"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.

1744

"requirePartitionFilter": True or False,

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1745

},

1746

"numBytes": "A String", # [Output-only] The size of this table in bytes, excluding any data in the streaming buffer.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1747

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1748

"rangePartitioning": { # [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1749

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1750

"range": { # [TrustedTester] [Required] Defines the ranges for range partitioning.

1751

"interval": "A String", # [TrustedTester] [Required] The width of each interval.

1752

"start": "A String", # [TrustedTester] [Required] The start of range partitioning, inclusive.

1753

"end": "A String", # [TrustedTester] [Required] The end of range partitioning, exclusive.

1754

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1755

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1756

"id": "A String", # [Output-only] An opaque ID uniquely identifying the table.

1757

"clustering": { # [Beta] Clustering specification for the table. Must be specified with partitioning, data in the table will be first partitioned and subsequently clustered.

1758

"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",

],

},

"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.

1763

"tableReference": { # [Required] Reference describing the ID of this table.

1764

"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.

1765

"projectId": "A String", # [Required] The ID of the project containing this table.

1766

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

1767

},

1768

"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.

1769

"googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.

1770

"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.

1771

"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

1772

},

1773

"autodetect": True or False, # Try to detect schema and format options automatically. Any option specified explicitly will be honored.

1774

"hivePartitioningOptions": { # [Optional, Trusted Tester] Options to configure hive partitioning support.

1775

"sourceUriPrefix": "A String", # [Optional] 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).

1776

"requirePartitionFilter": True or False, # [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.

1777

"mode": "A String", # [Optional] When set, what mode of hive partitioning to use when reading data. The following 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. (3) CUSTOM: partition key schema is encoded in the source URI prefix. 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.

1778

},

1779

"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.

1780

"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.

1781

"A String",

1782

],

1783

"csvOptions": { # Additional properties to set if sourceFormat is set to CSV.

1784

"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 (',').

1785

"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.

1786

"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.

1787

"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.

1788

"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.

1789

"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.

1790

},

1791

"bigtableOptions": { # [Optional] Additional options if sourceFormat is set to BIGTABLE.

1792

"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.

1793

"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.

1794

"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.

1795

{

1796

"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.

1797

"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.

1798

"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.

1799

"familyId": "A String", # Identifier of the column family.

1800

"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.

1801

{

1802

"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.

1803

"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.

1804

"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.

1805

"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.

1806

"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.

1807

"qualifierString": "A String",

},

],

},

],

},

"connectionId": "A String", # [Optional, Trusted Tester] Connection for external data source.

1814

"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.

1815

"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.

1816

"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".

1817

"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.

1818

"fields": [ # Describes the fields in a table.

1819

{

1820

"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.

1821

"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).

1822

"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

1823

"description": "A String", # [Optional] The field description. The maximum length is 1,024 characters.

1824

"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.

1825

# Object with schema name: TableFieldSchema

1826

],

1827

"categories": { # [Optional] The categories attached to this field, used for field-level access control.

1828

"names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

"A String",

],

},

"policyTags": {

"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",

],

},

},

],

},

},

"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.

1842

"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] SNAPSHOT: An immutable, read-only table that is a copy of another table. [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.

1843

"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.

1844

"a_key": "A String",

1845

},

1846

"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.

1847

"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.

1848

"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.

1849

"lossType": "A String",

"labels": [

"A String",

],

"modelType": "A String",

1854

},

1855

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1856

{

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1857

"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.

1858

"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.

1859

"warmStart": True or False,

1860

"lineSearchInitLearnRate": 3.14,

1861

"earlyStop": True or False,

"l2Reg": 3.14,

"learnRate": 3.14,

"l1Reg": 3.14,

"learnRateStrategy": "A String",

1866

"minRelProgress": 3.14,

1867

"maxIteration": "A String",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1868

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1869

"iterationResults": [ # [Output-only, Beta] List of each iteration results.

1870

{

1871

"index": 42, # [Output-only, Beta] Index of the ML training iteration, starting from zero for each training run.

1872

"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.

1873

"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.

1874

"durationMs": "A String", # [Output-only, Beta] Time taken to run the training iteration in milliseconds.

1875

"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.

1876

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1877

],

Dmitry Frenkel