projectId STRING Required

Project ID of the requested table

datasetId STRING Required

Dataset ID of the requested table

tableId STRING Required

Table ID of the requested table

selectedFields STRING

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

type STRING

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

clustering OBJECT

clustering.fields[] STRING

numRows INTEGER

[Output-only] The number of rows of data in this table, excluding any data in the streaming buffer

view OBJECT

view.userDefinedFunctionResources[] OBJECT

view.userDefinedFunctionResources[].resourceUri STRING

[Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path)

view.userDefinedFunctionResources[].inlineCode 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

view.useLegacySql BOOLEAN

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

view.query STRING

[Required] A query that BigQuery executes when the view is referenced

numLongTermBytes INTEGER

[Output-only] The number of bytes in the table that are considered "long-term storage"

etag 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

encryptionConfiguration OBJECT

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

streamingBuffer OBJECT

streamingBuffer.estimatedRows INTEGER

[Output-only] A lower-bound estimate of the number of rows currently in the streaming buffer

streamingBuffer.oldestEntryTime INTEGER

[Output-only] Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available

streamingBuffer.estimatedBytes INTEGER

[Output-only] A lower-bound estimate of the number of bytes currently in the streaming buffer

numBytes INTEGER

[Output-only] The size of this table in bytes, excluding any data in the streaming buffer

location STRING

[Output-only] The geographic location where the table resides. This value is inherited from the dataset

timePartitioning OBJECT

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

timePartitioning.expirationMs INTEGER

