--- title: "POST /projects/{projectsId}/jobs/{jobsId}/cancel" method: POST path: "/projects/{projectsId}/jobs/{jobsId}/cancel" tags: ["jobs"] --- # POST /projects/{projectsId}/jobs/{jobsId}/cancel `POST /projects/{projectsId}/jobs/{jobsId}/cancel` ## Request - Base URL: `https://bigquery.googleapis.com/bigquery/v2` - URL: `https://bigquery.googleapis.com/bigquery/v2/projects/{projectsId}/jobs/{jobsId}/cancel` - Auth: one of: - OAuth 2 and OAuth 2 - Implicit: `https://accounts.google.com/o/oauth2/auth` - Scopes: `https://www.googleapis.com/auth/bigquery` - Authorization code: `https://accounts.google.com/o/oauth2/auth` - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/bigquery` - OAuth 2 and OAuth 2 - Implicit: `https://accounts.google.com/o/oauth2/auth` - Scopes: `https://www.googleapis.com/auth/cloud-platform` - Authorization code: `https://accounts.google.com/o/oauth2/auth` - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/cloud-platform` Requests that a job be cancelled. This call will return immediately, and the client will need to poll for the job status to see if the cancel completed successfully. Cancelled jobs may still incur costs. # IAM Permissions Requires the `bigquery.jobs.update` permission on the job resource. If the user matches the creator of the job, the `bigquery.jobs.create` permission on the project is required instead. ## Path parameters - `projectsId` string, required - `jobsId` string, required ## Query parameters - `location` string ## Response `200` Successful response - JobCancelResponse: Describes format of a jobs cancellation response. - `job` Job - `configuration` JobConfiguration - `copy` JobConfigurationTableCopy: JobConfigurationTableCopy configures a job that copies data from one table to another. For more information on copying tables, see [Copy a table](https://cloud.google.com/bigquery/docs/managing-tables#copy-table). - `createDisposition` string: Optional. Specifies whether the job is allowed to create new tables. The following values are supported: * CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. * CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. - `destinationEncryptionConfiguration` EncryptionConfiguration: Configuration for Cloud KMS encryption settings. - `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. - `destinationExpirationTime` string, google-datetime: Optional. The time when the destination table expires. Expired tables will be deleted and their storage reclaimed. - `destinationTable` TableReference - `datasetId` string: Required. The ID of the dataset containing this table. - `projectId` string: Required. The ID of the project containing this table. - `tableId` string: Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`. - `operationType` 'OPERATION_TYPE_UNSPECIFIED' | 'COPY' | 'SNAPSHOT' | 'RESTORE' | 'CLONE': Optional. Supported operation types in table copy job. - `sourceTable` TableReference - `datasetId` string: Required. The ID of the dataset containing this table. - `projectId` string: Required. The ID of the project containing this table. - `tableId` string: Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`. - `sourceTables` TableReference[]: [Pick one] Source tables to copy. - `datasetId` string: Required. The ID of the dataset containing this table. - `projectId` string: Required. The ID of the project containing this table. - `tableId` string: Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`. - `writeDisposition` string: Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data and uses the schema and table constraints from the source table. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. - `dryRun` boolean: Optional. If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined. - `extract` JobConfigurationExtract: JobConfigurationExtract configures a job that exports data from a BigQuery table into Google Cloud Storage. - `compression` string: Optional. The compression type to use for exported files. Possible values include DEFLATE, GZIP, NONE, SNAPPY, and ZSTD. The default value is NONE. Not all compression formats are support for all file formats. DEFLATE is only supported for Avro. ZSTD is only supported for Parquet. Not applicable when extracting models. - `destinationFormat` string: Optional. The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON, PARQUET, or AVRO for tables and ML_TF_SAVED_MODEL or ML_XGBOOST_BOOSTER for models. The default value for tables is CSV. Tables with nested or repeated fields cannot be exported as CSV. The default value for models is ML_TF_SAVED_MODEL. - `destinationUri` string: [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written. - `destinationUris` string[]: [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written. - `fieldDelimiter` string: Optional. When extracting data in CSV format, this defines the delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models. - `modelExtractOptions` ModelExtractOptions: Options related to model extraction. - `trialId` string, int64: The 1-based ID of the trial to be exported from a hyperparameter tuning model. If not specified, the trial with id = [Model](https://cloud.google.com/bigquery/docs/reference/rest/v2/models#resource:-model).defaultTrialId is exported. This field is ignored for models not trained with hyperparameter tuning. - `nativeGeographyExportEnabled` boolean: Optional. Applicable to formats: PARQUET. If enabled, BigQuery to Parquet export will write the native Parquet Geography type instead of the default GeoParquet type. - `printHeader` boolean: Optional. Whether to print out a header row in the results. Default is true. Not applicable when extracting models. - `secureContext` SecureContext: A set of key-value pairs representing the secure context. - `secureParameterEntries` object: Optional. A set of key-value pairs representing the secure parameter values. They can be retrieved via the SECURE_CONTEXT() function and used to modify the run-time behavior of a query. - `sourceModel` ModelReference: Id path of a model. - `datasetId` string: Required. The ID of the dataset containing this model. - `modelId` string: Required. The ID of the model. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. - `projectId` string: Required. The ID of the project containing this model. - `sourceTable` TableReference - `datasetId` string: Required. The ID of the dataset containing this table. - `projectId` string: Required. The ID of the project containing this table. - `tableId` string: Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`. - `useAvroLogicalTypes` boolean: Whether to use logical types when extracting to AVRO format. Not applicable when extracting models. - `jobTimeoutMs` string, int64: Optional. Job timeout in milliseconds relative to the job creation time. If this time limit is exceeded, BigQuery attempts to stop the job, but might not always succeed in canceling it before the job completes. For example, a job that takes more than 60 seconds to complete has a better chance of being stopped than a job that takes 10 seconds to complete. - `jobType` string: Output only. The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN. - `labels` object: The labels associated with this job. You can use these to organize and group your jobs. 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. - `load` JobConfigurationLoad: JobConfigurationLoad contains the configuration properties for loading data into a destination table. - `allowJaggedRows` boolean: Optional. Accept rows that are missing trailing optional columns. The missing values are treated as nulls. 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. Only applicable to CSV, ignored for other formats. - `allowQuotedNewlines` boolean: Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false. - `autodetect` boolean: Optional. Indicates if we should automatically infer the options and schema for CSV and JSON sources. - `clustering` Clustering: Configures table clustering. - `fields` string[]: One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. The ordering of the clustering fields should be prioritized from most to least important for filtering purposes. For additional information, see [Introduction to clustered tables](https://cloud.google.com/bigquery/docs/clustered-tables#limitations). - `columnNameCharacterMap` 'COLUMN_NAME_CHARACTER_MAP_UNSPECIFIED' | 'STRICT' | 'V1' | 'V2': Optional. Character map supported for column names in CSV/Parquet loads. Defaults to STRICT and can be overridden by Project Config Service. Using this option with unsupporting load formats will result in an error. - `connectionProperties` ConnectionProperty[]: Optional. Connection properties which can modify the load job behavior. Currently, only the 'session_id' connection property is supported, and is used to resolve _SESSION appearing as the dataset id. - `key` string: The key of the property to set. - `value` string: The value of the property to set. - `copyFilesOnly` boolean: Optional. [Experimental] Configures the load job to copy files directly to the destination BigLake managed table, bypassing file content reading and rewriting. Copying files only is supported when all the following are true: * `source_uris` are located in the same Cloud Storage location as the destination table's `storage_uri` location. * `source_format` is `PARQUET`. * `destination_table` is an existing BigLake managed table. The table's schema does not have flexible column names. The table's columns do not have type parameters other than precision and scale. * No options other than the above are specified. - `createDisposition` string: Optional. Specifies whether the job is allowed to create new tables. The following values are supported: * CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. * CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. - `createSession` boolean: Optional. If this property is true, the job creates a new session using a randomly generated session_id. To continue using a created session with subsequent queries, pass the existing session identifier as a `ConnectionProperty` value. The session identifier is returned as part of the `SessionInfo` message within the query statistics. The new session's location will be set to `Job.JobReference.location` if it is present, otherwise it's set to the default location based on existing routing logic. - `dateFormat` string: Optional. Date format used for parsing DATE values. - `datetimeFormat` string: Optional. Date format used for parsing DATETIME values. - `decimalTargetTypes` string[]: Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exceeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. - `destinationEncryptionConfiguration` EncryptionConfiguration: Configuration for Cloud KMS encryption settings. - `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. - `destinationTable` TableReference - `datasetId` string: Required. The ID of the dataset containing this table. - `projectId` string: Required. The ID of the project containing this table. - `tableId` string: Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`. - `destinationTableProperties` DestinationTableProperties: Properties for the destination table. - `description` string: Optional. The description for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current description is provided, the job will fail. - `expirationTime` string, date-time: Internal use only. - `friendlyName` string: Optional. Friendly name for the destination table. If the table already exists, it should be same as the existing friendly name. - `labels` object: Optional. The labels associated with this table. You can use these to organize and group your tables. This will only be used if the destination table is newly created. If the table already exists and labels are different than the current labels are provided, the job will fail. - `encoding` string: Optional. The character encoding of the data. The supported values are UTF-8, ISO-8859-1, UTF-16BE, UTF-16LE, UTF-32BE, and UTF-32LE. 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. If you don't specify an encoding, or if you specify a UTF-8 encoding when the CSV file is not UTF-8 encoded, BigQuery attempts to convert the data to UTF-8. Generally, your data loads successfully, but it may not match byte-for-byte what you expect. To avoid this, specify the correct encoding by using the `--encoding` flag. If BigQuery can't convert a character other than the ASCII `0` character, BigQuery converts the character to the standard Unicode replacement character: �. - `fieldDelimiter` string: Optional. The separator character for fields in a CSV file. The separator is interpreted as a single byte. For files encoded in ISO-8859-1, any single character can be used as a separator. For files encoded in UTF-8, characters represented in decimal range 1-127 (U+0001-U+007F) can be used without any modification. UTF-8 characters encoded with multiple bytes (i.e. U+0080 and above) will have only the first byte used for separating fields. The remaining bytes will be treated as a part of the field. BigQuery also supports the escape sequence "\t" (U+0009) to specify a tab separator. The default value is comma (",", U+002C). - `fileSetSpecType` 'FILE_SET_SPEC_TYPE_FILE_SYSTEM_MATCH' | 'FILE_SET_SPEC_TYPE_NEW_LINE_DELIMITED_MANIFEST': Optional. Specifies how source URIs are interpreted for constructing the file set to load. By default, source URIs are expanded against the underlying storage. You can also specify manifest files to control how the file set is constructed. This option is only applicable to object storage systems. - `hivePartitioningOptions` HivePartitioningOptions: Options for configuring hive partitioning detect. - `fields` string[]: Output only. For permanent external tables, this field is populated with the hive partition keys in the order they were inferred. The types of the partition keys can be deduced by checking the table schema (which will include the partition keys). Not every API will populate this field in the output. For example, Tables.Get will populate it, but Tables.List will not contain this field. - `mode` string: Optional. When set, what mode of hive partitioning to use when reading data. The following modes are supported: * AUTO: automatically infer partition key name(s) and type(s). * STRINGS: automatically infer partition key name(s). All types are strings. * 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 formats are: JSON, CSV, ORC, Avro and Parquet. - `requirePartitionFilter` boolean: 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 require_partition_filter explicitly set to true will fail. - `sourceUriPrefix` string: Optional. When hive partition detection is requested, a common prefix for all source uris must be required. 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-06-01/country=USA/id=7/file.avro gs://bucket/path_to_table/dt=2019-05-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/. CUSTOM detection requires encoding the partitioning schema immediately after the common prefix. For CUSTOM, any of * gs://bucket/path_to_table/{dt:DATE}/{country:STRING}/{id:INTEGER} * gs://bucket/path_to_table/{dt:STRING}/{country:STRING}/{id:INTEGER} * gs://bucket/path_to_table/{dt:DATE}/{country:STRING}/{id:STRING} would all be valid source URI prefixes. - `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 in the table schema Avro, Parquet, ORC: Fields in the file schema that don't exist in the table schema. - `jsonExtension` 'JSON_EXTENSION_UNSPECIFIED' | 'GEOJSON': Optional. Load option to be used together with source_format newline-delimited JSON to indicate that a variant of JSON is being loaded. To load newline-delimited GeoJSON, specify GEOJSON (and source_format must be set to NEWLINE_DELIMITED_JSON). - `maxBadRecords` integer: Optional. The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid. This is only supported for CSV and NEWLINE_DELIMITED_JSON file formats. - `nullMarker` string: Optional. Specifies a string that represents a null value in a CSV file. For example, if you specify "\N", BigQuery interprets "\N" as a null value when loading a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value. - `nullMarkers` string[]: Optional. A list of strings represented as SQL NULL value in a CSV file. null_marker and null_markers can't be set at the same time. If null_marker is set, null_markers has to be not set. If null_markers is set, null_marker has to be not set. If both null_marker and null_markers are set at the same time, a user error would be thrown. Any strings listed in null_markers, including empty string would be interpreted as SQL NULL. This applies to all column types. - `parquetOptions` ParquetOptions: Parquet Options for load and make external tables. - `enableListInference` boolean: Optional. Indicates whether to use schema inference specifically for Parquet LIST logical type. - `enumAsString` boolean: Optional. Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default. - `mapTargetType` 'MAP_TARGET_TYPE_UNSPECIFIED' | 'ARRAY_OF_STRUCT': Optional. Indicates how to represent a Parquet map if present. - `preserveAsciiControlCharacters` boolean: Optional. When sourceFormat is set to "CSV", this indicates whether the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') are preserved. - `projectionFields` string[]: If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result. - `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. To include the specific quote character within a quoted value, precede it with an additional matching quote character. For example, if you want to escape the default character ' " ', use ' "" '. @default " - `rangePartitioning` RangePartitioning - `field` string: Required. The name of the column to partition the table on. It must be a top-level, INT64 column whose mode is NULLABLE or REQUIRED. - `range` object: [Experimental] Defines the ranges for range partitioning. - `end` string, int64: [Experimental] The end of range partitioning, exclusive. - `interval` string, int64: [Experimental] The width of each interval. - `start` string, int64: [Experimental] The start of range partitioning, inclusive. - `referenceFileSchemaUri` string: Optional. The user can provide a reference file with the reader schema. This file is only loaded if it is part of source URIs, but is not loaded otherwise. It is enabled for the following formats: AVRO, PARQUET, ORC. - `schema` TableSchema: Schema of a table - `fields` TableFieldSchema[]: Describes the fields in a table. - `categories` object: Deprecated. - … - `collation` string: Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. - `dataGovernanceTagsInfo` object: Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: * **Precedence**: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. * **Patching behavior**: Describes how this field behaves during a `Table.patch` schema update: * **Unset**: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. * **Empty Field**: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This removes all tags from the column. * **Updating tags**: To replace an existing tag, send the field with the new tag. - … - `dataPolicies` DataPolicyOption[]: Optional. Data policies attached to this field, used for field-level access control. - … - `dataPolicyList` DataPolicyList: A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). - … - `defaultValueExpression` string: Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. - `description` string: Optional. The field description. The maximum length is 1,024 characters. - `fields` TableFieldSchema[]: Optional. Describes the nested schema fields if the type property is set to RECORD. - `foreignTypeDefinition` string: Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. - `generatedColumn` GeneratedColumn: Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). - … - `maxLength` string, int64: Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". - `mode` string: Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. - `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 300 characters. - `policyTags` object: Optional. The policy tags attached to this field, used for field-level access control. If not set, defaults to empty policy_tags. - … - `precision` string, int64: Optional. Precision (maximum number of total digits in base 10) and scale (maximum number of digits in the fractional part in base 10) constraints for values of this field for NUMERIC or BIGNUMERIC. It is invalid to set precision or scale if type ≠ "NUMERIC" and ≠ "BIGNUMERIC". If precision and scale are not specified, no value range constraint is imposed on this field insofar as values are permitted by the type. Values of this NUMERIC or BIGNUMERIC field must be in this range when: * Precision (P) and scale (S) are specified: [-10P-S + 10-S, 10P-S - 10-S] * Precision (P) is specified but not scale (and thus scale is interpreted to be equal to zero): [-10P + 1, 10P - 1]. Acceptable values for precision and scale if both are specified: * If type = "NUMERIC": 1 ≤ precision - scale ≤ 29 and 0 ≤ scale ≤ 9. * If type = "BIGNUMERIC": 1 ≤ precision - scale ≤ 38 and 0 ≤ scale ≤ 38. Acceptable values for precision if only precision is specified but not scale (and thus scale is interpreted to be equal to zero): * If type = "NUMERIC": 1 ≤ precision ≤ 29. * If type = "BIGNUMERIC": 1 ≤ precision ≤ 38. If scale is specified but not precision, then it is invalid. - `rangeElementType` object: Represents the type of a field element. - … - `roundingMode` 'ROUNDING_MODE_UNSPECIFIED' | 'ROUND_HALF_AWAY_FROM_ZERO' | 'ROUND_HALF_EVEN': Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. - `scale` string, int64: Optional. See documentation for precision. - `timestampPrecision` string, int64: Optional. Precision (maximum number of total digits in base 10) for seconds of TIMESTAMP type. Possible values include: * 6 (Default, for TIMESTAMP type with microsecond precision) * 12 (For TIMESTAMP type with picosecond precision) - `type` string: Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. - `foreignTypeInfo` ForeignTypeInfo: Metadata about the foreign data type definition such as the system in which the type is defined. - `typeSystem` 'TYPE_SYSTEM_UNSPECIFIED' | 'HIVE': Required. Specifies the system which defines the foreign data type. - `schemaInline` string: [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT". - `schemaInlineFormat` string: [Deprecated] The format of the schemaInline property. - `schemaUpdateOptions` string[]: Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. Schema update options are supported in three cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE_DATA; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. * ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable. - `skipLeadingRows` integer: Optional. The number of rows at the top of a CSV file that BigQuery will skip when loading 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. - `sourceColumnMatch` 'SOURCE_COLUMN_MATCH_UNSPECIFIED' | 'POSITION' | 'NAME': Optional. Controls the strategy used to match loaded columns to the schema. If not set, a sensible default is chosen based on how the schema is provided. If autodetect is used, then columns are matched by name. Otherwise, columns are matched by position. This is done to keep the behavior backward-compatible. - `sourceFormat` string: Optional. The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". For parquet, specify "PARQUET". For orc, specify "ORC". The default value is CSV. - `sourceUris` string[]: [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. - `timeFormat` string: Optional. Date format used for parsing TIME values. - `timePartitioning` TimePartitioning - `expirationMs` string, int64: Optional. Number of milliseconds for which to keep the storage for a partition. A wrapper is used here because 0 is an invalid value. - `field` string: Optional. If not set, the table is partitioned by pseudo column '_PARTITIONTIME'; if set, the table is partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED. A wrapper is used here because an empty string is an invalid value. - `requirePartitionFilter` boolean: If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. This field is deprecated; please set the field with the same name on the table itself instead. This field needs a wrapper because we want to output the default value, false, if the user explicitly set it. - `type` string: Required. The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. - `timeZone` string: Optional. Default time zone that will apply when parsing timestamp values that have no specific time zone. - `timestampFormat` string: Optional. Date format used for parsing TIMESTAMP values. - `timestampTargetPrecision` integer[]: Precisions (maximum number of total digits in base 10) for seconds of TIMESTAMP types that are allowed to the destination table for autodetection mode. Available for the formats: CSV, PARQUET, AVRO, and Iceberg External Table. Possible values include: Not Specified, [], or [6]: timestamp(6) for all auto detected TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP columns that have less than 6 digits of subseconds. timestamp(12) for all auto detected TIMESTAMP columns that have more than 6 digits of subseconds. [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of the elements in this array is ignored. Inputs that have higher precision than the highest target precision in this array will be truncated. - `useAvroLogicalTypes` boolean: Optional. If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER). - `writeDisposition` string: Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the data, removes the constraints and uses the schema from the load job. * WRITE_TRUNCATE_DATA: If the table already exists, BigQuery overwrites the data, but keeps the constraints and schema of the existing table. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. - `maxSlots` integer: Optional. A target limit on the rate of slot consumption by this job. If set to a value > 0, BigQuery will attempt to limit the rate of slot consumption by this job to keep it below the configured limit, even if the job is eligible for more slots based on fair scheduling. The unused slots will be available for other jobs and queries to use. Note: This feature is not yet generally available. - `query` JobConfigurationQuery: JobConfigurationQuery configures a BigQuery query job. - `allowLargeResults` boolean: Optional. If true and query uses legacy SQL dialect, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set. For GoogleSQL queries, this flag is ignored and large results are always allowed. However, you must still set destinationTable when result size exceeds the allowed maximum response size. - `clustering` Clustering: Configures table clustering. - `fields` string[]: One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. The ordering of the clustering fields should be prioritized from most to least important for filtering purposes. For additional information, see [Introduction to clustered tables](https://cloud.google.com/bigquery/docs/clustered-tables#limitations). - `connectionProperties` ConnectionProperty[]: Connection properties which can modify the query behavior. - `key` string: The key of the property to set. - `value` string: The value of the property to set. - `continuous` boolean: [Optional] Specifies whether the query should be executed as a continuous query. The default value is false. - `createDisposition` string: Optional. Specifies whether the job is allowed to create new tables. The following values are supported: * CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. * CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. - `createSession` boolean: If this property is true, the job creates a new session using a randomly generated session_id. To continue using a created session with subsequent queries, pass the existing session identifier as a `ConnectionProperty` value. The session identifier is returned as part of the `SessionInfo` message within the query statistics. The new session's location will be set to `Job.JobReference.location` if it is present, otherwise it's set to the default location based on existing routing logic. - `defaultDataset` DatasetReference: Identifier for a dataset. - `datasetId` string: Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. - `projectId` string: Optional. The ID of the project containing this dataset. - `destinationEncryptionConfiguration` EncryptionConfiguration: Configuration for Cloud KMS encryption settings. - `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. - `destinationTable` TableReference - `datasetId` string: Required. The ID of the dataset containing this table. - `projectId` string: Required. The ID of the project containing this table. - `tableId` string: Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`. - `flattenResults` boolean: Optional. If true and query uses legacy SQL dialect, flattens all nested and repeated fields in the query results. allowLargeResults must be true if this is set to false. For GoogleSQL queries, this flag is ignored and results are never flattened. - `maximumBillingTier` integer: Optional. [Deprecated] Maximum billing tier allowed for this query. The billing tier controls the amount of compute resources allotted to the query, and multiplies the on-demand cost of the query accordingly. A query that runs within its allotted resources will succeed and indicate its billing tier in statistics.query.billingTier, but if the query exceeds its allotted resources, it will fail with billingTierLimitExceeded. WARNING: The billed byte amount can be multiplied by an amount up to this number! Most users should not need to alter this setting, and we recommend that you avoid introducing new uses of it. - `maximumBytesBilled` string, int64: Limits the bytes billed for this job. Queries that will have bytes billed beyond this limit will fail (without incurring a charge). If unspecified, this will be set to your project default. - `parameterMode` string: GoogleSQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query. - `preserveNulls` boolean: [Deprecated] This property is deprecated. - `priority` string: Optional. Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE. - `query` string: [Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or GoogleSQL. - `queryParameters` QueryParameter[]: Query parameters for GoogleSQL queries. - `name` string: Optional. If unset, this is a positional parameter. Otherwise, should be unique within a query. - `parameterType` QueryParameterType: The type of a query parameter. - `arrayType` QueryParameterType (recursive) - `rangeElementType` QueryParameterType (recursive) - `structTypes` object[]: Optional. The types of the fields of this struct, in order, if this is a struct. - … - `timestampPrecision` string, int64: Optional. Precision (maximum number of total digits in base 10) for seconds of TIMESTAMP type. Possible values include: * 6 (Default, for TIMESTAMP type with microsecond precision) * 12 (For TIMESTAMP type with picosecond precision) - `type` string: Required. The top level type of this field. - `parameterValue` QueryParameterValue: The value of a query parameter. - `arrayValues` QueryParameterValue[]: Optional. The array values, if this is an array type. - `rangeValue` RangeValue: Represents the value of a range. - … - `structValues` object: The struct field values. - `value` string: Optional. The value of this value, if a simple scalar type. - `rangePartitioning` RangePartitioning - `field` string: Required. The name of the column to partition the table on. It must be a top-level, INT64 column whose mode is NULLABLE or REQUIRED. - `range` object: [Experimental] Defines the ranges for range partitioning. - `end` string, int64: [Experimental] The end of range partitioning, exclusive. - `interval` string, int64: [Experimental] The width of each interval. - `start` string, int64: [Experimental] The start of range partitioning, inclusive. - `schemaUpdateOptions` string[]: Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in three cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE_DATA; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. * ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable. - `scriptOptions` ScriptOptions: Options related to script execution. - `keyResultStatement` 'KEY_RESULT_STATEMENT_KIND_UNSPECIFIED' | 'LAST' | 'FIRST_SELECT': Determines which statement in the script represents the "key result", used to populate the schema and query results of the script job. Default is LAST. - `statementByteBudget` string, int64: Limit on the number of bytes billed per statement. Exceeding this budget results in an error. - `statementTimeoutMs` string, int64: Timeout period for each statement in a script. - `secureContext` SecureContext: A set of key-value pairs representing the secure context. - `secureParameterEntries` object: Optional. A set of key-value pairs representing the secure parameter values. They can be retrieved via the SECURE_CONTEXT() function and used to modify the run-time behavior of a query. - `systemVariables` SystemVariables: System variables given to a query. - `types` object: Output only. Data type for each system variable. - `values` object: Output only. Value for each system variable. - `tableDefinitions` object: Optional. You can specify external table definitions, which operate as ephemeral tables that can be queried. These definitions are configured using a JSON map, where the string key represents the table identifier, and the value is the corresponding external data configuration object. - `timePartitioning` TimePartitioning - `expirationMs` string, int64: Optional. Number of milliseconds for which to keep the storage for a partition. A wrapper is used here because 0 is an invalid value. - `field` string: Optional. If not set, the table is partitioned by pseudo column '_PARTITIONTIME'; if set, the table is partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED. A wrapper is used here because an empty string is an invalid value. - `requirePartitionFilter` boolean: If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. This field is deprecated; please set the field with the same name on the table itself instead. This field needs a wrapper because we want to output the default value, false, if the user explicitly set it. - `type` string: Required. The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. - `useLegacySql` boolean: Optional. Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query uses BigQuery's [GoogleSQL](https://docs.cloud.google.com/bigquery/docs/introduction-sql). When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false. - `useQueryCache` boolean: Optional. Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified. The default value is true. - `userDefinedFunctionResources` UserDefinedFunctionResource[]: Describes user-defined function resources used in the query. - `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. - `resourceUri` string: [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path). - `writeDisposition` string: Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the data, removes the constraints, and uses the schema from the query result. * WRITE_TRUNCATE_DATA: If the table already exists, BigQuery overwrites the data, but keeps the constraints and schema of the existing table. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. - `writeIncrementalResults` boolean: Optional. This is only supported for a SELECT query using a temporary table. If set, the query is allowed to write results incrementally to the temporary result table. This may incur a performance penalty. This option cannot be used with Legacy SQL. This feature is not yet available. - `reservation` string: Optional. The reservation that job would use. User can specify a reservation to execute the job. If reservation is not set, reservation is determined based on the rules defined by the reservation assignments. The expected format is `projects/{project}/locations/{location}/reservations/{reservation}`. Forces the query to use on-demand billing when set to `none`, which requires the project or organization to have `reservation_override_mode` set to `ALLOW_ANY_OVERRIDE`. - `etag` string: Output only. A hash of this resource. - `id` string: Output only. Opaque ID field of the job. - `jobCreationReason` JobCreationReason: Reason about why a Job was created from a [`jobs.query`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query) method when used with `JOB_CREATION_OPTIONAL` Job creation mode. For [`jobs.insert`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/insert) method calls it will always be `REQUESTED`. - `code` 'CODE_UNSPECIFIED' | 'REQUESTED' | 'LONG_RUNNING' | 'LARGE_RESULTS' | 'OTHER': Output only. Specifies the high level reason why a Job was created. - `jobReference` JobReference: A job reference is a fully qualified identifier for referring to a job. - `jobId` string: Required. The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters. - `location` string: Optional. The geographic location of the job. The default value is US. For more information about BigQuery locations, see: https://cloud.google.com/bigquery/docs/locations - `projectId` string: Required. The ID of the project containing this job. - `kind` string: Output only. The type of the resource. - `principal_subject` string: Output only. [Full-projection-only] String representation of identity of requesting party. Populated for both first- and third-party identities. Only present for APIs that support third-party identities. - `selfLink` string: Output only. A URL that can be used to access the resource again. - `statistics` JobStatistics: Statistics for a single job execution. - `completionRatio` number, double: Output only. [TrustedTester] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs. - `copy` JobStatistics5: Statistics for a copy job. - `copiedLogicalBytes` string, int64: Output only. Number of logical bytes copied to the destination table. - `copiedRows` string, int64: Output only. Number of rows copied to the destination table. - `remoteDestinationRegion` string: Output only. Destination region for a cross-region copy job. Not set for in-region copy jobs. - `creationTime` string, int64: Output only. Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs. - `dataMaskingStatistics` DataMaskingStatistics: Statistics for data-masking. - `dataMaskingApplied` boolean: Whether any accessed data was protected by the data masking. - `edition` 'RESERVATION_EDITION_UNSPECIFIED' | 'STANDARD' | 'ENTERPRISE' | 'ENTERPRISE_PLUS': Output only. Name of edition corresponding to the reservation for this job at the time of this update. - `endTime` string, int64: Output only. End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state. - `extract` JobStatistics4: Statistics for an extract job. - `destinationUriFileCounts` string[]: Output only. Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the 'destinationUris' field. - `inputBytes` string, int64: Output only. Number of user bytes extracted into the result. This is the byte count as computed by BigQuery for billing purposes and doesn't have any relationship with the number of actual result bytes extracted in the desired format. - `timeline` QueryTimelineSample[]: Output only. Describes a timeline of job execution. - `activeUnits` string, int64: Total number of active workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample. - `completedUnits` string, int64: Total parallel units of work completed by this query. - `elapsedMs` string, int64: Milliseconds elapsed since the start of query execution. - `estimatedRunnableUnits` string, int64: Units of work that can be scheduled immediately. Providing additional slots for these units of work will accelerate the query, if no other query in the reservation needs additional slots. - `pendingUnits` string, int64: Total units of work remaining for the query. This number can be revised (increased or decreased) while the query is running. - `shuffleRamUsageRatio` number, double: Total shuffle usage ratio in shuffle RAM per reservation of this query. This will be provided for reservation customers only. - `totalSlotMs` string, int64: Cumulative slot-ms consumed by the query. - `finalExecutionDurationMs` string, int64: Output only. The duration in milliseconds of the execution of the final attempt of this job, as BigQuery may internally re-attempt to execute the job. - `globalQueryRemoteRegions` string[]: Output only. The list of remote regions from which a global query accesses data. This field is populated only for parent global query jobs in the primary execution region. It is empty for child global query jobs and single-region queries. For more information, see [Global queries](https://cloud.google.com/bigquery/docs/global-queries). - `load` JobStatistics3: Statistics for a load job. - `badRecords` string, int64: Output only. The number of bad records encountered. Note that if the job has failed because of more bad records encountered than the maximum allowed in the load job configuration, then this number can be less than the total number of bad records present in the input data. - `inputFileBytes` string, int64: Output only. Number of bytes of source data in a load job. - `inputFiles` string, int64: Output only. Number of source files in a load job. - `outputBytes` string, int64: Output only. Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change. - `outputRows` string, int64: Output only. Number of rows imported in a load job. Note that while an import job is in the running state, this value may change. - `timeline` QueryTimelineSample[]: Output only. Describes a timeline of job execution. - `activeUnits` string, int64: Total number of active workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample. - `completedUnits` string, int64: Total parallel units of work completed by this query. - `elapsedMs` string, int64: Milliseconds elapsed since the start of query execution. - `estimatedRunnableUnits` string, int64: Units of work that can be scheduled immediately. Providing additional slots for these units of work will accelerate the query, if no other query in the reservation needs additional slots. - `pendingUnits` string, int64: Total units of work remaining for the query. This number can be revised (increased or decreased) while the query is running. - `shuffleRamUsageRatio` number, double: Total shuffle usage ratio in shuffle RAM per reservation of this query. This will be provided for reservation customers only. - `totalSlotMs` string, int64: Cumulative slot-ms consumed by the query. - `numChildJobs` string, int64: Output only. Number of child jobs executed. - `parentGlobalQueryJob` JobReference: A job reference is a fully qualified identifier for referring to a job. - `jobId` string: Required. The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters. - `location` string: Optional. The geographic location of the job. The default value is US. For more information about BigQuery locations, see: https://cloud.google.com/bigquery/docs/locations - `projectId` string: Required. The ID of the project containing this job. - `parentJobId` string: Output only. If this is a child job, specifies the job ID of the parent. - `query` JobStatistics2: Statistics for a query job. - `biEngineStatistics` BiEngineStatistics: Statistics for a BI Engine specific query. Populated as part of JobStatistics2 - `accelerationMode` 'BI_ENGINE_ACCELERATION_MODE_UNSPECIFIED' | 'BI_ENGINE_DISABLED' | 'PARTIAL_INPUT' | 'FULL_INPUT' | 'FULL_QUERY': Output only. Specifies which mode of BI Engine acceleration was performed (if any). - `biEngineMode` 'ACCELERATION_MODE_UNSPECIFIED' | 'DISABLED' | 'PARTIAL' | 'FULL': Output only. Specifies which mode of BI Engine acceleration was performed (if any). - `biEngineReasons` BiEngineReason[]: In case of DISABLED or PARTIAL bi_engine_mode, these contain the explanatory reasons as to why BI Engine could not accelerate. In case the full query was accelerated, this field is not populated. - `code` 'CODE_UNSPECIFIED' | 'NO_RESERVATION' | 'INSUFFICIENT_RESERVATION' | 'UNSUPPORTED_SQL_TEXT' | 'INPUT_TOO_LARGE' | 'OTHER_REASON' | 'TABLE_EXCLUDED': Output only. High-level BI Engine reason for partial or disabled acceleration - `message` string: Output only. Free form human-readable reason for partial or disabled acceleration. - `billingTier` integer: Output only. Billing tier for the job. This is a BigQuery-specific concept which is not related to the Google Cloud notion of "free tier". The value here is a measure of the query's resource consumption relative to the amount of data scanned. For on-demand queries, the limit is 100, and all queries within this limit are billed at the standard on-demand rates. On-demand queries that exceed this limit will fail with a billingTierLimitExceeded error. - `cacheHit` boolean: Output only. Whether the query result was fetched from the query cache. - `dclTargetDataset` DatasetReference: Identifier for a dataset. - `datasetId` string: Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. - `projectId` string: Optional. The ID of the project containing this dataset. - `dclTargetTable` TableReference - `datasetId` string: Required. The ID of the dataset containing this table. - `projectId` string: Required. The ID of the project containing this table. - `tableId` string: Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`. - `dclTargetView` TableReference - `datasetId` string: Required. The ID of the dataset containing this table. - `projectId` string: Required. The ID of the project containing this table. - `tableId` string: Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`. - `ddlAffectedRowAccessPolicyCount` string, int64: Output only. The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries. - `ddlDestinationTable` TableReference - `datasetId` string: Required. The ID of the dataset containing this table. - `projectId` string: Required. The ID of the project containing this table. - `tableId` string: Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`. - `ddlOperationPerformed` string: Output only. The DDL operation performed, possibly dependent on the pre-existence of the DDL target. - `ddlTargetDataset` DatasetReference: Identifier for a dataset. - `datasetId` string: Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. - `projectId` string: Optional. The ID of the project containing this dataset. - `ddlTargetRoutine` RoutineReference: Id path of a routine. - `datasetId` string: Required. The ID of the dataset containing this routine. - `projectId` string: Required. The ID of the project containing this routine. - `routineId` string: Required. The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters. - `ddlTargetRowAccessPolicy` RowAccessPolicyReference: Id path of a row access policy. - `datasetId` string: Required. The ID of the dataset containing this row access policy. - `policyId` string: Required. The ID of the row access policy. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters. - `projectId` string: Required. The ID of the project containing this row access policy. - `tableId` string: Required. The ID of the table containing this row access policy. - `ddlTargetTable` TableReference - `datasetId` string: Required. The ID of the dataset containing this table. - `projectId` string: Required. The ID of the project containing this table. - `tableId` string: Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`. - `dmlStats` DmlStatistics: Detailed statistics for DML statements - `deletedRowCount` string, int64: Output only. Number of deleted Rows. populated by DML DELETE, MERGE and TRUNCATE statements. - `dmlMode` 'DML_MODE_UNSPECIFIED' | 'COARSE_GRAINED_DML' | 'FINE_GRAINED_DML': Output only. DML mode used. - `fineGrainedDmlUnusedReason` 'FINE_GRAINED_DML_UNUSED_REASON_UNSPECIFIED' | 'MAX_PARTITION_SIZE_EXCEEDED' | 'TABLE_NOT_ENROLLED' | 'DML_IN_MULTI_STATEMENT_TRANSACTION': Output only. Reason for disabling fine-grained DML if applicable. - `insertedRowCount` string, int64: Output only. Number of inserted Rows. Populated by DML INSERT and MERGE statements - `updatedRowCount` string, int64: Output only. Number of updated Rows. Populated by DML UPDATE and MERGE statements. - `estimatedBytesProcessed` string, int64: Output only. The original estimate of bytes processed for the job. - `exportDataStatistics` ExportDataStatistics: Statistics for the EXPORT DATA statement as part of Query Job. EXTRACT JOB statistics are populated in JobStatistics4. - `fileCount` string, int64: Number of destination files generated in case of EXPORT DATA statement only. - `rowCount` string, int64: [Alpha] Number of destination rows generated in case of EXPORT DATA statement only. - `externalServiceCosts` ExternalServiceCost[]: Output only. Job cost breakdown as bigquery internal cost and external service costs. - `billingMethod` string: The billing method used for the external job. This field, set to `SERVICES_SKU`, is only used when billing under the services SKU. Otherwise, it is unspecified for backward compatibility. - `bytesBilled` string, int64: External service cost in terms of bigquery bytes billed. - `bytesProcessed` string, int64: External service cost in terms of bigquery bytes processed. - `externalService` string: External service name. - `reservedSlotCount` string, int64: Non-preemptable reserved slots used for external job. For example, reserved slots for Cloua AI Platform job are the VM usages converted to BigQuery slot with equivalent mount of price. - `slotMs` string, int64: External service cost in terms of bigquery slot milliseconds. - `genAiStats` GenAiStats: GenAi stats for the query job. - `errorStats` GenAiErrorStats: Provides error statistics for the query job across all AI function calls. - `errors` string[]: A list of unique errors at query level (up to 5, truncated to 100 chars) - `functionStats` GenAiFunctionStats[]: Function level stats for GenAI Functions. For more information, see [Generative AI overview](https://docs.cloud.google.com/bigquery/docs/generative-ai-overview). - `cacheStats` GenAiFunctionCacheStats: Provides cache statistics for a GenAi function call. - … - `costOptimizationStats` GenAiFunctionCostOptimizationStats: Provides cost optimization statistics for a GenAi function call. - … - `errorStats` GenAiFunctionErrorStats: Provides error statistics for a GenAi function call. - … - `functionName` string: Name of the function. - `numProcessedRows` string, int64: Number of rows processed by this GenAi function. This includes all cost_optimized, llm_inferred and failed_rows. - `prompt` string: User input prompt of the function (truncated to 20 chars). - `incrementalResultStats` IncrementalResultStats: Statistics related to Incremental Query Results. Populated as part of JobStatistics2. This feature is not yet available. - `disabledReason` 'DISABLED_REASON_UNSPECIFIED' | 'OTHER' | 'UNSUPPORTED_OPERATOR': Output only. Reason why incremental query results are/were not written by the query. - `disabledReasonDetails` string: Output only. Additional human-readable clarification, if available, for DisabledReason. - `firstIncrementalRowTime` string, google-datetime: Output only. The time at which the first incremental result was written. If the query needed to restart internally, this only describes the final attempt. - `incrementalRowCount` string, int64: Output only. Number of rows that were in the latest result set before query completion. - `lastIncrementalRowTime` string, google-datetime: Output only. The time at which the last incremental result was written. Does not include the final result written after query completion. - `resultSetLastModifyTime` string, google-datetime: Output only. The time at which the result table's contents were modified. May be absent if no results have been written or the query has completed. - `resultSetLastReplaceTime` string, google-datetime: Output only. The time at which the result table's contents were completely replaced. May be absent if no results have been written or the query has completed. - `loadQueryStatistics` LoadQueryStatistics: Statistics for a LOAD query. - `badRecords` string, int64: Output only. The number of bad records encountered while processing a LOAD query. Note that if the job has failed because of more bad records encountered than the maximum allowed in the load job configuration, then this number can be less than the total number of bad records present in the input data. - `bytesTransferred` string, int64: Output only. This field is deprecated. The number of bytes of source data copied over the network for a `LOAD` query. `transferred_bytes` has the canonical value for physical transferred bytes, which is used for BigQuery Omni billing. - `inputFileBytes` string, int64: Output only. Number of bytes of source data in a LOAD query. - `inputFiles` string, int64: Output only. Number of source files in a LOAD query. - `outputBytes` string, int64: Output only. Size of the loaded data in bytes. Note that while a LOAD query is in the running state, this value may change. - `outputRows` string, int64: Output only. Number of rows imported in a LOAD query. Note that while a LOAD query is in the running state, this value may change. - `materializedViewStatistics` MaterializedViewStatistics: Statistics of materialized views considered in a query job. - `materializedView` MaterializedView[]: Materialized views considered for the query job. Only certain materialized views are used. For a detailed list, see the child message. If many materialized views are considered, then the list might be incomplete. - `chosen` boolean: Whether the materialized view is chosen for the query. A materialized view can be chosen to rewrite multiple parts of the same query. If a materialized view is chosen to rewrite any part of the query, then this field is true, even if the materialized view was not chosen to rewrite others parts. - `estimatedBytesSaved` string, int64: If present, specifies a best-effort estimation of the bytes saved by using the materialized view rather than its base tables. - `rejectedReason` 'REJECTED_REASON_UNSPECIFIED' | 'NO_DATA' | 'COST' | 'BASE_TABLE_TRUNCATED' | 'BASE_TABLE_DATA_CHANGE' | 'BASE_TABLE_PARTITION_EXPIRATION_CHANGE' | 'BASE_TABLE_EXPIRED_PARTITION' | 'BASE_TABLE_INCOMPATIBLE_METADATA_CHANGE' | 'TIME_ZONE' | 'OUT_OF_TIME_TRAVEL_WINDOW' | 'BASE_TABLE_FINE_GRAINED_SECURITY_POLICY' | 'BASE_TABLE_TOO_STALE': If present, specifies the reason why the materialized view was not chosen for the query. - `tableReference` TableReference - … - `metadataCacheStatistics` MetadataCacheStatistics: Statistics for metadata caching in queried tables. - `tableMetadataCacheUsage` TableMetadataCacheUsage[]: Set for the Metadata caching eligible tables referenced in the query. - `explanation` string: Free form human-readable reason metadata caching was unused for the job. - `pruningStats` PruningStats: The column metadata index pruning statistics. - … - `staleness` string, google-duration: Duration since last refresh as of this job for managed tables (indicates metadata cache staleness as seen by this job). - `tableReference` TableReference - … - `tableType` string: [Table type](https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#Table.FIELDS.type). - `unusedReason` 'UNUSED_REASON_UNSPECIFIED' | 'EXCEEDED_MAX_STALENESS' | 'METADATA_CACHING_NOT_ENABLED' | 'OTHER_REASON': Reason for not using metadata caching for the table. - `mlStatistics` MlStatistics: Job statistics specific to a BigQuery ML training job. - `hparamTrials` HparamTuningTrial[]: Output only. Trials of a [hyperparameter tuning job](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) sorted by trial_id. - `endTimeMs` string, int64: Ending time of the trial. - `errorMessage` string: Error message for FAILED and INFEASIBLE trial. - `evalLoss` number, double: Loss computed on the eval data at the end of trial. - `evaluationMetrics` EvaluationMetrics: Evaluation metrics of a model. These are either computed on all training data or just the eval data based on whether eval data was used during training. These are not present for imported models. - … - `hparamTuningEvaluationMetrics` EvaluationMetrics: Evaluation metrics of a model. These are either computed on all training data or just the eval data based on whether eval data was used during training. These are not present for imported models. - … - `hparams` TrainingOptions: Options used in model training. - … - `startTimeMs` string, int64: Starting time of the trial. - `status` 'TRIAL_STATUS_UNSPECIFIED' | 'NOT_STARTED' | 'RUNNING' | 'SUCCEEDED' | 'FAILED' | 'INFEASIBLE' | 'STOPPED_EARLY': The status of the trial. - `trainingLoss` number, double: Loss computed on the training data at the end of trial. - `trialId` string, int64: 1-based index of the trial. - `iterationResults` IterationResult[]: Results for all completed iterations. Empty for [hyperparameter tuning jobs](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview). - `arimaResult` ArimaResult: (Auto-)arima fitting result. Wrap everything in ArimaResult for easier refactoring if we want to use model-specific iteration results. - … - `clusterInfos` ClusterInfo[]: Information about top clusters for clustering models. - … - `durationMs` string, int64: Time taken to run the iteration in milliseconds. - `evalLoss` number, double: Loss computed on the eval data at the end of iteration. - `index` integer: Index of the iteration, 0 based. - `learnRate` number, double: Learn rate used for this iteration. - `principalComponentInfos` PrincipalComponentInfo[]: The information of the principal components. - … - `trainingLoss` number, double: Loss computed on the training data at the end of iteration. - `maxIterations` string, int64: Output only. Maximum number of iterations specified as max_iterations in the 'CREATE MODEL' query. The actual number of iterations may be less than this number due to early stop. - `modelType` 'MODEL_TYPE_UNSPECIFIED' | 'LINEAR_REGRESSION' | 'LOGISTIC_REGRESSION' | 'KMEANS' | 'MATRIX_FACTORIZATION' | 'DNN_CLASSIFIER' | 'TENSORFLOW' | 'DNN_REGRESSOR' | 'XGBOOST' | 'BOOSTED_TREE_REGRESSOR' | 'BOOSTED_TREE_CLASSIFIER' | 'ARIMA' | 'AUTOML_REGRESSOR' | 'AUTOML_CLASSIFIER' | 'PCA' | 'DNN_LINEAR_COMBINED_CLASSIFIER' | 'DNN_LINEAR_COMBINED_REGRESSOR' | 'AUTOENCODER' | 'ARIMA_PLUS' | 'ARIMA_PLUS_XREG' | 'RANDOM_FOREST_REGRESSOR' | 'RANDOM_FOREST_CLASSIFIER' | 'TENSORFLOW_LITE' | 'ONNX' | 'TRANSFORM_ONLY' | 'CONTRIBUTION_ANALYSIS': Output only. The type of the model that is being trained. - `trainingType` 'TRAINING_TYPE_UNSPECIFIED' | 'SINGLE_TRAINING' | 'HPARAM_TUNING': Output only. Training type of the job. - `modelTraining` BigQueryModelTraining - `currentIteration` integer: Deprecated. - `expectedTotalIterations` string, int64: Deprecated. - `modelTrainingCurrentIteration` integer: Deprecated. - `modelTrainingExpectedTotalIteration` string, int64: Deprecated. - `numDmlAffectedRows` string, int64: Output only. The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE. - `objectStorageStats` ObjectStorageStats[]: Output only. Storage and caching statistics per cloud provider for queries over object storage. - `cacheBytesRead` string, int64: Total bytes read from the GCP Lakehouse-internal cache, avoiding an object storage read. - `cloudProvider` 'CLOUD_PROVIDER_UNSPECIFIED' | 'GCP' | 'AWS' | 'AZURE': The cloud provider for this block of statistics. - `objectStorageBytesRead` string, int64: Total bytes read directly from the cloud provider's storage. - `performanceInsights` PerformanceInsights: Performance insights for the job. - `avgPreviousExecutionMs` string, int64: Output only. Average execution ms of previous runs. Indicates the job ran slow compared to previous executions. To find previous executions, use INFORMATION_SCHEMA tables and filter jobs with same query hash. - `stagePerformanceChangeInsights` StagePerformanceChangeInsight[]: Output only. Query stage performance insights compared to previous runs, for diagnosing performance regression. - `inputDataChange` InputDataChange: Details about the input data change insight. - … - `stageId` string, int64: Output only. The stage id that the insight mapped to. - `stagePerformanceStandaloneInsights` StagePerformanceStandaloneInsight[]: Output only. Standalone query stage performance insights, for exploring potential improvements. - `biEngineReasons` BiEngineReason[]: Output only. If present, the stage had the following reasons for being disqualified from BI Engine execution. - … - `highCardinalityJoins` HighCardinalityJoin[]: Output only. High cardinality joins in the stage. - … - `insufficientShuffleQuota` boolean: Output only. True if the stage has insufficient shuffle quota. - `partitionSkew` PartitionSkew: Partition skew detailed information. - … - `slotContention` boolean: Output only. True if the stage has a slot contention issue. - `stageId` string, int64: Output only. The stage id that the insight mapped to. - `tableChangeInsights` TableChangeInsight[]: Output only. Performance insights for table-level attributes that changed compared to previous runs. - `metadataCacheNotUsedButUsedPreviously` boolean: Output only. True if the table's column metadata index was not used in the current job, but was used in a previous job with the same query hash. - `metadataCacheStalenessInsight` MetadataCacheStalenessInsight: Column Metadata Index staleness detailed infnormation. - … - `tableReference` TableReference - … - `queryInfo` QueryInfo: Query optimization information for a QUERY job. - `optimizationDetails` object: Output only. Information about query optimizations. - `queryPlan` ExplainQueryStage[]: Output only. Describes execution plan for the query. - `completedParallelInputs` string, int64: Number of parallel input segments completed. - `computeMode` 'COMPUTE_MODE_UNSPECIFIED' | 'BIGQUERY' | 'BI_ENGINE': Output only. Compute mode for this stage. - `computeMsAvg` string, int64: Milliseconds the average shard spent on CPU-bound tasks. - `computeMsMax` string, int64: Milliseconds the slowest shard spent on CPU-bound tasks. - `computeRatioAvg` number, double: Relative amount of time the average shard spent on CPU-bound tasks. - `computeRatioMax` number, double: Relative amount of time the slowest shard spent on CPU-bound tasks. - `endMs` string, int64: Stage end time represented as milliseconds since the epoch. - `id` string, int64: Unique ID for the stage within the plan. - `inputStages` string[]: IDs for stages that are inputs to this stage. - `name` string: Human-readable name for the stage. - `parallelInputs` string, int64: Number of parallel input segments to be processed - `readMsAvg` string, int64: Milliseconds the average shard spent reading input. - `readMsMax` string, int64: Milliseconds the slowest shard spent reading input. - `readRatioAvg` number, double: Relative amount of time the average shard spent reading input. - `readRatioMax` number, double: Relative amount of time the slowest shard spent reading input. - `recordsRead` string, int64: Number of records read into the stage. - `recordsWritten` string, int64: Number of records written by the stage. - `shuffleOutputBytes` string, int64: Total number of bytes written to shuffle. - `shuffleOutputBytesSpilled` string, int64: Total number of bytes written to shuffle and spilled to disk. - `slotMs` string, int64: Slot-milliseconds used by the stage. - `startMs` string, int64: Stage start time represented as milliseconds since the epoch. - `status` string: Current status for this stage. - `steps` ExplainQueryStep[]: List of operations within the stage in dependency order (approximately chronological). - `kind` string: Machine-readable operation type. - `substeps` string[]: Human-readable description of the step(s). - `waitMsAvg` string, int64: Milliseconds the average shard spent waiting to be scheduled. - `waitMsMax` string, int64: Milliseconds the slowest shard spent waiting to be scheduled. - `waitRatioAvg` number, double: Relative amount of time the average shard spent waiting to be scheduled. - `waitRatioMax` number, double: Relative amount of time the slowest shard spent waiting to be scheduled. - `writeMsAvg` string, int64: Milliseconds the average shard spent on writing output. - `writeMsMax` string, int64: Milliseconds the slowest shard spent on writing output. - `writeRatioAvg` number, double: Relative amount of time the average shard spent on writing output. - `writeRatioMax` number, double: Relative amount of time the slowest shard spent on writing output. - `referencedLogicalViews` TableReference[]: Output only. Referenced logical views for the job. - `datasetId` string: Required. The ID of the dataset containing this table. - `projectId` string: Required. The ID of the project containing this table. - `tableId` string: Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`. - `referencedPropertyGraphs` PropertyGraphReference[]: Output only. Referenced property graphs for the job. Queries that reference more than 50 property graphs will not have a complete list. - `datasetId` string: Required. The ID of the dataset containing this property graph. - `projectId` string: Required. The ID of the project containing this property graph. - `propertyGraphId` string: Required. The ID of the property graph. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters. - `referencedRoutines` RoutineReference[]: Output only. Referenced routines for the job. - `datasetId` string: Required. The ID of the dataset containing this routine. - `projectId` string: Required. The ID of the project containing this routine. - `routineId` string: Required. The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters. - `referencedTables` TableReference[]: Output only. Referenced tables for the job. - `datasetId` string: Required. The ID of the dataset containing this table. - `projectId` string: Required. The ID of the project containing this table. - `tableId` string: Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`. - `reservationUsage` object[]: Output only. Job resource usage breakdown by reservation. This field reported misleading information and will no longer be populated. - `name` string: Reservation name or "unreserved" for on-demand resource usage and multi-statement queries. - `slotMs` string, int64: Total slot milliseconds used by the reservation for a particular job. - `schema` TableSchema: Schema of a table - `fields` TableFieldSchema[]: Describes the fields in a table. - `categories` object: Deprecated. - … - `collation` string: Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. - `dataGovernanceTagsInfo` object: Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: * **Precedence**: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. * **Patching behavior**: Describes how this field behaves during a `Table.patch` schema update: * **Unset**: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. * **Empty Field**: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This removes all tags from the column. * **Updating tags**: To replace an existing tag, send the field with the new tag. - … - `dataPolicies` DataPolicyOption[]: Optional. Data policies attached to this field, used for field-level access control. - … - `dataPolicyList` DataPolicyList: A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). - … - `defaultValueExpression` string: Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. - `description` string: Optional. The field description. The maximum length is 1,024 characters. - `fields` TableFieldSchema[]: Optional. Describes the nested schema fields if the type property is set to RECORD. - `foreignTypeDefinition` string: Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. - `generatedColumn` GeneratedColumn: Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). - … - `maxLength` string, int64: Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". - `mode` string: Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. - `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 300 characters. - `policyTags` object: Optional. The policy tags attached to this field, used for field-level access control. If not set, defaults to empty policy_tags. - … - `precision` string, int64: Optional. Precision (maximum number of total digits in base 10) and scale (maximum number of digits in the fractional part in base 10) constraints for values of this field for NUMERIC or BIGNUMERIC. It is invalid to set precision or scale if type ≠ "NUMERIC" and ≠ "BIGNUMERIC". If precision and scale are not specified, no value range constraint is imposed on this field insofar as values are permitted by the type. Values of this NUMERIC or BIGNUMERIC field must be in this range when: * Precision (P) and scale (S) are specified: [-10P-S + 10-S, 10P-S - 10-S] * Precision (P) is specified but not scale (and thus scale is interpreted to be equal to zero): [-10P + 1, 10P - 1]. Acceptable values for precision and scale if both are specified: * If type = "NUMERIC": 1 ≤ precision - scale ≤ 29 and 0 ≤ scale ≤ 9. * If type = "BIGNUMERIC": 1 ≤ precision - scale ≤ 38 and 0 ≤ scale ≤ 38. Acceptable values for precision if only precision is specified but not scale (and thus scale is interpreted to be equal to zero): * If type = "NUMERIC": 1 ≤ precision ≤ 29. * If type = "BIGNUMERIC": 1 ≤ precision ≤ 38. If scale is specified but not precision, then it is invalid. - `rangeElementType` object: Represents the type of a field element. - … - `roundingMode` 'ROUNDING_MODE_UNSPECIFIED' | 'ROUND_HALF_AWAY_FROM_ZERO' | 'ROUND_HALF_EVEN': Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. - `scale` string, int64: Optional. See documentation for precision. - `timestampPrecision` string, int64: Optional. Precision (maximum number of total digits in base 10) for seconds of TIMESTAMP type. Possible values include: * 6 (Default, for TIMESTAMP type with microsecond precision) * 12 (For TIMESTAMP type with picosecond precision) - `type` string: Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. - `foreignTypeInfo` ForeignTypeInfo: Metadata about the foreign data type definition such as the system in which the type is defined. - `typeSystem` 'TYPE_SYSTEM_UNSPECIFIED' | 'HIVE': Required. Specifies the system which defines the foreign data type. - `searchIndexingStats` SearchIndexingStats: Statistics for a search indexing job. Populated as part of JobStatistics2. - `baseTable` TableReference - `datasetId` string: Required. The ID of the dataset containing this table. - `projectId` string: Required. The ID of the project containing this table. - `tableId` string: Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`. - `indexName` string: Output only. The name of the search index. - `searchStatistics` SearchStatistics: Statistics for a search query. Populated as part of JobStatistics2. - `indexPruningStats` IndexPruningStats[]: Search index pruning statistics, one for each base table that has a search index. If a base table does not have a search index or the index does not help with pruning on the base table, then there is no pruning statistics for that table. - `baseTable` TableReference - … - `indexId` string: The index id. - `postIndexPruningParallelInputCount` string, int64: The number of parallel inputs after index pruning. - `preIndexPruningParallelInputCount` string, int64: The number of parallel inputs before index pruning. - `indexUnusedReasons` IndexUnusedReason[]: When `indexUsageMode` is `UNUSED` or `PARTIALLY_USED`, this field explains why indexes were not used in all or part of the search query. If `indexUsageMode` is `FULLY_USED`, this field is not populated. - `baseTable` TableReference - … - `code` 'CODE_UNSPECIFIED' | 'INDEX_CONFIG_NOT_AVAILABLE' | 'PENDING_INDEX_CREATION' | 'BASE_TABLE_TRUNCATED' | 'INDEX_CONFIG_MODIFIED' | 'TIME_TRAVEL_QUERY' | 'NO_PRUNING_POWER' | 'UNINDEXED_SEARCH_FIELDS' | 'UNSUPPORTED_SEARCH_PATTERN' | 'OPTIMIZED_WITH_MATERIALIZED_VIEW' | 'SECURED_BY_DATA_MASKING' | 'MISMATCHED_TEXT_ANALYZER' | 'BASE_TABLE_TOO_SMALL' | 'BASE_TABLE_TOO_LARGE' | 'ESTIMATED_PERFORMANCE_GAIN_TOO_LOW' | 'COLUMN_METADATA_INDEX_NOT_USED' | 'NOT_SUPPORTED_IN_STANDARD_EDITION' | 'INDEX_SUPPRESSED_BY_FUNCTION_OPTION' | 'QUERY_CACHE_HIT' | 'STALE_INDEX' | 'INTERNAL_ERROR' | 'OTHER_REASON': Specifies the high-level reason for the scenario when no search index was used. - `indexName` string: Specifies the name of the unused search index, if available. - `message` string: Free form human-readable reason for the scenario when no search index was used. - `indexUsageMode` 'INDEX_USAGE_MODE_UNSPECIFIED' | 'UNUSED' | 'PARTIALLY_USED' | 'FULLY_USED': Specifies the index usage mode for the query. - `sparkStatistics` SparkStatistics: Statistics for a BigSpark query. Populated as part of JobStatistics2 - `endpoints` object: Output only. Endpoints returned from Dataproc. Key list: - history_server_endpoint: A link to Spark job UI. - `gcsStagingBucket` string: Output only. The Google Cloud Storage bucket that is used as the default file system by the Spark application. This field is only filled when the Spark procedure uses the invoker security mode. The `gcsStagingBucket` bucket is inferred from the `@@spark_proc_properties.staging_bucket` system variable (if it is provided). Otherwise, BigQuery creates a default staging bucket for the job and returns the bucket name in this field. Example: * `gs://[bucket_name]` - `kmsKeyName` string: Output only. The Cloud KMS encryption key that is used to protect the resources created by the Spark job. If the Spark procedure uses the invoker security mode, the Cloud KMS encryption key is either inferred from the provided system variable, `@@spark_proc_properties.kms_key_name`, or the default key of the BigQuery job's project (if the CMEK organization policy is enforced). Otherwise, the Cloud KMS key is either inferred from the Spark connection associated with the procedure (if it is provided), or from the default key of the Spark connection's project if the CMEK organization policy is enforced. Example: * `projects/[kms_project_id]/locations/[region]/keyRings/[key_region]/cryptoKeys/[key]` - `loggingInfo` SparkLoggingInfo: Spark job logs can be filtered by these fields in Cloud Logging. - `projectId` string: Output only. Project ID where the Spark logs were written. - `resourceType` string: Output only. Resource type used for logging. - `sparkJobId` string: Output only. Spark job ID if a Spark job is created successfully. - `sparkJobLocation` string: Output only. Location where the Spark job is executed. A location is selected by BigQueury for jobs configured to run in a multi-region. - `statementType` string: Output only. The type of query statement, if valid. Possible values: * `SELECT`: [`SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#select_list) statement. * `ASSERT`: [`ASSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/debugging-statements#assert) statement. * `INSERT`: [`INSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#insert_statement) statement. * `UPDATE`: [`UPDATE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#update_statement) statement. * `DELETE`: [`DELETE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `MERGE`: [`MERGE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `TRUNCATE_TABLE`: [`TRUNCATE TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#truncate_table_statement) statement. * `CREATE_TABLE`: [`CREATE TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement, without `AS SELECT`. * `CREATE_TABLE_AS_SELECT`: [`CREATE TABLE AS SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement. * `CREATE_VIEW`: [`CREATE VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_view_statement) statement. * `CREATE_MODEL`: [`CREATE MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-create#create_model_statement) statement. * `CREATE_MATERIALIZED_VIEW`: [`CREATE MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_materialized_view_statement) statement. * `CREATE_FUNCTION`: [`CREATE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_function_statement) statement. * `CREATE_TABLE_FUNCTION`: [`CREATE TABLE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_function_statement) statement. * `CREATE_PROCEDURE`: [`CREATE PROCEDURE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_procedure) statement. * `CREATE_ROW_ACCESS_POLICY`: [`CREATE ROW ACCESS POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_row_access_policy_statement) statement. * `CREATE_SCHEMA`: [`CREATE SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_schema_statement) statement. * `CREATE_EXTERNAL_SCHEMA`: [`CREATE EXTERNAL SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_external_schema_statement) statement. * `CREATE_EXTERNAL_TABLE`: [`CREATE EXTERNAL TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_external_table_statement) statement. * `CREATE_SNAPSHOT_TABLE`: [`CREATE SNAPSHOT TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_snapshot_table_statement) statement. * `CREATE_SEARCH_INDEX`: [`CREATE SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_search_index_statement) statement. * `CREATE_VECTOR_INDEX`: [`CREATE VECTOR INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_vector_index_statement) statement. * `CREATE_CONNECTION`: [`CREATE CONNECTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_connection_statement) statement. * `CREATE_DATA_POLICY`: [`CREATE DATA_POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_data_policy_statement) statement. * `CREATE_PROPERTY_GRAPH`: [`CREATE PROPERTY GRAPH`](https://cloud.google.com/bigquery/docs/reference/standard-sql/graph-schema-statements#gql_create_graph) statement. * `CREATE_CAPACITY`: [`CREATE CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_capacity_statement) statement. * `CREATE_RESERVATION`: [`CREATE RESERVATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_reservation_statement) statement. * `CREATE_ASSIGNMENT`: [`CREATE ASSIGNMENT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_assignment_statement) statement. * `DROP_TABLE`: [`DROP TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_statement) statement. * `DROP_EXTERNAL_TABLE`: [`DROP EXTERNAL TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_external_table_statement) statement. * `DROP_VIEW`: [`DROP VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_view_statement) statement. * `DROP_MODEL`: [`DROP MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-drop-model) statement. * `DROP_MATERIALIZED_VIEW`: [`DROP MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_materialized_view_statement) statement. * `DROP_FUNCTION`: [`DROP FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_function_statement) statement. * `DROP_TABLE_FUNCTION`: [`DROP TABLE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_function) statement. * `DROP_PROCEDURE`: [`DROP PROCEDURE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_procedure_statement) statement. * `DROP_SEARCH_INDEX`: [`DROP SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_search_index) statement. * `DROP_VECTOR_INDEX`: [`DROP VECTOR INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_vector_index) statement. * `DROP_SCHEMA`: [`DROP SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_schema_statement) statement. * `UNDROP_SCHEMA`: [`UNDROP SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#undrop_schema_statement) statement. * `DROP_SNAPSHOT_TABLE`: [`DROP SNAPSHOT TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_snapshot_table_statement) statement. * `DROP_ROW_ACCESS_POLICY`: [`DROP [ALL] ROW ACCESS POLICY|POLICIES`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_row_access_policy_statement) statement. * `DROP_CONNECTION`: [`DROP CONNECTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_connection_statement) statement. * `DROP_DATA_POLICY`: [`DROP DATA_POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_data_policy) statement. * `DROP_PROPERTY_GRAPH`: [`DROP PROPERTY GRAPH`](https://cloud.google.com/bigquery/docs/reference/standard-sql/graph-schema-statements#gql_drop_graph) statement. * `DROP_CAPACITY`: [`DROP CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_capacity_statement) statement. * `DROP_RESERVATION`: [`DROP RESERVATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_reservation_statement) statement. * `DROP_ASSIGNMENT`: [`DROP ASSIGNMENT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_assignment_statement) statement. * `ALTER_TABLE`: [`ALTER TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_table_set_options_statement) statement. * `ALTER_VIEW`: [`ALTER VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_view_set_options_statement) statement. * `ALTER_MATERIALIZED_VIEW`: [`ALTER MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_materialized_view_set_options_statement) statement. * `ALTER_SCHEMA`: [`ALTER SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_schema_set_options_statement) statement. * `ALTER_MODEL`: [`ALTER MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-alter-model) statement. * `ALTER_SEARCH_INDEX`: [`ALTER SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_search_index_statement) statement. * `ALTER_VECTOR_INDEX`: [`ALTER VECTOR INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_vector_index_rebuild_statement) statement. * `ALTER_CONNECTION`: [`ALTER CONNECTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_connection_set_options_statement) statement. * `ALTER_DATA_POLICY`: [`ALTER DATA_POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_data_policy_statement) statement. * `ALTER_PROJECT`: [`ALTER PROJECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_project_set_options_statement) statement. * `ALTER_ORGANIZATION`: [`ALTER ORGANIZATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_organization_set_options_statement) statement. * `ALTER_BI_CAPACITY`: [`ALTER BI_CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_bi_capacity_set_options_statement) statement. * `ALTER_CAPACITY`: [`ALTER CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_capacity_set_options_statement) statement. * `ALTER_RESERVATION`: [`ALTER RESERVATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_reservation_set_options_statement) statement. * `SCRIPT`: [`SCRIPT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language) statement. * `CALL`: [`CALL`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#call) statement. * `BEGIN_TRANSACTION`: [`BEGIN TRANSACTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#begin_transaction) statement. * `COMMIT_TRANSACTION`: [`COMMIT TRANSACTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#commit_transaction) statement. * `ROLLBACK_TRANSACTION`: [`ROLLBACK TRANSACTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#rollback_transaction) statement. * `EXPORT_DATA`: [`EXPORT DATA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/export-statements#export_data_statement) statement. * `EXPORT_MODEL`: [`EXPORT MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-export-model) statement. * `EXPORT_METADATA`: [`EXPORT TABLE METADATA`](https://cloud.google.com/bigquery/docs/biglake-iceberg-tables-in-bigquery) statement, for BigLake Iceberg tables. * `LOAD_DATA`: [`LOAD DATA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/load-statements#load_data_statement) statement. * `GRANT_ON_SCHEMA`: [`GRANT ... ON SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. * `GRANT_ON_TABLE`: [`GRANT ... ON TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. Also used for `GRANT ... ON EXTERNAL TABLE`. * `GRANT_ON_VIEW`: [`GRANT ... ON VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. * `GRANT_ON_PROJECT`: [`GRANT ... ON PROJECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. * `REVOKE_ON_SCHEMA`: [`REVOKE ... ON SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement. * `REVOKE_ON_TABLE`: [`REVOKE ... ON TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement. Also used for `REVOKE ... ON EXTERNAL TABLE`. * `REVOKE_ON_VIEW`: [`REVOKE ... ON VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement. * `REVOKE_ON_PROJECT`: [`REVOKE ... ON PROJECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement. - `timeline` QueryTimelineSample[]: Output only. Describes a timeline of job execution. - `activeUnits` string, int64: Total number of active workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample. - `completedUnits` string, int64: Total parallel units of work completed by this query. - `elapsedMs` string, int64: Milliseconds elapsed since the start of query execution. - `estimatedRunnableUnits` string, int64: Units of work that can be scheduled immediately. Providing additional slots for these units of work will accelerate the query, if no other query in the reservation needs additional slots. - `pendingUnits` string, int64: Total units of work remaining for the query. This number can be revised (increased or decreased) while the query is running. - `shuffleRamUsageRatio` number, double: Total shuffle usage ratio in shuffle RAM per reservation of this query. This will be provided for reservation customers only. - `totalSlotMs` string, int64: Cumulative slot-ms consumed by the query. - `totalBytesBilled` string, int64: Output only. If the project is configured to use on-demand pricing, then this field contains the total bytes billed for the job. If the project is configured to use flat-rate pricing, then you are not billed for bytes and this field is informational only. - `totalBytesProcessed` string, int64: Output only. Total bytes processed for the job. - `totalBytesProcessedAccuracy` string: Output only. For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost. - `totalPartitionsProcessed` string, int64: Output only. Total number of partitions processed from all partitioned tables referenced in the job. - `totalServicesSkuSlotMs` string, int64: Output only. Total slot milliseconds for the job that ran on external services and billed on the services SKU. This field is only populated for jobs that have external service costs, and is the total of the usage for costs whose billing method is `"SERVICES_SKU"`. - `totalSlotMs` string, int64: Output only. Slot-milliseconds for the job. - `transferredBytes` string, int64: Output only. Total bytes transferred for BigQuery Omni queries from the remote cloud back to Google Cloud. This tracks data movement over Google-managed connections (like query results). It doesn't include input data read from the external data lake (for example, S3) because that data stays within the remote cloud. - `undeclaredQueryParameters` QueryParameter[]: Output only. GoogleSQL only: list of undeclared query parameters detected during a dry run validation. - `name` string: Optional. If unset, this is a positional parameter. Otherwise, should be unique within a query. - `parameterType` QueryParameterType: The type of a query parameter. - `arrayType` QueryParameterType (recursive) - `rangeElementType` QueryParameterType (recursive) - `structTypes` object[]: Optional. The types of the fields of this struct, in order, if this is a struct. - … - `timestampPrecision` string, int64: Optional. Precision (maximum number of total digits in base 10) for seconds of TIMESTAMP type. Possible values include: * 6 (Default, for TIMESTAMP type with microsecond precision) * 12 (For TIMESTAMP type with picosecond precision) - `type` string: Required. The top level type of this field. - `parameterValue` QueryParameterValue: The value of a query parameter. - `arrayValues` QueryParameterValue[]: Optional. The array values, if this is an array type. - `rangeValue` RangeValue: Represents the value of a range. - … - `structValues` object: The struct field values. - `value` string: Optional. The value of this value, if a simple scalar type. - `vectorSearchIndexingStats` VectorSearchIndexingStats: Statistics for a vector search indexing job. Populated as part of JobStatistics2. - `baseTable` TableReference - `datasetId` string: Required. The ID of the dataset containing this table. - `projectId` string: Required. The ID of the project containing this table. - `tableId` string: Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`. - `indexName` string: Output only. The name of the vector index. - `vectorSearchStatistics` VectorSearchStatistics: Statistics for a vector search query. Populated as part of JobStatistics2. - `indexUnusedReasons` IndexUnusedReason[]: When `indexUsageMode` is `UNUSED` or `PARTIALLY_USED`, this field explains why indexes were not used in all or part of the vector search query. If `indexUsageMode` is `FULLY_USED`, this field is not populated. - `baseTable` TableReference - … - `code` 'CODE_UNSPECIFIED' | 'INDEX_CONFIG_NOT_AVAILABLE' | 'PENDING_INDEX_CREATION' | 'BASE_TABLE_TRUNCATED' | 'INDEX_CONFIG_MODIFIED' | 'TIME_TRAVEL_QUERY' | 'NO_PRUNING_POWER' | 'UNINDEXED_SEARCH_FIELDS' | 'UNSUPPORTED_SEARCH_PATTERN' | 'OPTIMIZED_WITH_MATERIALIZED_VIEW' | 'SECURED_BY_DATA_MASKING' | 'MISMATCHED_TEXT_ANALYZER' | 'BASE_TABLE_TOO_SMALL' | 'BASE_TABLE_TOO_LARGE' | 'ESTIMATED_PERFORMANCE_GAIN_TOO_LOW' | 'COLUMN_METADATA_INDEX_NOT_USED' | 'NOT_SUPPORTED_IN_STANDARD_EDITION' | 'INDEX_SUPPRESSED_BY_FUNCTION_OPTION' | 'QUERY_CACHE_HIT' | 'STALE_INDEX' | 'INTERNAL_ERROR' | 'OTHER_REASON': Specifies the high-level reason for the scenario when no search index was used. - `indexName` string: Specifies the name of the unused search index, if available. - `message` string: Free form human-readable reason for the scenario when no search index was used. - `indexUsageMode` 'INDEX_USAGE_MODE_UNSPECIFIED' | 'UNUSED' | 'PARTIALLY_USED' | 'FULLY_USED': Specifies the index usage mode for the query. - `storedColumnsUsages` StoredColumnsUsage[]: Specifies the usage of stored columns in the query when stored columns are used in the query. - `baseTable` TableReference - … - `isQueryAccelerated` boolean: Specifies whether the query was accelerated with stored columns. - `storedColumnsUnusedReasons` StoredColumnsUnusedReason[]: If stored columns were not used, explain why. - … - `quotaDeferments` string[]: Output only. Quotas which delayed this job's start time. - `reservationGroupPath` string[]: Output only. The reservation group path of the reservation assigned to this job. This field has a limit of 10 nested reservation groups. This is to maintain consistency between reservations info schema and jobs info schema. The first reservation group is the root reservation group and the last is the leaf or lowest level reservation group. - `reservationUsage` object[]: Output only. Job resource usage breakdown by reservation. This field reported misleading information and will no longer be populated. - `name` string: Reservation name or "unreserved" for on-demand resource usage and multi-statement queries. - `slotMs` string, int64: Total slot milliseconds used by the reservation for a particular job. - `reservation_id` string: Output only. Name of the primary reservation assigned to this job. Note that this could be different than reservations reported in the reservation usage field if parent reservations were used to execute this job. - `rowLevelSecurityStatistics` RowLevelSecurityStatistics: Statistics for row-level security. - `rowLevelSecurityApplied` boolean: Whether any accessed data was protected by row access policies. - `scriptStatistics` ScriptStatistics: Job statistics specific to the child job of a script. - `evaluationKind` 'EVALUATION_KIND_UNSPECIFIED' | 'STATEMENT' | 'EXPRESSION': Whether this child job was a statement or expression. - `stackFrames` ScriptStackFrame[]: Stack trace showing the line/column/procedure name of each frame on the stack at the point where the current evaluation happened. The leaf frame is first, the primary script is last. Never empty. - `endColumn` integer: Output only. One-based end column. - `endLine` integer: Output only. One-based end line. - `procedureId` string: Output only. Name of the active procedure, empty if in a top-level script. - `startColumn` integer: Output only. One-based start column. - `startLine` integer: Output only. One-based start line. - `text` string: Output only. Text of the current statement/expression. - `sessionInfo` SessionInfo: [Preview] Information related to sessions. - `sessionId` string: Output only. The id of the session. - `startTime` string, int64: Output only. Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE. - `totalBytesProcessed` string, int64: Output only. Total bytes processed for the job. - `totalSlotMs` string, int64: Output only. Slot-milliseconds for the job. - `transactionInfo` TransactionInfo: [Alpha] Information of a multi-statement transaction. - `transactionId` string: Output only. [Alpha] Id of the transaction. - `status` JobStatus - `errorResult` ErrorProto: Error details. - `debugInfo` string: Debugging information. This property is internal to Google and should not be used. - `location` string: Specifies where the error occurred, if present. - `message` string: A human-readable description of the error. - `reason` string: A short error code that summarizes the error. - `errors` ErrorProto[]: Output only. The first errors encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has not completed or was unsuccessful. - `debugInfo` string: Debugging information. This property is internal to Google and should not be used. - `location` string: Specifies where the error occurred, if present. - `message` string: A human-readable description of the error. - `reason` string: A short error code that summarizes the error. - `state` string: Output only. Running state of the job. Valid states include 'PENDING', 'RUNNING', and 'DONE'. - `user_email` string: Output only. Email address of the user who ran the job. - `kind` string: The resource type of the response. ## Changes - **2026-11-05** `33188b5cf151`: 4 info - the security scope `https://www.googleapis.com/auth/bigquery` was added to the endpoint's security scheme `Oauth2` - the security scope `https://www.googleapis.com/auth/bigquery` was added to the endpoint's security scheme `Oauth2c` - the security scope `https://www.googleapis.com/auth/cloud-platform` was removed from the endpoint's security scheme `Oauth2` - the security scope `https://www.googleapis.com/auth/cloud-platform` was removed from the endpoint's security scheme `Oauth2c` - **2026-10-29** `1c22958240fa`: 4 info - the security scope `https://www.googleapis.com/auth/bigquery` was added to the endpoint's security scheme `Oauth2` - the security scope `https://www.googleapis.com/auth/bigquery` was added to the endpoint's security scheme `Oauth2c` - the security scope `https://www.googleapis.com/auth/cloud-platform` was removed from the endpoint's security scheme `Oauth2` - the security scope `https://www.googleapis.com/auth/cloud-platform` was removed from the endpoint's security scheme `Oauth2c` [Operation history](https://skmtc.dev/google/apis/bigquery/changes/projects/:projectsId/jobs/:jobsId/cancel/post.md) --- [API](https://skmtc.dev/google/apis/bigquery.md) - [All operations](https://skmtc.dev/google/apis/bigquery/llms.txt) - [OpenAPI document](https://skmtc.dev/google/apis/bigquery/revisions/33188b5cf151?raw)