[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

timePartitioning.type STRING

[Required] The only type supported is DAY, which will generate one partition per day

timePartitioning.requirePartitionFilter BOOLEAN

friendlyName STRING

[Optional] A descriptive name for this table

labels OBJECT

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

labels.customKey.value STRING

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

numPhysicalBytes INTEGER

[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

externalDataConfiguration OBJECT

externalDataConfiguration.csvOptions OBJECT

externalDataConfiguration.csvOptions.encoding 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

externalDataConfiguration.csvOptions.allowQuotedNewlines BOOLEAN

[Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false

externalDataConfiguration.csvOptions.quote STRING

[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

externalDataConfiguration.csvOptions.skipLeadingRows INTEGER

[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

externalDataConfiguration.csvOptions.allowJaggedRows BOOLEAN

[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

externalDataConfiguration.csvOptions.fieldDelimiter 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 (',')

externalDataConfiguration.bigtableOptions OBJECT

externalDataConfiguration.bigtableOptions.readRowkeyAsString BOOLEAN

[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

externalDataConfiguration.bigtableOptions.columnFamilies[] OBJECT

externalDataConfiguration.bigtableOptions.columnFamilies[].onlyReadLatest BOOLEAN

[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

externalDataConfiguration.bigtableOptions.columnFamilies[].encoding 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

externalDataConfiguration.bigtableOptions.columnFamilies[].type 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

externalDataConfiguration.bigtableOptions.columnFamilies[].familyId STRING

Identifier of the column family

externalDataConfiguration.bigtableOptions.ignoreUnspecifiedColumnFamilies BOOLEAN

[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

externalDataConfiguration.schema OBJECT

externalDataConfiguration.schema.fields[] OBJECT

externalDataConfiguration.schema.fields[].name 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

externalDataConfiguration.schema.fields[].type 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)

externalDataConfiguration.schema.fields[].categories OBJECT

[Optional] The categories attached to this field, used for field-level access control

externalDataConfiguration.schema.fields[].mode STRING

[Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE

externalDataConfiguration.schema.fields[].description STRING

[Optional] The field description. The maximum length is 1,024 characters

externalDataConfiguration.hivePartitioningOptions OBJECT

externalDataConfiguration.hivePartitioningOptions.sourceUriPrefix STRING

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

externalDataConfiguration.hivePartitioningOptions.mode STRING

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

externalDataConfiguration.ignoreUnknownValues BOOLEAN

[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

externalDataConfiguration.autodetect BOOLEAN

Try to detect schema and format options automatically. Any option specified explicitly will be honored

externalDataConfiguration.googleSheetsOptions OBJECT

externalDataConfiguration.googleSheetsOptions.range STRING

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

externalDataConfiguration.googleSheetsOptions.skipLeadingRows INTEGER

[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

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

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

externalDataConfiguration.hivePartitioningMode STRING

[Optional, Trusted Tester] If hive partitioning is enabled, which mode to use. Two modes are supported: - AUTO: automatically infer partition key name(s) and type(s). - STRINGS: automatic infer partition key name(s). All types are strings. Not all storage formats support hive partitioning -- requesting hive partitioning on an unsupported format will lead to an error. Note: this setting is in the process of being deprecated in favor of hivePartitioningOptions

externalDataConfiguration.sourceUris[] STRING

externalDataConfiguration.maxBadRecords INTEGER

[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

model OBJECT

model.modelOptions OBJECT

[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

model.modelOptions.modelType STRING

model.modelOptions.labels[] STRING

model.modelOptions.lossType STRING

model.trainingRuns[] OBJECT

model.trainingRuns[].trainingOptions OBJECT

[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

model.trainingRuns[].trainingOptions.l2Reg NUMBER

model.trainingRuns[].trainingOptions.learnRateStrategy STRING

model.trainingRuns[].trainingOptions.warmStart BOOLEAN

model.trainingRuns[].trainingOptions.lineSearchInitLearnRate NUMBER

model.trainingRuns[].trainingOptions.earlyStop BOOLEAN

model.trainingRuns[].trainingOptions.l1Reg NUMBER

model.trainingRuns[].trainingOptions.maxIteration INTEGER

model.trainingRuns[].trainingOptions.learnRate NUMBER

model.trainingRuns[].trainingOptions.minRelProgress NUMBER

model.trainingRuns[].state 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

model.trainingRuns[].iterationResults[] OBJECT

model.trainingRuns[].startTime DATE_TIME

[Output-only, Beta] Training run start time in milliseconds since the epoch

selfLink STRING

[Output-only] A URL that can be used to access this resource again

expirationTime INTEGER

[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

kind STRING

[Output-only] The type of the resource

description STRING

[Optional] A user-friendly description of this table

creationTime INTEGER

[Output-only] The time when this table was created, in milliseconds since the epoch

rangePartitioning OBJECT

rangePartitioning.range OBJECT

[TrustedTester] [Required] Defines the ranges for range partitioning

rangePartitioning.range.end INTEGER

[TrustedTester] [Required] The end of range partitioning, exclusive

rangePartitioning.range.interval INTEGER

[TrustedTester] [Required] The width of each interval

rangePartitioning.range.start INTEGER

[TrustedTester] [Required] The start of range partitioning, inclusive

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

schema OBJECT

schema.fields[] OBJECT

schema.fields[].name 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

schema.fields[].type 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)

schema.fields[].categories OBJECT

[Optional] The categories attached to this field, used for field-level access control

schema.fields[].categories.names[] STRING

schema.fields[].mode STRING

[Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE

schema.fields[].description STRING

[Optional] The field description. The maximum length is 1,024 characters

schema.fields[].fields[] OBJECT

id STRING

[Output-only] An opaque ID uniquely identifying the table

requirePartitionFilter BOOLEAN

[Beta] [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified

materializedView OBJECT

materializedView.query STRING

[Required] A query whose result is persisted

materializedView.lastRefreshTime INTEGER

[Output-only] [TrustedTester] The time when this materialized view was last modified, in milliseconds since the epoch

tableReference OBJECT

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

tableReference.projectId STRING

[Required] The ID of the project containing this table

tableReference.datasetId STRING

[Required] The ID of the dataset containing this table

lastModifiedTime INTEGER

[Output-only] The time when this table was last modified, in milliseconds since the epoch